API reference

This page provides an auto-generated summary of mmspy’s API. For more details and examples, refer to the relevant chapters in the main part of the documentation.

Top-level components

load([store, variables, time_dependent, ...])	Load an MMS dataset with the data store manager.
query	Package-level instance of Query.
store	Package-level instance of Store.
units	A wrapper class used to distribute changes to the application registry.
config

Setting query parameters

api.query.Query([start_time, stop_time, ...])	Query parameters for the MMS SDC.
api.query.Query.start_time	Query start time in acceptable format for Timestamp, e.g., YYYY-MM-DD, YYYY-MM-DD/hh:mm:ss, or YYYY-MM-DDThh:mm:ss.ssssss.
api.query.Query.stop_time	Query stop time in acceptable format for Timestamp, e.g., YYYY-MM-DD, YYYY-MM-DD/hh:mm:ss, or YYYY-MM-DDThh:mm:ss.ssssss.
api.query.Query.probe	Probe name.
api.query.Query.instrument	Instrument name.
api.query.Query.data_rate	Data rate mode.
api.query.Query.data_type	Data descriptor.
api.query.Query.data_level	Data level.
api.query.Query.ancillary_product	Ancillary product (unsupported).

Managing data stores

api.store.Store([path])	Manager for all data storages based on query parameters.
api.store.Store.path
api.store.Store.zarr
api.store.Store.show([pattern])	Show the data store tree.
api.store.Store.sync(**kwargs)	Sync data store.
api.store.Store.write_dataset(dataset, ...)	Write a dataset to a data store.
api.store.Store.get_local_files(store, **kwargs)	Get files from a local store.
api.store.Store.get_time_slices(store, **kwargs)	Get time slices from each file in a data store.
api.store.Store.files(store, **kwargs)	Iterator for Store.get_local_files().
api.store.Store.time_slices(store, **kwargs)	Iterator for Store.get_time_slices().

Computation

Particle distribution processing

compute.particle.grid.ParticleGrid(name, center)	Dataclass for the support of the distribution function.
compute.particle.interpolate.interpolate_distribution(ds, ...)	Interpolate a particle distribution function onto a regular grid.
compute.particle.integrate.integrate_distribution(f)
compute.particle.integrate.reduce_distribution(ds)
compute.particle.smooth.smooth_distribution(da)	Apply a smoothing kernel on a distribution function.