Skip to content

Latest commit

 

History

History
91 lines (79 loc) · 6.35 KB

index.rst

File metadata and controls

91 lines (79 loc) · 6.35 KB

Formulary (plasmapy.formulary)

plasmapy.formulary provides theoretical formulas for calculation of physical quantities helpful for plasma physics. |:abacus:|

.. toctree:: Classical Transport <braginskii>
   :maxdepth: 1
plasmapy.formulary.braginskii
.. toctree:: Collisions <collisions>
   :maxdepth: 1
plasmapy.formulary.collisions
.. toctree:: Densities <densities>
   :maxdepth: 1
plasmapy.formulary.densities
.. toctree:: Dielectrics <dielectric>
   :maxdepth: 1
plasmapy.formulary.dielectric
.. toctree:: Dimensionless <dimensionless>
   :maxdepth: 1
plasmapy.formulary.dimensionless
.. toctree:: Distribution Functions <distribution>
   :maxdepth: 1
plasmapy.formulary.distribution
.. toctree:: Drifts <drifts>
   :maxdepth: 1
plasmapy.formulary.drifts
.. toctree:: Frequencies <frequencies>
   :maxdepth: 1
plasmapy.formulary.frequencies
.. toctree:: Ionization <ionization>
   :maxdepth: 1
plasmapy.formulary.ionization
.. toctree:: Lengths <lengths>
   :maxdepth: 1
plasmapy.formulary.lengths
.. toctree:: Magnetostatics <magnetostatics>
   :maxdepth: 1
plasmapy.formulary.magnetostatics
.. toctree:: Mathematics <mathematics>
   :maxdepth: 1
plasmapy.formulary.mathematics
.. toctree:: Miscellaneous Parameters <misc>
   :maxdepth: 1
plasmapy.formulary.misc
.. toctree:: Quantum Relations <quantum>
   :maxdepth: 1
plasmapy.formulary.quantum
.. toctree:: Radiation <radiation>
   :maxdepth: 1
plasmapy.formulary.radiation
.. toctree:: Relativistic Relations <relativity>
   :maxdepth: 1
plasmapy.formulary.relativity
.. toctree:: Speeds <speeds>
   :maxdepth: 1
plasmapy.formulary.speeds

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