Skip to content

MaxMelching/gw-signal-tools

Repository files navigation

pipeline status coverage report Latest Release License Python 3.11+ Documentation

gw-signal-tools

Description

Repository with tools centered around computations with gravitational waveforms as generated, e.g., from the LAL waveforms interface gwsignal. This includes the commonly used noise-weighted inner product, an optimization routine for said inner product, and most notable an implementation of Fisher matrices (with functions to calculate biases etc). For details on the usage of each of those tools, please refer to the documentation at MaxMelching.gitlab.io/gw-signal-tools.

Installation

First of all, install the supported Python version of your choice.

After that, clone the repo to some destination and then navigate there and run

pip install .

to install it as a Python package (adding -e before the . enables editable mode). This syntax is convenient because it allows to install options via

pip install .[<option>]

Valid options for this package are all, code, dev, docs, test.

Another possibility without the extra cloning step is to run

pip install git+https://gitlab.com/MaxMelching/gw-signal-tools.git

or (recommended if you have a SSH key pair) running

pip install git+ssh://git@gitlab.com/MaxMelching/gw-signal-tools.git

The last two commands also allow to install arbitrary versions of the package by adding, for example, @v0.0.1 at the end of the prompt.

Project Status

By now, most of the code should be in good shape, i.e. no big API changes are expected/planned at the moment.

Change Log

Click here.

Documentation

Available here.

About

Mirror of gw-signal-tools GitLab

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages