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.2.dev0.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.2.2.dev0-py3-none-any.whl (54.9 kB view details)

Uploaded Python 3

File details

Details for the file jaxspec-0.2.2.dev0.tar.gz.

File metadata

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

File hashes

Hashes for jaxspec-0.2.2.dev0.tar.gz
Algorithm Hash digest
SHA256 5da25b70ebd858083a4dfc573158ab1db7cf0e4dff169ff1a5a00eb3e5bec2b7
MD5 07345ed4f398342b6074bc789c9ced2b
BLAKE2b-256 12eace652b5ad1d577502d4d6dad56c68a4f72fda76185cf1f888f8b349ba134

See more details on using hashes here.

File details

Details for the file jaxspec-0.2.2.dev0-py3-none-any.whl.

File metadata

File hashes

Hashes for jaxspec-0.2.2.dev0-py3-none-any.whl
Algorithm Hash digest
SHA256 c7afbd83c5bd3e0efd3d7d924ef6c2ad174cbf089df8b5a5ce14a7fb37a19b78
MD5 dfff920f271181b9d86e9651ceebfe3c
BLAKE2b-256 b225035b84cb78f5a80082895bc71e20507b6e9da3a3d536357e7904bbe836fc

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