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.1.4.tar.gz (48.1 kB view details)

Uploaded Source

Built Distribution

jaxspec-0.1.4-py3-none-any.whl (55.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: jaxspec-0.1.4.tar.gz
  • Upload date:
  • Size: 48.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.11.7 Linux/6.5.0-1025-azure

File hashes

Hashes for jaxspec-0.1.4.tar.gz
Algorithm Hash digest
SHA256 1d08b431726f5281660a10a99dd112a047ebde511f571de84e6cb9a19f91cfb9
MD5 0a293101b1d6a5ef39d678ba9539cebd
BLAKE2b-256 ad0e7532886510f2537c359ac8fbce2446ee2483da7643fa6eb318bc90663b0f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: jaxspec-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 55.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.11.7 Linux/6.5.0-1025-azure

File hashes

Hashes for jaxspec-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 87158edd2c17d7363ba4db0861329f0da8c18e8e3371ee4a9936ca7161247109
MD5 8fe6b6aba2de2808f14dc27b2bd82dac
BLAKE2b-256 35bcb94d3ee29cf643e0962d50df3cc35b604e0f7ae0dd08b28fa0f824ffa88a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page