Skip to content

Commit

Permalink
added information about dependences
Browse files Browse the repository at this point in the history
  • Loading branch information
asemposki committed Sep 5, 2024
1 parent 5184bee commit d5aeb54
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,14 @@ Prerequisites

The Trees module depends on OpenMPI. Please ensure OpenMPI is installed with shared/built libraries prior to using the Trees module.

The list of dependences is as short as possible to keep the installation process streamlined; however, if a user would like to run
the Jupyter notebooks in the associated Jupyter Book, dependences for the notebooks will need to be installed in the relevant environment.
These dependences are commented out in the Jupyter notebooks, but can be uncommented and quickly installed.

The `bilby` sampler comes with the ability to use a suite of samplers---in the case of Taweret, we also have not listed all
samplers as dependences. However, the user can (and should) download any samplers that they wish to use and `bilby` will be able
to use them through its wrapper in the Taweret package.


Windows Users
--------------
Expand Down

0 comments on commit d5aeb54

Please sign in to comment.