If you would like to contribute to PlasmaPy, please refer to the instructions on installing PlasmaPy for development.
New versions of Python are released annually in October, and it can
take a few months for the scientific Python ecosystem to catch up. If
you have trouble installing
plasmapy on the most recent Python
version between October and ∼December, then try installing it on the
second most recent version.
python -m pip install plasmapy
On some systems, it might be necessary to specify the Python version
number by using
python3.10 instead of
To install PlasmaPy on Windows, run:
py -3.10 -m pip install plasmapy
The version of Python may be changed from
3.10 to another supported
Python 3.9+ release that has been installed on your computer.
For more detailed information, please refer to this tutorial on installing packages.
Conda is a package management system and environment manager that is commonly used in the scientific Python ecosystem. Conda lets us create and switch between Python environments that are isolated from each other and the system installation. Conda can also be used for packages written in languages other than Python.
conda install -c conda-forge plasmapy
To create a new environment with
plasmapy installed in it, run:
conda create -n env_name -c conda-forge plasmapy
env_name is replaced by the name of the environment.
This step may take several minutes. To activate this environment, run:
conda activate env_name
conda update plasmapy
git clone https://github.com/PlasmaPy/PlasmaPy.git
The repository will be cloned inside a new subdirectory called
If you do not have git installed on your computer, then you may download
the most recent source code from PlasmaPy’s GitHub repository by
going to Code and selecting Download ZIP.
Unzipping the file will
create a subdirectory called
PlasmaPy that contains the source
To install the downloaded version of
plasmapy, enter the
PlasmaPy directory and run:
pip install .
If you expect to occasionally edit the source code, instead run:
pip install -e ".[tests,docs]"
-e flag makes the installation editable and
specifies that all of the additional dependencies used while testing
the package should also be installed.
The How to Contribute guide has instructions on how to fork a repository and create branches so that you may make contributions via pull requests.