Skip to content

Commit

Permalink
update installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
hoyc1 committed Mar 5, 2024
1 parent 096f6f3 commit efbc0e2
Showing 1 changed file with 37 additions and 10 deletions.
47 changes: 37 additions & 10 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,14 @@ Installation instructions
=========================

``bilby_lisa`` can be installed through a variety of methods, see below.
However, we always recommend installing ``bilby_lisa`` within a conda
environment. For speed, we recommend creating an environment with
`mamba <https://mamba.readthedocs.io/en/latest/>`_. An environment with all
required dependencies can be installed with,
Independent of the method chosen, we recommend installing ``bilby_lisa`` within
a conda environment. For speed, we recommend creating an environment with
`mamba <https://mamba.readthedocs.io/en/latest/>`_. An environment can be
created with,

.. code-block:: console
$ mamba create --name bilby-lisa python=3.10 numpy schwimmbad gcc_linux-64 gxx_linux-64 gsl lapack=3.6.1 Cython
.. note::

If on MACOSX, substitue ``gcc_linux-64`` and ``gxx_linux-64`` with
``clang_osx-64`` and ``clangxx_osx-64``.
$ mamba create --name bilby-lisa python=3.10
``bilby_lisa`` can then be installed with,

Expand All @@ -28,12 +23,44 @@ required dependencies can be installed with,
.. tab:: PyPI

If installing with ``pip``, additional dependencies need to be
installed for compatibility with
`bbhx <https://github.com/mikekatz04/BBHx>`_. The additional
dependencies can be installed with,

.. code-block:: console
$ mamba install numpy schwimmbad gcc_linux-64 gxx_linux-64 gsl lapack=3.6.1 Cython
.. note::

If on MACOSX, substitue ``gcc_linux-64`` and ``gxx_linux-64`` with
``clang_osx-64`` and ``clangxx_osx-64``.

``bilby_lisa`` can then be installed with,

.. code-block::
$ python -m pip install bilby_lisa
.. tab:: From source

If installing from source, additional dependencies need to be
installed for compatibility with
`bbhx <https://github.com/mikekatz04/BBHx>`_. The additional
dependencies can be installed with,

.. code-block:: console
$ mamba install numpy schwimmbad gcc_linux-64 gxx_linux-64 gsl lapack=3.6.1 Cython
.. note::

If on MACOSX, substitue ``gcc_linux-64`` and ``gxx_linux-64`` with
``clang_osx-64`` and ``clangxx_osx-64``.

``bilby_lisa`` can then be installed with,

.. code-block::
$ git clone [email protected]:hoyc1/bilby_lisa.git
Expand Down

0 comments on commit efbc0e2

Please sign in to comment.