Docs

Furax: a Framework for Unified and Robust data Analysis with JAX.

This framework provides building blocks for solving inverse problems, in particular in the astrophysical and cosmological domains.

• Python >= 3.11
• JAX — install separately for your target hardware (CPU, CUDA, Metal, …)

Furax is available as furax on PyPI, and can be installed with:

pip install furax

Clone the repository, and navigate to the root directory of the project. For example:

git clone git@github.com:CMBSciPol/furax.git
cd furax

Then, install the package with:

pip install .

After cloning, install in editable mode and with development dependencies:

pip install -e .[dev]

We use pytest for testing. You can run the tests with:

pytest

To ensure that your code passes the quality checks, you can use our pre-commit configuration:

1. Install the pre-commit hooks with

pre-commit install

2. That's it! Every commit will trigger the code quality checks.