Installation

Pip

$ pip install redback-surrogates

Supported python versions: 3.7+.

This will install all requirements for running redback_surrogates for creating models and the data required to use these models. Currently redback_surrogate is going significant development, and we can not guarantee that any pip or conda releases will be completely upto date. Therefore, for the near future, we recommend installing redback_surrogate from source, and in development mode.

Install redback_surrogates from source

redback_surrogate is developed and tested with Python 3.7+. In the following, we assume you have a working python installation, python pip, and git.

Clone the repository, install the requirements, and then install the software:

$ git clone https://github.com/nikhil-sarin/redback_surrogates
$ cd redback_surrogates/
$ pip install -r requirements.txt
$ pip install .

To install with development mode, use:

$ git clone https://github.com/nikhil-sarin/redback_surrogates
$ cd redback_surrogates/
$ pip install -r requirements.txt
$ pip install -e .

For full functionality, please also install optional requirements.

$ pip install -r optional_requirements.txt

You are now ready to use redback_surrogate. Please check out the examples

Install through redback

If you install optional requirements in redback, redback_surrogate will be installed automatically. For instructions on installing redback, please see the redback installation instructions.