.. planetMagFields documentation master file, created by
   sphinx-quickstart on Mon Jan 22 08:32:05 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. _secInstall:

#########################
Installation
#########################

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

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

This is probably the easiest way. `planetMagFields` is available on `PyPI <https://pypi.org/project/planetMagFields/>`_ and can be installed with

.. code-block:: bash

   $ python3 -m pip install planetMagFields

Using `setup.py`
*****************

You can also use `setup.py` to install `planetMagFields`:

.. code-block:: bash

   $ git clone https://github.com/AnkitBarik/planetMagFields
   $ cd planetMagFields
   $ python3 setup.py install --user

Or using `pip`:

.. code-block:: bash

   $ git clone https://github.com/AnkitBarik/planetMagFields
   $ cd planetMagFields
   $ python3 -m pip install . --user

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



.. Indices and tables
.. ==================

.. * :ref:`genindex`
.. * :ref:`modindex`
.. * :ref:`search`