Skip to content

Commit

Permalink
Update doc for pip installation
Browse files Browse the repository at this point in the history
  • Loading branch information
AnkitBarik committed Feb 21, 2024
1 parent 79af7a7 commit 9944cf6
Showing 1 changed file with 15 additions and 9 deletions.
24 changes: 15 additions & 9 deletions doc/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,14 @@ Installation

`planetMagFields` can be installed in a few different ways:

Using `PYTHONPATH`
******************
Using `pip`
***********

Download the package from the `GitHub repository <https://github.com/AnkitBarik/planetMagFields>`_ and it
to `PYTHONPATH`:
This is probably the easiest way. `planetMagFields` is available on `PyPI <https://pypi.org/project/planetMagFields/>`_ and can be installed with

.. code-block:: bash
$ git clone https://github.com/AnkitBarik/planetMagFields
$ export PYTHONPATH=$PYTHONPATH:/path/to/planetMagFields
$ python3 -m pip install planetMagFields
Using `setup.py`
*****************
Expand All @@ -31,7 +29,7 @@ You can also use `setup.py` to install `planetMagFields`:
$ git clone https://github.com/AnkitBarik/planetMagFields
$ cd planetMagFields
$ pytho3 setup.py install --user
$ python3 setup.py install --user
Or using `pip`:

Expand All @@ -41,8 +39,16 @@ Or using `pip`:
$ cd planetMagFields
$ python3 -m pip install . --user
Using `pip`
***********
Using `PYTHONPATH`
******************

Download the package from the `GitHub repository <https://github.com/AnkitBarik/planetMagFields>`_ and it
to `PYTHONPATH`:

.. code-block:: bash
$ git clone https://github.com/AnkitBarik/planetMagFields
$ export PYTHONPATH=$PYTHONPATH:/path/to/planetMagFields
Expand Down

0 comments on commit 9944cf6

Please sign in to comment.