.. _installation:

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

Required dependencies
---------------------

   * Python_ 3.6 or newer

   * NumPy_ 1.13 or newer

   * SciPy_ 0.18 or newer

   * sisl_ 0.12.1 or newer

Optional:

   * Matplotlib_ 2.0.0 or newer (plotting)

.. _Python: https://www.python.org/
.. _NumPy: https://docs.scipy.org/doc/numpy/reference/
.. _SciPy: https://docs.scipy.org/doc/scipy/reference/
.. _sisl : https://zerothi.github.io/sisl
.. _Matplotlib: https://matplotlib.org/


Installation from source
------------------------

Simply download as zip or clone the project from the `git repository <https://github.com/dipc-cc/hubbard>`_.

Manual installation is performed with the command

.. code-block:: bash

   python3 -m pip install . --prefix=<prefix>

One can also use the auxiliary file `install-py3.sh`

One may also wish to set the following environment variables

.. code-block:: bash

   export PYTHONPATH=<my-python-home>/lib/python/
   export PATH=$PATH:<my-python-home>/bin/