adityaprakash-bobby / plasmapy

A community developed python package for plasma physics in the early stages of development.

PlasmaPy

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. For a slower response, you may also contact Nick Murphy at [email protected] and Drew Leonard at [email protected]. You may also sign up for PlasmaPy's email list.

Installation

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

We're not on Conda yet, but we're working on it!

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.

License

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.

Acknowledging and Citing PlasmaPy

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