.. highlight:: shell

============
Installation
============


Stable release
--------------

To install Pyrfu, run this command in your terminal:

.. code-block:: console

    $ python -m pip install pyrfu
    # or
    $ python -m pip install --user pyrfu

This is the preferred method to install Pyrfu, as it will always install the most
recent stable release.

If you don't have `pip`_ installed, this `Python installation guide`_ can guide
you through the process.

.. _pip: https://pip.pypa.io
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/


From sources
------------

The sources for Pyrfu can be downloaded from the `Github repo`_.

You can either clone the public repository:

.. code-block:: console

    $ git clone git://github.com/louis-richard/irfu-python

Once you have a copy of the source, you can install it with:

.. code-block:: console

    $ python -m pip install .


.. _Github repo: https://github.com/louis-richard/irfu-python