From d5aeb54ab264a9ab0c98d3e9df0bdd9f74360da5 Mon Sep 17 00:00:00 2001 From: Alexandra Semposki Date: Wed, 4 Sep 2024 21:36:39 -0400 Subject: [PATCH] added information about dependences --- docs/source/installation.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/source/installation.rst b/docs/source/installation.rst index 7182c0e0..88726262 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -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 --------------