PlasmaPy: A plasma physics Python package

Welcome to the plasmapy package, an open source community-developed Python package for the plasma community. Documentation is available in the docstrings and online at https://docs.plasmapy.org (accessible also using the online_help() function).

Sub-Packages & Modules

analysis

The analysis subpackage for PlasmaPy.

conftest

Adds custom functionality to pytest

diagnostics

The diagnostics subpackage contains functionality for defining diagnostic parameters and processing data collected by diagnostics, synthetic or experimental.

dispersion

The dispersion subpackage contains functionality associated with plasma dispersion relations, including numerical solvers and analytical solutions.

formulary

The formulary subpackage contains commonly used formulae from plasma science.

optional_deps

Useful error messages for optional dependencies that aren't found.

particles

The plasmapy.particles subpackage provides access to information about atoms, isotopes, ions, and other particles.

plasma

simulation

Module containing plasma simulation tools.

utils

Package of functions and classes used to develop clean, readable, and informative code.

Functions

online_help(query)

Open a webpage containing a search page in PlasmaPy's documentation, or another page that contains relevant online help.

Variables & Attributes

__citation__

PlasmaPy citation instructions

__version__

PlasmaPy version string