Installation

BISIP is compatible with Python 3.6+.

Requirements

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

• numpy
• cython
• matplotlib
• emcee

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

• tqdm
• corner

Package managers

TODO: Add BISIP to conda-forge.

From source

BISIP is developed on GitHub. Clone the repository to your computer. Then navigate to the bisip directory. Finally run the setup.py script with Python.

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

Testing

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

# Last tested on Python 3.7.3 (default, Mar 27 2019, 16:54:48)
import bisip
bisip.run_test()

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:

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