Skip to content

INSTALL.md

Latest commit

 

History

History
46 lines (35 loc) · 1.37 KB

INSTALL.md

File metadata and controls

46 lines (35 loc) · 1.37 KB

Installation

There are multiple options to download the source code for PlasmaPy. The simplest is to select "Clone or Download" on our repository page. This will provide an option to download a zip file plus information on how to clone the repository. If you have git installed on your computer and you would like to use HTTPS (which is the default and easier to set up), then run:

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

If you have set up an SSH key, an equivalent and more secure command is:

git clone git@github.com:PlasmaPy/PlasmaPy.git

The contributing to PlasmaPy guide has instructions on how to fork a repository so that you may make pull requests.

In the top level directory, run

pip install .

or

python setup.py install

We are officially on PyPI

  • PlasmaPy can be installed via
pip install plasmapy

Though be warned that the version on PyPI is our distribution version and not suitable for development. If you wish to contribute to the project, please install from GitHub.

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