Metadata-Version: 2.4
Name: stixpy
Version: 0.3.0
Summary: An open-source Python analysis library for the Spectrometer Telescope for Imaging X-rays (STIX) instrument on Solar Obriter.
Author-email: Shane Maloney <shane.maloney@dias.ie>
License-Expression: BSD-3-Clause
Project-URL: Homepage, https://stixpy.readthedocs.io
Project-URL: Source Code, https://github.com/TCDSolar/stixpy
Project-URL: Download, https://pypi.org/project/stixpy
Project-URL: Documentation, https://stixpy.readthedocs.io
Project-URL: Changelog, https://stixpy.readthedocs.io/en/latest/whatsnew/changelog.html
Project-URL: Issue Tracker, https://github.com/TCDSolar/stixpy/issues
Keywords: solar physics,solar,sun,x-rays
Platform: any
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering :: Physics
Provides: stixpy
Requires-Python: >=3.12
Description-Content-Type: text/x-rst
License-File: LICENSE.rst
Requires-Dist: sunpy[map,net,timeseries]>=7.0
Requires-Dist: packaging>=23.2
Requires-Dist: intervaltree>=3.0.2
Requires-Dist: roentgen<=2.4,>=2.2.0
Requires-Dist: matplotlib>=3.8.0
Requires-Dist: xrayvisim~=0.2.1
Provides-Extra: tests
Requires-Dist: matplotlib>=3.8.0; extra == "tests"
Requires-Dist: pytest-astropy>=0.11.0; extra == "tests"
Requires-Dist: pytest-mpl>=0.18; extra == "tests"
Requires-Dist: pytest-xdist>=3.0.2; extra == "tests"
Requires-Dist: pytest>=7.4.0; extra == "tests"
Provides-Extra: docs
Requires-Dist: matplotlib>=3.8.0; extra == "docs"
Requires-Dist: sphinx>=6.0.0; extra == "docs"
Requires-Dist: sphinx-automodapi>=0.14.1; extra == "docs"
Requires-Dist: packaging>=23.0; extra == "docs"
Requires-Dist: sphinx-changelog>=1.5.0; extra == "docs"
Requires-Dist: sphinx-design>=0.2.0; extra == "docs"
Requires-Dist: sphinx-gallery>=0.13.0; extra == "docs"
Requires-Dist: sphinxext-opengraph>=0.6.0; extra == "docs"
Requires-Dist: pydata-sphinx-theme>=0.16.0; extra == "docs"
Provides-Extra: dev
Requires-Dist: stixpy[docs,tests]; extra == "dev"
Dynamic: license-file

``STIXpy``
==========

|Powered By| |Build Status| |Doc Status| |Python Versions| |Zenodo|

.. |Powered By| image:: https://img.shields.io/badge/powered%20by-SunPy-orange.svg?style=flat
    :target: http://www.sunpy.org
    :alt: Powered by SunPy Badge

.. |Build Status| image:: https://github.com/TCDSolar/stixpy/actions/workflows/ci.yaml/badge.svg
    :target: https://github.com/TCDSolar/stixpy/actions/workflows/ci.yaml
    :alt: Build Status

.. |Doc Status| image:: https://readthedocs.org/projects/stixpy/badge/?version=stable
    :target: http://stixpy.readthedocs.io/en/latest/?badge=stable
    :alt: Documentation Status

.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/stixpy
    :target: https://pypi.python.org/pypi/stixpy
    :alt: Python Versions

.. |Zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.8086101.svg
    :target: https://doi.org/10.5281/zenodo.8086101
    :alt: DOI:10.5281/zenodo.8086101

An open-source Python analysis library for the Spectrometer Telescope for Imaging X-rays (STIX) instrument on Solar Obriter.

Installation
------------

It is strongly advised that you use and isolated environment through python's venv, virturalenv, anaconda or similar.

.. code-block::

   pip install stixpy

To install the developer version and set up a development environment, follow the instructions in our `Developers Guide`_


Usage of Generative AI
----------------------

We expect authentic engagement in our community.
**Do not post the output from Large Language Models or similar generative AI as code, issues or comments on GitHub or any other platform.**
If you use generative AI tools as an aid in developing code or documentation changes, ensure that you fully understand the proposed changes and can explain why they are the correct approach and an improvement to the current state.
For more information see our documentation on fair and appropriate `AI usage <https://docs.sunpy.org/en/latest/dev_guide/contents/ai_usage.html>`__.

Acknowledging or Citing ``STIXpy``
----------------------------------

If you use ``STIXpy`` in your scientific work, we would appreciate your `citing it in your publications <https://stixpy.readthedocs.io/en/stable/citing.html>`__.
The continued growth and development of ``STIXPy`` is dependent on the community being aware of ``STIXpy``.

Contributing
------------

We love contributions! STIXpy is open source, built on open source, and we'd love to have you hang out in our community.

If you would like to get involved, check out the `Developers Guide`_ section of the SunPy docs.
Help is always welcome so let us know what you like to work on, or check out the `issues page`_ for the list of known outstanding items.

For more information on contributing to SunPy, please read our `Newcomers' guide`_.

.. _Developers Guide: https://stixpy.readthedocs.io/en/latest/how_to_guides/dev_guide.html
.. _issues page: https://github.com/TCDSolar/stixpy/issues/
.. _Newcomers' guide: https://docs.sunpy.org/en/latest/dev_guide/contents/newcomers.html

When you are interacting with the SunPy community you are asked at to follow our `code of conduct <https://sunpy.org/coc>`__.
