Getting Started
===============

Install Package
---------------
.. note:: DESPASITO is not yet available in conda-forge, but it is available with pip.


**Prerequisites:**
  * **Python**: Available for python 3.6 to 3.8 (limited by current compatibility issues with Numba)
  * `NumPy <https://numpy.org>`_: If cython is used, numpy is needed for running setup (distutils). Follow instructions outlined `here <https://docs.scipy.org/doc/numpy/user/install.html>`_ for installation.

**Option 1:** Install from pip: ``pip install despasito``

**Option 2:** Install locally with pip.

    - Step 1: Install the prerequisites listed above.
    - Step 2: Download the master branch from our github page as a zip file, or clone it with git via ``git clone https://github.com/Santiso-Group/despasito`` to your working directory.
    - Step 3: Install with ``pip install despasito/.``, or change directories and run ``pip install -e .``.

**NOTE** If `pip <https://pip.pypa.io/en/stable/>`_: is unavailable, follow the instructions outlined `here <https://pip.pypa.io/en/stable/installing/>`_: for installation.