API reference
=============

``pyrfu`` is organised in subpackages. Each page below lists the public
functions of a subpackage, grouped by topic, with a link to the full
documentation of each function.

.. list-table::
   :widths: 25 75
   :header-rows: 0

   * - :doc:`pyrfu.pyrf <pyrf>`
     - Generic routines: time series, coordinates, filtering, wave analysis,
       multi-spacecraft methods, plasma parameters.
   * - :doc:`pyrfu.mms <mms>`
     - Magnetospheric Multiscale (MMS): data access, fields, waves, FPI
       distributions and moments, EIS, FEEPS and HPCA.
   * - :doc:`pyrfu.plot <plot>`
     - Plotting of time series, spectrograms and particle distributions.
   * - :doc:`pyrfu.models <models>`
     - Geomagnetic field, magnetopause and instability threshold models.
   * - :doc:`pyrfu.dispersion <dispersion>`
     - Plasma wave dispersion relations.
   * - :doc:`pyrfu.lp <lp>`
     - Langmuir probe modelling.
   * - :doc:`pyrfu.solo <solo>`
     - Solar Orbiter RPW data.
   * - :doc:`pyrfu.maven <maven>`
     - MAVEN data access.
   * - :doc:`pyrfu.constants <constants>`
     - Physical constants not in :mod:`scipy.constants`, such as the Earth
       radius.

.. toctree::
   :hidden:
   :maxdepth: 1

   pyrf
   mms
   plot
   models
   dispersion
   lp
   solo
   maven
   constants