jaxtfwaves 0.2.0

Fast time-frequency gravitational-wave response package for LISA data analysis with a JAX backend

jaxtfwaves

JAXTFwaves is the sibling project of tfwaves that is using JAX as backend.

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 jaxtfwaves

To install a specific plugin, use its named extra:

pip install "jaxtfwaves[sobhbwaveform]"   # SOBHB waveforms via ripplegw
# pip install "jaxtfwaves[emriwaveform]"  # EMRI waveforms (coming soon)

Or install all available plugins at once:

pip install "jaxtfwaves[plugins]"

Contributing

Development environment

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

git clone [e-mail]:lisa-apc/tfwaves.git
cd jaxtfwaves

Create the lockfile and synchronize dependencies (including development tools):

uv sync --all-extras --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

Lint and format checks are handled with Ruff:

uv run ruff check src tests
uv run ruff format --check src tests

Alternatively, you can activate the virtual environment by running

source .venv/bin/activate

and deactivate it by just running

deactivate

Alternative local installation

As an alternative to uv-managed environments, you can install the package in development mode when you are in the jaxtfwaves directory:

pip install -e .            # core only
pip install -e ".[plugins]" # core + plugins

Publishing to PyPI

1. Build the package (from the repo root):

   uv build
   

2. Check the artifacts:

   uv run twine check dist/*
   

3. Upload to TestPyPI first:

   uv publish --publish-url https://test.pypi.org/legacy/ --token pypi-YOUR_TEST_TOKEN
   

   Verify the install:

   pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple jaxtfwaves
   pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple "jaxtfwaves[plugins]"
   

4. Upload to PyPI:

   uv publish --token pypi-YOUR_TOKEN
   

5. Tag the release:

   git tag v0.1.0
   git push origin v0.1.0