.. -- mode: rst --
.. start-marker-intro-do-not-remove
.. |License| image:: https://img.shields.io/pypi/l/pyrfu .. _License: https://opensource.org/licenses/MIT
.. |Python| image:: https://img.shields.io/pypi/pyversions/pyrfu.svg?logo=python .. _Python: https://pypi.org/project/pyrfu/
.. |PyPi| image:: https://img.shields.io/pypi/v/pyrfu.svg?logo=pypi .. _PyPi: https://pypi.org/project/pyrfu/
.. |Format| image:: https://img.shields.io/pypi/format/pyrfu?color=blue&logo=pypi .. _Format: https://pypi.org/project/pyrfu/
.. |Wheel| image:: https://img.shields.io/pypi/wheel/pyrfu?logo=pypi&color=blue .. _Wheel: https://pypi.org/project/pyrfu/
.. |Status| image:: https://img.shields.io/pypi/status/pyrfu?logo=pypi&color=blue .. _Status: https://pypi.org/project/pyrfu/
.. |Downloads| image:: https://img.shields.io/pypi/dm/pyrfu?logo=pypi&color=blue .. _Downloads: https://pypi.org/project/pyrfu/
.. |CI| image:: https://github.com/louis-richard/irfu-python/actions/workflows/tests.yml/badge.svg .. _CI: https://github.com/louis-richard/irfu-python/actions/workflows/tests.yml
.. |PyLintB| image:: https://github.com/louis-richard/irfu-python/actions/workflows/pylint.yml/badge.svg .. _PyLintB: https://github.com/louis-richard/irfu-python/actions/workflows/pylint.yml
.. |CodeQL| image:: https://github.com/louis-richard/irfu-python/actions/workflows/codeql.yml/badge.svg .. _CodeQL: https://github.com/louis-richard/irfu-python/actions/workflows/codeql.yml
.. |CodeCov| image:: https://codecov.io/gh/louis-richard/irfu-python/coverage.svg?branch=main .. _CodeCov: https://codecov.io/gh/louis-richard/irfu-python/branch/main
.. |Issues| image:: https://img.shields.io/github/issues/louis-richard/irfu-python?logo=github&color=9cf .. _Issues: https://github.com/louis-richard/irfu-python/issues
.. |Commits| image:: https://img.shields.io/github/last-commit/louis-richard/irfu-python?logo=github&color=9cf .. _Commits: https://github.com/louis-richard/irfu-python/commits/master
.. |Readthedocs| image:: https://img.shields.io/readthedocs/pyrfu?logo=read-the-docs&color=blueviolet .. _Readthedocs: https://pyrfu.readthedocs.io/en/latest/
.. |Matrix| image:: https://matrix.to/img/matrix-badge.svg .. _Matrix: https://matrix.to/#/#pyrfu:matrix.org
.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg .. _Black: https://github.com/psf/black
.. |Doi| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.10678695.svg .. _Doi: https://doi.org/10.5281/zenodo.10678695
|License| |Python| |PyPi| |Format| |Wheel| |Status| |Downloads| |CI| |PyLintB| |CodeQL| |CodeCov| |Issues| |Commits| |Readthedocs| |Matrix| |Black| |Doi|_
The Python package pyrfu is a software based on the IRFU-MATLAB library to work with space data, particularly the Magnetospheric MultiScale (MMS) mission.
It is distributed under the open-source MIT license.
Installing pyrfu with pip (more details here <https://pyrfu.readthedocs.io/en/latest/installation.html>_):
.. code-block:: console
$ python -m pip install pyrfu
# or
$ python -m pip install --user pyrfuImport pyrfu.mms <https://pyrfu.readthedocs.io/en/latest/dev/pyrfu.mms.html>_ package with routines specific to work with the
Magnetospheric Multiscale mission (MMS)
.. code:: python
from pyrfu import mmsSetup path to MMS data
.. code:: python
mms.db_init("/Volumes/mms")Load magnetic field and ion bulk velocity data
.. code:: python
tint = ["2019-09-14T07:54:00.000", "2019-09-14T08:11:00.000"]
b_gsm = mms.get_data("b_gsm_fgm_srvy_l2", tint, 1)
v_gse_i = mms.get_data("vi_gse_fpi_fast_l2", tint, 1)Import pyrfu.pyrf <https://pyrfu.readthedocs.io/en/latest/dev/pyrfu.pyrf.html>_ package with generic routines
.. code:: python
from pyrfu import pyrfTransform ion bulk velocity to geocentric solar magnetospheric (GSM) coordinates
.. code:: python
v_gsm_i = pyrf.cotrans(v_gse_i, "gse>gsm")Import pyrfu.plot <https://pyrfu.readthedocs.io/en/latest/dev/pyrfu.plot.html>_ package with plotting routines
.. code:: python
from pyrfu import plotPlot time series of magnetic field and ion bulk velocity
.. code:: python
import matplotlib.pyplot as plt
f, axs = plt.subplots(2, sharex="all")
plot.plot_line(axs[0], b_gsm)
axs[0].set_ylabel("$B~[\\mathrm{nT}]$")
axs[0].legend(["$B_{x}$", "$B_{y}$", "$B_{z}$"], ncol=4)
plot.plot_line(axs[1], v_gsm_i)
axs[1].set_ylabel("$V_i~[\\mathrm{km}~\\mathrm{s}^{-1}]$")
axs[1].legend(["$V_{ix}$", "$V_{iy}$", "$V_{iz}$"], ncol=4).. end-marker-intro-do-not-remove
Full documentation can be found on pyrfu.readthedocs.io <https://pyrfu.readthedocs.io/en/latest/index.html>_
A list of examples is available here <https://pyrfu.readthedocs.io/en/latest/examples/index.html>_
This software was developed by Louis RICHARD (louisr@irfu.se) based on the IRFU-MATLAB library.
Please use the following to acknowledge use of pyrfu in your publications: Data analysis was performed using the pyrfu analysis package available at https://github.com/louis-richard/irfu-python
MMS Science Data Center: https://lasp.colorado.edu/mms/sdc/public/
MMS Datasets: https://lasp.colorado.edu/mms/sdc/public/datasets/
MMS - Goddard Space Flight Center: http://mms.gsfc.nasa.gov/