Engineering Database Interface

jwst.lib.engdb_tools Module

Access the JWST Engineering Mnemonic Database

The engineering mnemonics are provided by multiple services, all of which require a level of authentication.

For non-operational use, the providing service is through the MAST AUI website

Authorization can be requested through

Interface

The primary entry point is the function jwst.lib.engdb_tools.ENGDB_Service. This function returns a jwst.lib.engdb_lib.EngdbABC connection object. Using this object, values for a mnemonic covering a specified time range can be retrieved using the get_values method.

By default, only values inclusively between the time end points are returned. Depending on the frequency a mnemonic is updated, there can be no values. If values are always desired, the nearest, bracketing values outside the time range can be requested.

Warning

Many mnemonics are updated very quickly, up to 16Hz. When in doubt, specify a very short time frame, and request bracketing values. Otherwise, the request can return a very large amount of data, risking timeout, unnecessary memory consumption, or access restrictions.

Examples

The typical workflow is as follows:

from jwst.lib.engdb_tools import ENGDB_Service

service = ENGDB_Service()  # By default, will use the public MAST service.

values = service.get_values('sa_zattest2', '2021-05-22T00:00:00', '2021-05-22T00:00:01')

Environmental Variables

ENG_BASE_URL

If no URL is specified in code or by command line parameters, this value is used. If not defined, a default, as defined by the individual services, will be attempted.

MAST_API_TOKEN

If no token is provided in code or by command line parameters, this value will be used. EngdbMast service requires a token to be provided. See https://auth.mast.stsci.edu/ for more information.

Functions

ENGDB_Service([base_url])

Access the JWST Engineering Database

jwst.lib.engdb_mast Module

Access the JWST Engineering Mnemonic Database through MAST

Classes

EngdbMast([base_url, token])

Access the JWST Engineering Database through MAST

jwst.lib.engdb_direct Module

Access the JWST Engineering Mnemonic Database through direct connection

Classes

EngdbDirect([base_url, default_format])

Access the JWST Engineering Database through direct connection

jwst.lib.engdb_lib Module

Engineering DB common library

Classes

EngDB_Value(obstime, value)

Create new instance of EngDB_Value(obstime, value)

EngdbABC([base_url])

Access the JWST Engineering Database