If you would like to contribute to PlasmaPy, please refer to the instructions on installing PlasmaPy for development.
PlasmaPy requires Python version 3.6 or newer. PlasmaPy requires the following packages for installation:
PlasmaPy also depends on the following packages for optional features:
Installation with conda¶
We highly recommend installing PlasmaPy from a Python environment created using Conda. Conda allows us to create and switch between Python environments that are isolated from each other and the system installation (in contrast to this xkcd).
After installing conda, create a PlasmaPy environment by running:
conda create -n env_name python=3.8 plasmapy -c conda-forge
env_name is replaced by the name of the environment.
To activate this environment, run:
conda activate env_name
pip install plasmapy[all]
PlasmaPy may be installed with the required but not the optional dependencies
with the following command, though this may result in an
using certain specialized functionality.
pip install plasmapy
Building and installing from source code¶
Obtaining source code¶
Development version on GitHub¶
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 selecting “Clone or Download”, which will give you the option to download a zip file.
Cloning a repository with HTTPS as above is recommended, but you may also clone a repository using SSH as a more secure alternative.
The How to Contribute guide has instructions on how to fork a repository and create branches so that you may make pull requests.
Building and installing¶
PlasmaPy directory, run
python setup.py install
pip install .