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.3.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.3-py3-none-any.whl (65.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: jaxspec-0.3.3.tar.gz
  • Upload date:
  • Size: 1.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.21 {"installer":{"name":"uv","version":"0.9.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for jaxspec-0.3.3.tar.gz
Algorithm Hash digest
SHA256 1814bb981e24e2a85f4cf50ed29a7abf46696ae9f77b993ff04110eba762fcea
MD5 c392fb81e7bc02ff2cd7af68219f91eb
BLAKE2b-256 37ceb32ba733bda1fa9856e35309d552e275ec1bbca1808525d0131b9f7e9cd1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: jaxspec-0.3.3-py3-none-any.whl
  • Upload date:
  • Size: 65.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.21 {"installer":{"name":"uv","version":"0.9.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for jaxspec-0.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 2c86776ab030111612d34edd2f9d78e7d35a3d8bd2b16246da74458f781a43c4
MD5 72cf0e9a803366ab3de298967c2f59ca
BLAKE2b-256 3698a088f69c86d84c2ab2db0b2e1f6de3821ba6d5f18b1b44c53867fce9a973

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