Metadata-Version: 2.4
Name: tfwaves
Version: 0.3.0
Author-email: Quentin Baghi <quentin.baghi@protonmail.com>, Gael Servignat <servignat@apc.in2p3.fr>, Saptarshi Ghosh <saptarshi.ghosh@apc.in2p3.fr>
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: scipy
Requires-Dist: numpy
Requires-Dist: h5py>=3.1
Requires-Dist: matplotlib
Requires-Dist: pytest<10.0.0,>=9.0.2
Requires-Dist: pylint<5.0.0,>=4.0.4
Requires-Dist: lisaconstants
Requires-Dist: ipykernel<8.0.0,>=7.1.0
Requires-Dist: pre-commit<5.0.0,>=4.5.1
Provides-Extra: docs
Requires-Dist: jupyter-book<2.0.0,>=1.0.4; extra == "docs"
Provides-Extra: sobhb
Requires-Dist: lisabeta==1.0.0; extra == "sobhb"
Provides-Extra: emri
Requires-Dist: fastemriwaveforms==2.0.0; extra == "emri"

# 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

```bash
pip install tfwaves
```

## Contributing

### Development environment

We use [Poetry 2](https://python-poetry.org/) for dependency management.
First clone the repository on your machine and go in the directory:

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

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

```bash
poetry install
```

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

```bash
pre-commit install
```

Then you can run any script using 

```bash
poetry run python your_script.py
```

Alternatively, you can activate the virtual environment by running

```bash
eval $(poetry env activate)
```
and deactivate it by just running

```bash
deactivate
```

### Documentation

This repository includes a short Jupyter Book in `docs/`.

Install docs dependencies:

```bash
pip install -e ".[docs]"
```

Build the documentation:

```bash
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:

```bash
pip install -e .
```
