Installation

Note

exoplanet requires Python 3.6 and later.

exoplanet doesn’t have a compiled components so it can be easily installed from source or by using pip.

Dependencies

The only required dependencies for exoplanet are NumPy, PyMC3 and AstroPy. These can be installed using conda or pip:

conda install numpy pymc3 astropy

or

python -m pip install -r requirements.txt

Using pip

exoplanet can also be installed using pip:

python -m pip install -U exoplanet

From Source

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

git clone https://github.com/exoplanet-dev/exoplanet.git
cd exoplanet
python setup.py install

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 -r requirements-test.txt
python -m pip install -e .

Testing

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

python -m pip install -r requirements-dev.txt

and then execute:

python -m pytest -vs src/exoplanet

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.