API Reference

hermes_core Package

Functions

print_config()

Print current configuration options.

hermes_core.timedata Module

Container class for Measurement Data.

Classes

HermesData(timeseries[, support, spectra, meta])

A generic object for loading, storing, and manipulating HERMES time series data.

hermes_core.util Package

Functions

create_science_filename(instrument, time, ...)	Return a compliant filename.
parse_science_filename(filepath)	Parses a science filename into its consitutient properties (instrument, mode, test, time, level, version, descriptor).
warn_deprecated(msg[, stacklevel])	Raise a HERMESDeprecationWarning.
warn_user(msg[, stacklevel])	Raise a HERMESUserWarning.

Classes

HERMESDeprecationWarning	A warning class to indicate a deprecated feature.
HERMESPendingDeprecationWarning	A warning class to indicate a soon-to-be deprecated feature.
HERMESUserWarning	The primary warning class for HERMES.
HERMESWarning	The base warning class from which all HERMES warnings should inherit.

hermes_core.util.io Module

Classes

CDFHandler()

A concrete implementation of HermesDataIOHandler for handling heliophysics data in CDF format.

hermes_core.util.schema Module

This module provides schema metadata derivations.

This code is based on that provided by SpacePy see

licenses/SPACEPY.rst

Classes

HermesDataSchema()

Class representing the schema of a file type.

hermes_core.util.util Module

This module provides general utility functions.

Functions

create_science_filename(instrument, time, ...)	Return a compliant filename.
parse_science_filename(filepath)	Parses a science filename into its consitutient properties (instrument, mode, test, time, level, version, descriptor).

hermes_core.util.validation Module

Functions

validate(filepath)

Validate a data file such as a CDF.

Classes

CDFValidator()

Validator for CDF files.