API Reference#

drms Package#

drms#

The drms library provides an easy-to-use interface for accessing HMI, AIA and MDI data with Python. It uses the publicly accessible JSOC DRMS server by default, but can also be used with local NetDRMS sites. More information, including a detailed tutorial, is available in the Documentation.

Functions#

register_server(config)

Register a server configuration.

to_datetime(tstr[, force])

Parse JSOC time strings.

Classes#

Client([server, email, verbose, debug])

Client for remote DRMS server access.

DrmsError

Unspecified DRMS run-time error.

DrmsExportError

DRMS data export error.

DrmsOperationNotSupported

Operation is not supported by DRMS server.

DrmsQueryError

DRMS query error.

ExportRequest(d, client)

Class for handling data export requests.

HttpJsonClient([server, debug])

HTTP/JSON communication with the DRMS server CGIs.

HttpJsonRequest(url, encoding)

Class for handling HTTP/JSON requests.

SeriesInfo(d[, name])

DRMS series details.

ServerConfig([config])

DRMS Server configuration.

UnsupportedPythonError

Running on an unsupported version of Python.

Class Inheritance Diagram#

Inheritance diagram of drms.client.Client, drms.exceptions.DrmsError, drms.exceptions.DrmsExportError, drms.exceptions.DrmsOperationNotSupported, drms.exceptions.DrmsQueryError, drms.client.ExportRequest, drms.json.HttpJsonClient, drms.json.HttpJsonRequest, drms.client.SeriesInfo, drms.config.ServerConfig, drms.UnsupportedPythonError

drms.client Module#

Classes#

SeriesInfo(d[, name])

DRMS series details.

ExportRequest(d, client)

Class for handling data export requests.

Client([server, email, verbose, debug])

Client for remote DRMS server access.

Class Inheritance Diagram#

Inheritance diagram of drms.client.SeriesInfo, drms.client.ExportRequest, drms.client.Client

drms.config Module#

Functions#

register_server(config)

Register a server configuration.

Classes#

ServerConfig([config])

DRMS Server configuration.

Class Inheritance Diagram#

Inheritance diagram of drms.config.ServerConfig

drms.exceptions Module#

Classes#

DrmsError

Unspecified DRMS run-time error.

DrmsQueryError

DRMS query error.

DrmsExportError

DRMS data export error.

DrmsOperationNotSupported

Operation is not supported by DRMS server.

Class Inheritance Diagram#

Inheritance diagram of drms.exceptions.DrmsError, drms.exceptions.DrmsQueryError, drms.exceptions.DrmsExportError, drms.exceptions.DrmsOperationNotSupported

drms.json Module#

Classes#

HttpJsonRequest(url, encoding)

Class for handling HTTP/JSON requests.

HttpJsonClient([server, debug])

HTTP/JSON communication with the DRMS server CGIs.

Class Inheritance Diagram#

Inheritance diagram of drms.json.HttpJsonRequest, drms.json.HttpJsonClient

drms.utils Module#

Functions#

to_datetime(tstr[, force])

Parse JSOC time strings.