API Reference

swxsoc Package

Functions

print_config()

Print current configuration options.

swxsoc.swxdata Module

Container class for Measurement Data.

Classes

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

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

swxsoc.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 SWXDeprecationWarning.
warn_user(msg[, stacklevel])	Raise a SWXUserWarning.

Classes

SWXDeprecationWarning	A warning class to indicate a deprecated feature.
SWXPendingDeprecationWarning	A warning class to indicate a soon-to-be deprecated feature.
SWXUserWarning	The primary warning class for SWxSOC.
SWXWarning	The base warning class from which all SWX warnings should inherit.

swxsoc.util.io Module

Classes

SWXIOHandler()	Abstract base class for handling input/output operations of heliophysics data.
CDFHandler()	A concrete implementation of SWXIOHandler for handling heliophysics data in CDF format.

swxsoc.util.schema Module

This module provides schema metadata derivations.

This code is based on that provided by SpacePy see

licenses/SPACEPY.rst

Classes

SWXSchema([global_schema_layers, ...])

Class representing a schema for data requirements and formatting.

swxsoc.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).

swxsoc.util.validation Module

Functions

validate(filepath)

Validate a data file such as a CDF.

Classes

SWXDataValidator()	Abstract base class for heliophysics data validators.
CDFValidator()	Validator for CDF files.