Metadata-Version: 2.4
Name: mmspy
Version: 0.2.8
Summary: A Python package for querying and analysing data from the NASA Magnetospheric Multiscale (MMS) mission.
Project-URL: Repository, https://github.com/tien-vo/mmspy
Author-email: tien-vo <tvo.work@proton.me>
License: GPL-3.0
License-File: LICENSE.md
Keywords: heliophysics,magnetospheric multiscale mission,plasma,plasma physics,science,space plasma
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.11
Requires-Dist: astropy>=7.1.0
Requires-Dist: attrs<26.0.0,>=25.3.0
Requires-Dist: bigtree>=0.29.2
Requires-Dist: bokeh>=3.1.0
Requires-Dist: bs4>=0.0.2
Requires-Dist: cdflib<2.0.0,>=1.3.4
Requires-Dist: colorcet>=3.1.0
Requires-Dist: dask[distributed]<2026.0.0,>=2025.5.1
Requires-Dist: matplotlib>=3.10.3
Requires-Dist: numcodecs==0.15.1
Requires-Dist: numpy>=2.2.6
Requires-Dist: pathos>=0.3.4
Requires-Dist: pint-xarray<0.5,>=0.4
Requires-Dist: python-benedict[toml]>=0.34.1
Requires-Dist: requests>=2.32.3
Requires-Dist: rocket-fft>=0.2.5
Requires-Dist: scipy>=1.15.3
Requires-Dist: tqdm<5.0.0,>=4.67.1
Requires-Dist: xarray<2026.0.0,>=2025.4.0
Requires-Dist: zarr==2.18.5
Description-Content-Type: text/x-rst

|made-with-python| |PyPI version| |PyPI license| |Documentation| |Zenodo|

`mmspy` is a package for querying and analysing data from the NASA
Magnetospheric Multiscale (MMS) mission.

Features
========

- Interface for LASP MMS Science Data Center (SDC) web services.
- Advanced integrator and interpolator for extended 3D particle distribution
  function.
- Implementation of multi-spacecraft data analysis methods in `xarray`.

Why another space physics software?
===================================

At the moment, there are already a couple of well-developed Python
libraries for loading space physics data, such as
`PySPEDAS <pyspedas_>`_,
`Speasy <https://speasy.readthedocs.io/en/latest/>`_, and 
`SciQLop <https://sciqlop.github.io/>`_. However, there is
a lack of Python utility for direct interactions with the RESTful API
provided by the `MMS Science Data Center (SDC)
<https://lasp.colorado.edu/mms/sdc/public/>`_. Inspired by
the Python package for CDAS web services,
`cdasws`_, this package
intends to provide access to the MMS SDC web services at LASP and fills
in that gap.

While the core functionality of `mmspy` does not differ much from that
of `PySPEDAS <pyspedas_>`_, which is to provide data from a repository to
space physics researchers, it puts focus on the broader
`Xarray ecosystem <https://xarray.dev/#ecosystem>`_ for
distributed and parallel computing with
`Dask <dask_>`_, performant I/O with
`Zarr <zarr_>`_, and automatic
unit handling with `Pint <pint_>`_. These
features aim to make the most out of metadata provided in CDF files
and make analysis of MMS data more intuitive, efficient, and scalable.

Documentation
=============
Learn more about `mmspy` at `https://mmspy.readthedocs.io`.

License
=======
This project is licensed under the terms of the GNU General Public License v3.0.

.. _pyspedas: https://pyspedas.readthedocs.io/en/latest/
.. _dask: https://docs.dask.org/en/stable/
.. _zarr: https://zarr.readthedocs.io/en/stable/
.. _pint: https://pint.readthedocs.io/en/stable/
.. _cdasws: https://cdaweb.gsfc.nasa.gov/WebServices/REST/

.. |made-with-python| image:: https://img.shields.io/badge/Made%20with-Python-1f425f.svg
   :target: https://www.python.org/

.. |PyPI version| image:: https://img.shields.io/pypi/v/mmspy.svg?logo=pypi
   :target: https://pypi.python.org/pypi/mmspy/

.. |PyPI license| image:: https://img.shields.io/pypi/l/mmspy
   :target: https://pypi.python.org/pypi/mmspy/

.. |PyPI status| image:: https://img.shields.io/pypi/status/mmspy.svg
   :target: https://pypi.python.org/pypi/mmspy/

.. |Documentation| image:: https://readthedocs.org/projects/mmspy/badge/?version=latest
   :target: https://mmspy.readthedocs.io/en/latest/

.. |Zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.15717493.svg
   :target: https://doi.org/10.5281/zenodo.15717492
