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

The ``qha-cij`` code is developed for Python 3 (3.6+), and it is recommened to
be installed with ``pip`` package manager to ensure its dependencies and 
command-line aliases properly installed.

From PyPI (Python package index)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The code can be installed with the following command from PyPI

.. code-block:: bash

    $ pip install cij

From Source
^^^^^^^^^^^

The package is currently hosted on GitHub. To install the latest version, you
will first need to clone this repository from GitHub with ``git`` and enter its
directory

.. code-block:: bash

    $ git clone https://github.com/MineralsCloud/qha-cij.git
    $ cd qha-cij

Then, install with ``pip``

.. code-block:: bash

    $ pip install -U .

or to install in development mode use

.. code-block:: bash

    $ pip install -Ue .