The goal of the PlasmaPy Project is to foster the creation of an open source Python ecosystem for plasma research and education. The PlasmaPy package contains core functionality for this software ecosystem, while affiliated packages will contain more specialized functionality.

Install PlasmaPy

PlasmaPy may be installed from the command line using pip:

pip install plasmapy

Note: If you run into difficulty using pip, you may also try using pip3 or python -m pip or python3 -m pip as the command.

If you have a working installation of conda, then you may install PlasmaPy with:

conda install -c conda-forge plasmapy

PlasmaPy's documentation contains more detailed installation instructions. If you are unfamiliar with Python, please check out the Python website.

Learn PlasmaPy

PlasmaPy's documentation describes how to use PlasmaPy and includes a gallery of example notebooks.

Get Help

The quickest way to reach PlasmaPy users and developers is in PlasmaPy's Element chat room. The GitHub Discussions page is an ideal place for longer discussions on more detailed topics.

Contribute and Report Bugs

There are many ways to contribute to an open source project, including making feature requests, submitting bug reports, and organizing events. PlasmaPy's contributor guide covers getting ready to contribute, the code contribution workflow, coding guidelines, writing tests, and writing documentation.

Acknowledgments

Ongoing development of PlasmaPy is supported by the U.S. National Science Foundation, with many contributions from the broader plasma physics and open source communities. Past development of PlasmaPy has been supported by the U.S. Department of Energy, the Smithsonian Institution, NASA, and Google Summer of Code.