Installation instructions¶
bilby_lisa can be installed through a variety of methods, see below.
Independent of the method chosen, we recommend installing bilby_lisa within
a conda environment. For speed, we recommend creating an environment with
mamba. bilby_lisa can be
installed with,
$ mamba env create --name bilby-lisa --file environment.yml
where environment.yml can be downloaded
here.
Warning
As part of this installation, non-released versions of bilby,
bilby_pipe and parallel_bilby were installed. This is
because we are waiting for required code to be merged into the main
bilby, bilby_pipe and parallel_bilby code bases. Please
see the following merge requests for details:
The non-released versions of bilby, bilby_pipe and
parallel_bilby are rebased onto the following tags:
If installing with pip, an enviroment must first be created. An
environment with all required dependencies can be created with mamba
by running,
$ 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.
bilby_lisa can then be installed with,
$ python -m pip install bilby_lisa[parallel]
Once bilby_lisa has been installed, non-released versions of
bilby, bilby_pipe and parallel_bilby need to be installed.
This is because we are waiting for required code to be merged into the
main bilby, bilby_pipe and parallel_bilby code bases.
Please see the following merge requests for details:
The required non-released versions of bilby, bilby_pipe and
parallel_bilby can be installed with:
$ python -m pip install --force-reinstall "git+https://git.ligo.org/charlie.hoy/bilby.git@ifo_plugin" "git+https://git.ligo.org/charlie.hoy/bilby_pipe.git@input_plus_det_plugin" "git+https://git.ligo.org/charlie.hoy/parallel_bilby.git@input_plus_parser"
Finally, the bbhx package used for waveform generation can be installed with,
$ python -m pip install "git+https://github.com/mikekatz04/BBHx.git"
The non-released versions of bilby, bilby_pipe and
parallel_bilby are rebased onto the following tags:
If installing from source, an enviroment must first be created. An
environment with all required dependencies can be created with mamba
by running,
$ 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.
bilby_lisa can then be installed with,
$ git clone git@github.com:hoyc1/bilby_lisa.git
$ cd bilby_lisa
$ python -m pip install .[parallel]
Once bilby_lisa has been installed, non-released versions of
bilby, bilby_pipe and parallel_bilby need to be installed.
This is because we are waiting for required code to be merged into the
main bilby, bilby_pipe and parallel_bilby code bases.
Please see the following merge requests for details:
The required non-released versions of bilby, bilby_pipe and
parallel_bilby can be installed with:
$ python -m pip install -r requirements.txt --force-reinstall
Finally, the bbhx package used for waveform generation can be installed with,
$ git clone https://github.com/mikekatz04/BBHx.git
$ cd BBHx
$ python setup.py install
The non-released versions of bilby, bilby_pipe and
parallel_bilby are rebased onto the following tags: