Skip to content

Commit

Permalink
adding deps to install docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dfm committed Apr 23, 2021
1 parent 880bba0 commit 624d64c
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 12 deletions.
25 changes: 13 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
<p align="center">
<img width="50" src="https://raw.githubusercontent.com/exoplanet-dev/exoplanet/main/docs/_static/logo.png">
<br><br>

<a href="https://github.com/exoplanet-dev/exoplanet/actions/workflows/tests.yml">
<img src="https://github.com/exoplanet-dev/exoplanet/actions/workflows/tests.yml/badge.svg" alt="Tests">
</a>
Expand All @@ -15,12 +14,12 @@

# exoplanet

Fast & scalable MCMC for all your exoplanet needs! *exoplanet* is a toolkit for
Fast & scalable MCMC for all your exoplanet needs! _exoplanet_ is a toolkit for
probabilistic modeling of time series data in astronomy with a focus on
observations of [exoplanets](https://en.wikipedia.org/wiki/Exoplanet), using
[PyMC3](https://docs.pymc.io). *PyMC3* is a flexible and high-performance model
[PyMC3](https://docs.pymc.io). _PyMC3_ is a flexible and high-performance model
building language and inference engine that scales well to problems with a large
number of parameters. *exoplanet* extends *PyMC3*'s language to support many of
number of parameters. _exoplanet_ extends _PyMC3_'s language to support many of
the custom functions and distributions required when fitting exoplanet datasets.

Read the full documentation at [docs.exoplanet.codes](https://docs.exoplanet.codes).
Expand All @@ -33,20 +32,22 @@ The quickest way to get started is to use [pip](https://pip.pypa.io):
python -m pip install exoplanet
```

Note that you will need Python (>=3.6) installed for this to work, but then this will
install all the required dependencies.
Note that you will need Python (>=3.6) installed for this to work, but then this
will install all the required dependencies.

Check out the [main installation documentation
page](https://docs.exoplanet.codes/en/latest/user/install/) for more options.

## Usage

Check out the tutorials and API docs on [the docs page](https://docs.exoplanet.codes)
for example usage and much more info. You can also find more in-depth examples on the
[exoplanet case studies page](https://gallery.exoplanet.codes).
Check out the tutorials and API docs on [the docs
page](https://docs.exoplanet.codes) for example usage and much more info. You
can also find more in-depth examples on the [exoplanet case studies
page](https://gallery.exoplanet.codes).

## Contributing

*exoplanet* is an open source project and we would love it if you wanted to contribute.
Check out [the developer documentation](https://docs.exoplanet.codes/en/latest/user/dev/)
for more info about getting started.
_exoplanet_ is an open source project and we would love it if you wanted to
contribute. Check out [the developer
documentation](https://docs.exoplanet.codes/en/latest/user/dev/) for more info
about getting started.
8 changes: 8 additions & 0 deletions docs/user/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,14 @@ the instructions on the relevant documentation pages:
python -m pip install -U "exoplanet[extras]"
Both of these installation methods will install the required dependencies:

- [numpy](https://numpy.org)
- [astropy](https://www.astropy.org)
- [pymc3](https://docs.pymc.io)
- [exoplanet-core](https://github.com/exoplanet-dev/exoplanet-core)
- [aesara-theano-fallback](https://github.com/exoplanet-dev/aesara-theano-fallback)


Using conda
-----------
Expand Down

0 comments on commit 624d64c

Please sign in to comment.