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 core package is available on PyPI:

pip install tfwaves

To install a specific plugin, use its named extra:

pip install "tfwaves[sobhbwaveform]"   # SOBHB waveforms via lisabeta
pip install "tfwaves[emriwaveform]"    # EMRI waveforms via FEW

Or install all available plugins at once:

pip install "tfwaves[plugins]"

Contributing

Development environment

We use uv 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:

uv sync --group dev

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

uv run pre-commit install

Then you can run any script using

uv run python your_script.py

Alternatively, you can activate the virtual environment by running

source .venv/bin/activate

and deactivate it by just running

deactivate

Documentation

This repository includes a short Jupyter Book in docs/.

Install docs dependencies:

uv sync --dev --extra docs

Build the documentation:

jupyter-book build docs

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

Alternative local installation

You can also install the package in editable mode using pip when you are in the tfwaves directory:

pip install -e .                 # core only
pip install -e ".[sobhbwaveform]" # core + SOBHB plugin
pip install -e ".[emriwaveform]"  # core + EMRI plugin
pip install -e ".[plugins]"       # core + all plugins