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

User installation:
------------------
``MacroDensity`` can be installed using ``pip``:

.. code:: bash

  pip install macrodensity

.. Alternatively if needed, it can also be installed from ``conda`` with:

.. .. code:: bash

..   conda install macrodensity

Developer installation
----------------------

For development of ``MacroDensity``, you can install a copy of the package from the source directory:

.. code:: bash

    git clone https://github.com/WMD-group/MacroDensity.git
    cd MacroDensity
    pip install -e .


Requirements
------------
To use ``MacroDensity`` you will need the following Python packages:

- `Matplotlib <https://matplotlib.org/>`_
- `Pandas <https://pandas.pydata.org/>`_
- `Ase <https://wiki.fysik.dtu.dk/ase/>`_
- `Spglib <https://spglib.readthedocs.io/en/latest/>`_