Installing plasmapy_sphinx

plasmapy_sphinx requires a minimum Python version of 3.8. If you do not have Python installed already, here are the instructions to download Python and install it. 🐍

Installing with pip

To install the most recent release of plasmapy_sphinx on PyPI with pip into an existing Python 3.8+ environment on macOS or Linux, open a terminal and run:

python -m pip install plasmapy

On some systems, it might be necessary to specify the Python version number by using python3, python3.8, python3.9, python3.10, or python3.11 instead of python.

To install PlasmaPy on Windows, run:

py -3.11 -m pip install plasmapy

The version of Python may be changed from 3.11 to another supported Python 3.8+ release that has been installed on your computer.

For more detailed information, please refer to this tutorial on installing packages.

Installing from source code

Obtaining official releases

A ZIP file containing the source code for official releases of plasmapy_sphinx can be obtained from PyPI.

Alternatively, official releases can be downloaded from the releases page on the Github repository.

Obtaining source code from GitHub

If you have git installed on your computer, you may clone the Github repository and access the source code from the most recent development version by running:

git clone https://github.com/PlasmaPy/plasmapy_sphinx.git

The repository will be cloned inside a new subdirectory called plasmapy_sphinx.

If you do not have git installed on your computer, then you may download the most recent source code from Github repository by going to Code and selecting Download ZIP. Unzipping the file will create a subdirectory called plasmapy_sphinx that contains the source code.

Building and installing

To install the downloaded version of plasmapy_sphinx, enter the plasmapy_sphinx directory and run:

pip install .

If you expect to occasionally edit the source code, instead run:

pip install -e .

The -e flag makes the installation editable.

Note

If you noticed any places where the installation instructions could be improved or have become out of date, please create an issue on Github repository. It would really help!