Metadata-Version: 2.4
Name: jaxgb
Version: 0.2.0
Summary: Fast LISA response for Galactic binaries using JAX
Author-email: Jean-Baptiste Bayle <j2b.bayle@gmail.com>, Maude Le Jeune <lejeune@apc.in2p3.fr>, Jonathan Menu <jonathan.menu@kuleuven.be>
License: BSD-3-Clause
License-File: LICENSE
Keywords: GW,LISA,gravitational wave,waveform
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.12
Requires-Dist: jax>=0.4.38
Requires-Dist: lisaconstants>=2.0
Requires-Dist: lisaorbits>=3.0
Requires-Dist: numpy>=2.3.3
Requires-Dist: wejax>=1.0.1
Description-Content-Type: text/markdown

# JAXGB

Compute fast link and TDI response for Galactic binaries, using JAX.

These methods are based on heterodyning and source-vectorization. See
accompagnied documentation for more information and references.

## Contributing

This project uses [uv](https://docs.astral.sh/uv/) for dependency management.

To run a command inside a specially-created virtual environement containing all
the necessary depedencies (including developement tools), run

```bash
uv run <YOUR-COMMAND>
```

To create a virtual environement explicitely (for example, to use with VS Code),
run the following commands

```bash
uv venv && uv sync
```

Do not forget to regularly synchronize your virtual environement with the
project dependencies, using `uv sync`.
