diff --git a/docs/conf.py b/docs/conf.py index b01dcdf294366a1212fe9202e499f132a691550b..f18aa8a6bfe2c22b076ceb6f5c05e53a6bd4e350 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -31,7 +31,8 @@ sys.path.insert(0, os.path.abspath('../bilby/')) # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = ['sphinx.ext.autodoc', 'sphinx.ext.mathjax', 'numpydoc', - 'nbsphinx', 'sphinx.ext.autosummary', 'sphinx.ext.autosectionlabel'] + 'nbsphinx', 'sphinx.ext.autosummary', + 'sphinx.ext.autosectionlabel', 'sphinx_tabs.tabs'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] diff --git a/docs/installation.txt b/docs/installation.txt index decf37ed3838472591e3313535c2ab433eea4047..dd1c9bd2a44465d524d4a07c12d3bc9595e1a0d9 100644 --- a/docs/installation.txt +++ b/docs/installation.txt @@ -2,23 +2,51 @@ Installation ============ -The lastest stable release of Bilby can be `pip-installed -<https://pypi.org/project/BILBY/>`_ from +.. tabs:: -.. code-block:: console + .. tab:: Pip + + .. code-block:: console + + $ pip install bilby + + Supported python versions: 2.7, 3.5+. + + .. tab:: Conda + + .. code-block:: console + + $ conda install -c conda-forge bilby + + Supported python versions: 2.7, 3.5+. + +This will install all requirements for running :code:`bilby` for general +inference problems, including our default sampler `dynesty +<https://dynesty.readthedocs.io/en/latest/>`_. Other samplers will need to be +installed via pip or the appropriate means. + +To install the requirements for running :code:`bilby.gw` for gravitational +wave inference, please additionally run the following commands. + +.. tabs:: + + .. tab:: Pip + + .. code-block:: console + + $ pip install gwpy lalsuite + + .. tab:: Conda + + .. code-block:: console - $ pip install bilby + $ conda install -c conda-forge gwpy python-lalsimulation -This will install our default sampler `dynesty -<https://dynesty.readthedocs.io/en/latest/>`_, other samplers will need to be -installed via pip or the appropriate means. If you plan to contribute to the -development, or simply would like the latest code, see the instructions below -for installing from source. Install bilby from source ------------------------- -:code:`bilby` is developed and tested with both Python 2.7+ and Python 3+. In the +:code:`bilby` is developed and tested with both Python 2.7+ and Python 3.7+. In the following, we assume you have a working python installation, `python pip <https://packaging.python.org/tutorials/installing-packages/#use-pip-for-installing)>`_, and `git <https://git-scm.com/>`_. See :ref:`installing-python` for our