Installation

Note

Since celerite is actively under development right now, the best way to install it is following From Source below.

Using conda

Note

This method doesn’t work yet but when it does, it’ll be the best!

The recommended method of installing celerite is using conda with the following command:

conda install -c conda-forge celerite

Using pip

celerite can also be install using pip after installing Eigen:

pip install celerite

If the Eigen headers can’t be found, you can hint the include directory as follows:

pip install celerite \
    --global-option=build_ext \
    --global-option=-I/path/to/eigen3

From Source

The source code for celerite can be downloaded from GitHub by running

git clone https://github.com/dfm/celerite.git

Dependencies

For the Python interface, you’ll (obviously) need a Python installation and I recommend conda if you don’t already have your own opinions.

After installing Python, the following dependencies are required to build celerite:

  1. Eigen is required for matrix computations,
  2. NumPy for math and linear algebra in Python, and
  3. pybind11 for the Python–C++ interface.

If you’re using conda, you can install all of the dependencies with the following command:

conda install -c conda-forge eigen numpy pybind11

Building

After installing the dependencies, you can build the celerite module by running:

python setup.py install

in the root directory of the source tree. If the Eigen headers can’t be found, you can hint the include directory as follows:

python setup.py build_ext -I/path/to/eigen3 install

Testing

To run the unit tests, install pytest and then execute:

py.test -v

All of the tests should (of course) pass. If any of the tests don’t pass and if you can’t sort out why, open an issue on GitHub.