Skip to main content

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

Project description

Logo

jaxspec

PyPI - Version Python Version from PEP 621 TOML 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.3.1.tar.gz (1.5 MB view details)

Uploaded Source

Built Distribution

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

jaxspec-0.3.1-py3-none-any.whl (65.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: jaxspec-0.3.1.tar.gz
  • Upload date:
  • Size: 1.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.7

File hashes

Hashes for jaxspec-0.3.1.tar.gz
Algorithm Hash digest
SHA256 0001dea169c315a92d112b721f1600c97e9e40b3ffc0deff6f415bddbae70a0e
MD5 9fbdbde028ae27161b9c860f135f8a31
BLAKE2b-256 b0758b160908854ebad594a92e4963332986bd6f8009ca934c7edf80970fa1d8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: jaxspec-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 65.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.7

File hashes

Hashes for jaxspec-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4e7696f6a7856818c60d9eaf75039134e7a0da7ee20533b30ddcf2c1253bf15f
MD5 d6d9fafb18070485bb65c3f3e0c52533
BLAKE2b-256 33e808843b9094225104d15257e3e9d0047089ab87fad5e498539fb8d0ba781f

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