fiestaEM 0.1.0

Fast inference of electromagnetic signals with JAX

fiesta 🎉

fiesta: Fast Inference of Electromagnetic Signals and Transients with jAx

NOTE: fiesta is currently under development. We have some basic documentation available under ./docs. Feel free to contact us for any questions.

Installation

fiesta can be installed from pip via

pip install fiesta

Alternatively you can install it directly from source by cloning

git clone [e-mail]:nuclear-multimessenger-astronomy/fiestaEM.git

and then run

pip install -e .

in the cloning directory.

Note, that by default only the cpu version of jax is installed. If you want to use GPU acceleration, run

pip install fiesta[gpu]

or install jax[cuda12] as indicated on the jax webpage manually.

Also, due to the file size limit on pypi, the pypi distribution only contains a reduced amount of built-in surrogates. If you want all built-in surrogates, we recommend editable installation from source or to download the .pkl files manually and store them in the surrogates folder of the site-package. You can check which built-in surrogates are available by running

python -c "from fiesta.inference.lightcurve_model import list_built_in_surrogates; list_built_in_surrogates()"

Training surrogate models

To train your own surrogate models, have a look at some of the example scripts in the repository for inspiration. You can find them under ./surrogates/GRB/ and ./surrogates/KN/ in the respective model folders. The example section on training is currently work in progress.

Examples

We have example scripts for running an inference on AT2017gfo + GRB170817A. They can be found in ./examples/inference/. We also plan to add an example section on training surrogates in the future.

Acknowledgements

The logo was created by ideogram AI.