.. _formulary:
********************************
Formulary (`plasmapy.formulary`)
********************************
`plasmapy.formulary` provides theoretical formulas for calculation of
physical quantities helpful for plasma physics. |:abacus:|
.. table::
:widths: 5 16
+--------------------------------------------------------+-----------------------------------------+
| .. toctree:: Classical Transport | `plasmapy.formulary.braginskii` |
| :maxdepth: 1 | |
+--------------------------------------------------------+-----------------------------------------+
| .. toctree:: Collisions | `plasmapy.formulary.collisions` |
| :maxdepth: 1 | |
+--------------------------------------------------------+-----------------------------------------+
| .. toctree:: Densities | `plasmapy.formulary.densities` |
| :maxdepth: 1 | |
+--------------------------------------------------------+-----------------------------------------+
| .. toctree:: Dielectrics | `plasmapy.formulary.dielectric` |
| :maxdepth: 1 | |
+--------------------------------------------------------+-----------------------------------------+
| .. toctree:: Dimensionless | `plasmapy.formulary.dimensionless` |
| :maxdepth: 1 | |
+--------------------------------------------------------+-----------------------------------------+
| .. toctree:: Distribution Functions | `plasmapy.formulary.distribution` |
| :maxdepth: 1 | |
+--------------------------------------------------------+-----------------------------------------+
| .. toctree:: Drifts | `plasmapy.formulary.drifts` |
| :maxdepth: 1 | |
+--------------------------------------------------------+-----------------------------------------+
| .. toctree:: Frequencies | `plasmapy.formulary.frequencies` |
| :maxdepth: 1 | |
+--------------------------------------------------------+-----------------------------------------+
| .. toctree:: Ionization | `plasmapy.formulary.ionization` |
| :maxdepth: 1 | |
+--------------------------------------------------------+-----------------------------------------+
| .. toctree:: Laser | `plasmapy.formulary.laser` |
| :maxdepth: 1 | |
+--------------------------------------------------------+-----------------------------------------+
| .. toctree:: Lengths | `plasmapy.formulary.lengths` |
| :maxdepth: 1 | |
+--------------------------------------------------------+-----------------------------------------+
| .. toctree:: Magnetostatics | `plasmapy.formulary.magnetostatics` |
| :maxdepth: 1 | |
+--------------------------------------------------------+-----------------------------------------+
| .. toctree:: Mathematics | `plasmapy.formulary.mathematics` |
| :maxdepth: 1 | |
+--------------------------------------------------------+-----------------------------------------+
| .. toctree:: Miscellaneous Parameters | `plasmapy.formulary.misc` |
| :maxdepth: 1 | |
+--------------------------------------------------------+-----------------------------------------+
| .. toctree:: Quantum Relations | `plasmapy.formulary.quantum` |
| :maxdepth: 1 | |
+--------------------------------------------------------+-----------------------------------------+
| .. toctree:: Radiation | `plasmapy.formulary.radiation` |
| :maxdepth: 1 | |
+--------------------------------------------------------+-----------------------------------------+
| .. toctree:: Relativistic Relations | `plasmapy.formulary.relativity` |
| :maxdepth: 1 | |
+--------------------------------------------------------+-----------------------------------------+
| .. toctree:: Speeds | `plasmapy.formulary.speeds` |
| :maxdepth: 1 | |
+--------------------------------------------------------+-----------------------------------------+
The subpackage makes heavy use of |Quantity| for handling conversions
between different unit systems. This is especially important for
electron-volts, commonly used in plasma physics to denote temperature,
although it is technically a unit of energy.
Most functions expect |Quantity| objects as inputs, however some will
use the `~plasmapy.utils.decorators.validators.validate_quantities`
decorator to automatically cast arguments to |Quantity| objects with the
appropriate units. If that happens, you will be notified via a
`astropy.units.UnitsWarning`.
Please note that well-maintained physical constant data with units and
uncertainties can be found in `astropy.constants`.
Example notebooks
-----------------
.. nbgallery::
:glob:
../notebooks/formulary/*
API
===
.. automodapi:: plasmapy.formulary