Installation

Conda

$ conda install -c conda-forge gwpopulation

Pip

$ pip install gwpopulation

Latest

If you want to use the latest (unreleased) version of gwpopulation you can install the current main branch directly from GitHub.

$ pip install git+https://github.com/ColmTalbot/gwpopulation.git@main

Warning

While GWPopulation has an extensive unit test suite, main is more likely to contain bugs than released versions, especially when using GPUs.

Development

A development version of gwpopulation can be installed from the source code in the usual way. Assuming a working python installation exists, this can be done by cloning the gwpopulation repository and installing using pip.

$ git clone git@github.com:ColmTalbot/gwpopulation.git
$ cd gwpopulation/
$ pip install -e .

Note

Installing with -e will produce an editable installation. Additional backends can also be specified via editable installations using pip install -e .[jax].

Supported python versions: 3.10-3.13. This will install gwpopulation and all required dependencies (e.g., bilby) if they are not already available in your system.

Additional backends

The main power of gwpopulation is the ability to use non-numpy backends for array operations. If installing using pip (in any method), the optional requirements for specify backends can be installed by specifying, e.g.,

$ pip install gwpopulation[jax]