CosmologicalEmulators / Capse.jl

MIT License
4 stars 2 forks source link

Capse.jl

Documentation Build Status Code style
Build status (Github Actions) codecov Code Style: Blue ColPrac: Contributor's Guide on Collaborative Practices for Community Packages

arXiv size

Repo containing the CMB Angular Power Spectrum Emulator, Capse.jl.

Capse.jl is entirely written in Julia, but can be transparently called from Python using the pycapse wrapper.

Installation and usage

Details about installing and using Capse.jl can be found in the official documentation, but can be summerized as follows.

In order to install Capse.jl, run from the Julia REPL

using Pkg, Pkg.add(url="https://github.com/CosmologicalEmulators/Capse.jl")

After installing it, you need to instantiate a trained emulator, which can be done with

Cℓ_emu = Capse.load_emulator(weights_folder)

where weights_folder is the path to the folder with the trained emulator (some of them can be found on Zenodo). After this operation, to obtain the predictions for a set of cosmological parameters, put them in an array x and run

Capse.get_Cℓ(x, Cℓ_emu)

If you want to retrieve details about the emulators (e.g. which parameters were used to train it etc...) just run

Capse.get_emulator_description(Cℓ_emu)

Citing

Free usage of the software in this repository is provided, given that you cite our release paper.

M. Bonici, F. Bianchini, J. Ruiz-Zapatero, Capse: efficient and auto-differentiable CMB power spectra emulation