Installation

Note

exoplanet requires Python 3.6 and later.

Using pip

exoplanet can also be installed using pip:

python -m pip install -U exoplanet

Using conda

exoplanet can be installed using conda from conda-forge:

conda install -c conda-forge exoplanet

From Source

The source code for exoplanet can be downloaded and installed from GitHub by running

git clone --recursive https://github.com/exoplanet-dev/exoplanet.git
cd exoplanet
python -m pip install -e .

Note: if you clone the repo without the --recursive flag, you will need to run

git submodule init
git submodule update

Notes about running on Windows

Running exoplanet on Windows can be a little tricky because of the dependence on Theano and runtime compilation, but it is currently tested on Windows with Python 3.7 and 3.8. The following (based on the tips from the Theano docs) seem to work:

conda create --name exoplanetTest python=3.8 pip
conda install --name exoplanetTest numpy scipy mkl-service libpython m2w64-toolchain astropy matplotlib theano
conda install --name exoplanetTest -c conda-forge pybind11 celerite
python -m pip install -e .[test]

Testing

To run the unit tests, install the development dependencies using pip:

python -m pip install .[test]

and then execute:

python -m pytest -v tests

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.