Skip to main content

Beetroots (BayEsian infErence with spaTial Regularization of nOisy multi-line ObservaTion mapS)

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

beetroots-1.1.0.tar.gz (117.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

beetroots-1.1.0-py3-none-any.whl (172.9 kB view details)

Uploaded Python 3

File details

Details for the file beetroots-1.1.0.tar.gz.

File metadata

  • Download URL: beetroots-1.1.0.tar.gz
  • Upload date:
  • Size: 117.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.9.19 Darwin/23.6.0

File hashes

Hashes for beetroots-1.1.0.tar.gz
Algorithm Hash digest
SHA256 8e4721700eaadee85e09d5ba8293293ab9c31cfa547d85521e541c9baad4a3cc
MD5 09384325fd9cb6411855db1fc8454f2d
BLAKE2b-256 e64284e0296ccddd49a96741fe406c34ff8811493e0558b812a7bc00fbdeb874

See more details on using hashes here.

File details

Details for the file beetroots-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: beetroots-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 172.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.9.19 Darwin/23.6.0

File hashes

Hashes for beetroots-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 447f4a27b012a2fb30346d42d2a9084ca747ce2e83a292cbca25008a2d1a207b
MD5 a2b8996c186903d68171a64ddd518eab
BLAKE2b-256 e9a66cb6ab9f9602bb1e62e237fe56a3054b2caa1811b71cc2ff2278fa9df0fe

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page