PlasmaPy is an open source community developed Python 3.6+ package for plasma physics in the early stages of development. PlasmaPy intends to be for plasmas what Astropy is for astronomy - a collection of functionality commonly used and shared between plasma physicists and researchers globally, running within and leveraging the open source scientific Python ecosystem. The goals of this project are more thoroughly described in our vision statement and this recent reference. We are in the process of writing online documentation.

We created a guide on contributing to PlasmaPy and have a Code of Conduct. New contributors are very welcome!

If you have any questions, the quickest way to get a response is to ask on our Matrix/Gitter channel.

We also have a mailing list that serves as a less volatile discussion forum.

We have a suggestion box if you would like to (optionally anonymously) suggest a feature/topic for consideration. These will be reposted on the mailing list or directly in GitHub issues, as appropriate, for further discussion.

We also have approximately bi-weekly online meetings at Jitsi, for which we have a calendar here and written meeting notes here. Come discuss plasma software with us!

You can get PlasmaPy from pip via pip install plasmapy. To contribute to the package, check out our instructions on installing PlasmaPy from source.

You can also get PlasmaPy from conda via conda install -c conda-forge plasmapy.

Like most scientific Python packages, PlasmaPy probably runs best on the Anaconda distribution.

PlasmaPy requires Python 3.6+ and is not compatible with Python 2.

PlasmaPy is licensed under a 3-clause BSD license with added protections against software patents - see the LICENSE.md file in the top-level directory.

Please see the CITATION.rst file for instructions on how to cite PlasmaPy.