tfwaves

TFWaves is a python package to compute fast time-frequency gravitational-wave response for LISA data analysis. It takes as imput phase and amplitude functions of the gravitational strain in the pseudo-inertial solar system barycenter frame, and outputs time-delay interferometry responses in the time-frequency domain.

Installation

The package is available on PyPI. You can install it with

pip install tfwaves

Contributing

Development environment

We use Poetry 2 for dependency management. First clone the repository on your machine and go in the directory:

git clone git@gitlab.in2p3.fr:lisa-apc/tfwaves.git
cd tfwaves

To install the dependencies and the project itself, run the following command:

poetry install

We recommend you install pre-commit hooks to detect errors before you even commit.

pre-commit install

Then you can run any script using

poetry run python your_script.py

Alternatively, you can activate the virtual environment by running

eval $(poetry env activate)

and deactivate it by just running

deactivate

Documentation

This repository includes a short Jupyter Book in docs/.

Install docs dependencies:

pip install -e ".[docs]"

Build the documentation:

jupyter-book build docs

Open docs/_build/html/index.html in a browser.

Alternative local installation

As an alternative to poetry, you can install the package in development mode when you are in the tfwaves directory:

pip install -e .