Skip to main content

jaxspec is a bayesian spectral fitting library for X-ray astronomy.

Project description

Logo

jaxspec

PyPI - Version Python package Read the Docs Codecov Slack

:warning: jaxspec is still in early release: expect bugs, breaking API changes, undocumented features and lack of functionalities

jaxspec is an X-ray spectral fitting library built in pure Python. It can currently load an X-ray spectrum (in the OGIP standard), define a spectral model from the implemented components, and calculate the best parameters using state-of-the-art Bayesian approaches. It is built on top of JAX to provide just-in-time compilation and automatic differentiation of the spectral models, enabling the use of sampling algorithm such as NUTS.

jaxspec is written in pure Python, and has no dependancy to HEASoft, and can be installed directly using the pip command.

Documentation : https://jaxspec.readthedocs.io/en/latest/

Installation

We recommend the users to start from a fresh Python 3.10 conda environment.

conda create -n jaxspec python=3.10
conda activate jaxspec

Once the environment is set up, you can install jaxspec directly from pypi

pip install jaxspec --upgrade

Citation

If you use jaxspec in your research, please consider citing the following article

@ARTICLE{2024A&A...690A.317D,
       author = {{Dupourqu{\'e}}, S. and {Barret}, D. and {Diez}, C.~M. and {Guillot}, S. and {Quintin}, E.},
        title = "{jaxspec: A fast and robust Python library for X-ray spectral fitting}",
      journal = {\aap},
     keywords = {methods: data analysis, methods: statistical, X-rays: general},
         year = 2024,
        month = oct,
       volume = {690},
          eid = {A317},
        pages = {A317},
          doi = {10.1051/0004-6361/202451736},
       adsurl = {https://ui.adsabs.harvard.edu/abs/2024A&A...690A.317D},
      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}

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

jaxspec-0.2.1.tar.gz (46.2 kB view details)

Uploaded Source

Built Distribution

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

jaxspec-0.2.1-py3-none-any.whl (54.7 kB view details)

Uploaded Python 3

File details

Details for the file jaxspec-0.2.1.tar.gz.

File metadata

  • Download URL: jaxspec-0.2.1.tar.gz
  • Upload date:
  • Size: 46.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.1 CPython/3.11.7 Linux/6.8.0-1020-azure

File hashes

Hashes for jaxspec-0.2.1.tar.gz
Algorithm Hash digest
SHA256 65b879e2a3371863791761ca24197fb4c249c67d49d0a1e11a62b9957bcd326b
MD5 83b83d76e301a1573b3bee912dd4b0ec
BLAKE2b-256 1d6e6bc3ef7de63fbccbec6f7de13c1a2266d49fd4be6f3abb14b1c0178ee857

See more details on using hashes here.

File details

Details for the file jaxspec-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: jaxspec-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 54.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.1 CPython/3.11.7 Linux/6.8.0-1020-azure

File hashes

Hashes for jaxspec-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 579ca24e20a4288bebdc0afb139d4a6c0a85b1cb6b686b410f7fae138bac8209
MD5 2cde273f571ebf09c20dd3cf983566de
BLAKE2b-256 ba8d48448e4896d847f397911027803b4a42b2103ed5ebc8c5d0ddb97db0c65e

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