.. _install:

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

BISIP is compatible with Python 3.6+.

Requirements
----------------

The following packages are required and should be installed automatically on setup:

- `numpy <https://numpy.org/>`_
- `cython <https://cython.org/>`_
- `matplotlib <https://matplotlib.org/>`_
- `emcee <https://emcee.readthedocs.io/en/stable/>`_

These optional packages are used for progress bars and corner plots:

- `tqdm <https://tqdm.github.io/>`_
- `corner <https://corner.readthedocs.io/en/latest/>`_

Package managers
----------------

TODO: Add BISIP to conda-forge.

From source
-----------

BISIP is developed on `GitHub <https://github.com/clberube/bisip>`_.
Clone the repository to your computer.
Then navigate to the bisip directory.
Finally run the setup.py script with Python.

.. code-block:: bash

  git clone https://github.com/clberube/bisip
  cd bisip
  python setup.py install -f

Testing
-----------

To test if everything was installed correctly, do the following:

.. code-block:: python

  # Last tested on Python 3.8.3 (default, May 19 2020, 13:54:14)
  import bisip
  bisip.test_run()

If everything is OK the code will load a data file and perform inversion of a
data file using various models. Then it will print the best parameters and
plot traces and fit quality for the last model used. At the end, you should
see the following line:

.. code-block:: text

    All tests passed. Press ctrl+C or close figure windows to exit.