Skip to main content

beetroots

PyPI version Documentation Status

Beetroots (BayEsian infErence with spaTial Regularization of nOisy multi-line ObservaTion mapS) is a Python package that performs Bayesian inference of physical parameters from multispectral-structured cubes with a dedicated sampling algorithm. Thanks to this sampling algorithm, beetroots provides maps of credibility intervals along with estimated maps.

The sampling algorithm is introduced in

[1] P. Palud, P.-A. Thouvenin, P. Chainais, E. Bron, and F. Le Petit - Efficient sampling of non log-concave posterior distributions with mixture of noises, IEEE Transactions on Signal Processing, vol. 71, pp. 2491 -- 2501, 2023. doi:10.1109/TSP.2023.3289728

Such inversions rely on a forward model that is assumed to emulate accurately the physics of the observed environment. In parallel of the inversion, beetroots tests this hypothesis to evaluate the validity of the inference results. The testing method is described in (in French)

[2] P. Palud, P. Chainais, F. Le Petit, P.-A. Thouvenin and E. Bron - Problèmes inverses et test bayésien d'adéquation du modèle, GRETSI - Groupe de Recherche en Traitement du Signal et des Images in 29e Colloque sur le traitement du signal et des images, Grenoble, pp. 705 -- 708, 2023.

This package was applied e.g., to infer physical conditions in different regions of the interstellar medium in

[3] P. Palud, P.-A. Thouvenin, P. Chainais, E. Bron, F. Le Petit and ORION-B consortium - Beetroots: Bayesian inference of interstellar medium physical parameter maps with a spatial regularization, in prep

Complex forward models

In numerous real-life applications, the forward model is a complex numerical simulation. In the astrophysics applications presented in the documentation, the numerical simulation is replaced with a neural network-based approximation of the forward model for

  • faster evaluation
  • ability to evaluate derivatives

The package used to derive this approximation is nnbma (Neural Network-Based Model Approximation). The GitHub repository can be found here, the package here and the corresponding documentation here. The paper presenting this package is

[5] P. Palud, L. Einig, F. Le Petit, E. Bron, P. Chainais, J. Chanussot, J. Pety, P.-A. Thouvenin and ORION-B consortium - Neural network-based emulation of interstellar medium models, Astronomy & Astrophysics, 2023, 678, pp.A198. doi:10.1051/0004-6361/202347074

Installation and testing

To prepare and perform an inversion, we recommend installing the package. The package can be installed with pip:

pip install beetroots

or by cloning the repo. To clone, install and test the package, run:

git clone git@github.com:pierrePalud/beetroots.git
cd beetroots
poetry install # or poetry install -E notebook -E docs for extra dependencies
poetry shell
pytest

Metadata

Release files for beetroots 1.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for beetroots 1.1.0
File Size Uploaded
beetroots-1.1.0.tar.gz 117.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for beetroots 1.1.0
File Interpreter ABI Platform
beetroots-1.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 290.8 kB

Release files / beetroots-1.1.0.tar.gz

Download URL beetroots-1.1.0.tar.gz
Size 117.8 kB
Tags Source
SHA-256 checksum
How to use checksums
8e4721700eaadee85e09d5ba8293293ab9c31cfa547d85521e541c9baad4a3cc
BLAKE2b-256 checksum
How to use checksums
e64284e0296ccddd49a96741fe406c34ff8811493e0558b812a7bc00fbdeb874
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.3 CPython/3.9.19 Darwin/23.6.0

Release files / beetroots-1.1.0-py3-none-any.whl

Download URL beetroots-1.1.0-py3-none-any.whl
Size 172.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
447f4a27b012a2fb30346d42d2a9084ca747ce2e83a292cbca25008a2d1a207b
BLAKE2b-256 checksum
How to use checksums
e9a66cb6ab9f9602bb1e62e237fe56a3054b2caa1811b71cc2ff2278fa9df0fe
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.3 CPython/3.9.19 Darwin/23.6.0

Release history Release notifications | RSS feed

This release

1.1.0 This release

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

0.2.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page