Metadata-Version: 2.4
Name: sunkit_spex
Version: 0.5.0
Summary: A package for solar X-ray spectroscopy.
Author-email: The SunPy Community <sunpy@googlegroups.com>
Project-URL: Homepage, https://sunkit-spex.readthedocs.io
Project-URL: Source Code, https://github.com/sunpy/sunkit-spex
Project-URL: Download, https://pypi.org/project/sunkit-spex
Project-URL: Documentation, https://sunkit-spex.readthedocs.io
Project-URL: Changelog, https://sunkit-spex.readthedocs.io/en/latest/whatsnew/changelog.html
Project-URL: Issue Tracker, https://github.com/sunpy/sunkit-spex/issues
Keywords: solar physics,solar,science,sun,x-ray,gamma-ray,spectra
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
Requires-Python: >=3.12
Description-Content-Type: text/x-rst
License-File: licenses/LICENSE.rst
Requires-Dist: matplotlib>=3.9
Requires-Dist: numpy>=1.26
Requires-Dist: parfive>=2.1
Requires-Dist: scipy>=1.14.1
Requires-Dist: sunpy>=7.0
Requires-Dist: xarray>=2023.12
Requires-Dist: gwcs<1.0.0,>=0.26.0
Requires-Dist: ndcube>=2.3
Provides-Extra: legacy
Requires-Dist: corner>=2.2; extra == "legacy"
Requires-Dist: emcee>=3.1; extra == "legacy"
Requires-Dist: nestle>=0.2; extra == "legacy"
Requires-Dist: numdifftools>=0.9.42; extra == "legacy"
Provides-Extra: tests
Requires-Dist: pytest; extra == "tests"
Requires-Dist: pytest-doctestplus; extra == "tests"
Requires-Dist: pytest-cov; extra == "tests"
Requires-Dist: pytest-xdist; extra == "tests"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx-automodapi; extra == "docs"
Requires-Dist: sphinx-changelog; extra == "docs"
Requires-Dist: sunpy-sphinx-theme; extra == "docs"
Requires-Dist: packaging; extra == "docs"
Requires-Dist: sphinx-changelog; extra == "docs"
Requires-Dist: sphinx-gallery; extra == "docs"
Requires-Dist: joblib; extra == "docs"
Provides-Extra: dev
Requires-Dist: sunkit-spex[docs,legacy,tests]; extra == "dev"
Requires-Dist: tox; extra == "dev"
Dynamic: license-file

``sunkit-spex``
===============

+-----------------------------------+-----------------------------------+-----------------------------------+
|           Release                 |           Development             |           Community               |
+===================================+===================================+===================================+
|       |Latest PyPi Version|       |        |Python Versions|          |       |Matrix Chat Room|          |
+-----------------------------------+-----------------------------------+-----------------------------------+
|         |Zenodo - Latest DOI|     |     |Project Status: Active|      |       |Powered by Sunpy|          |
+-----------------------------------+-----------------------------------+-----------------------------------+
|         |Stable docs|             |  |Continuous Integration Status|  |                                   |
+-----------------------------------+-----------------------------------+-----------------------------------+
|                                   |  |CodeCov Code Coverage|          |                                   |
+-----------------------------------+-----------------------------------+-----------------------------------+

.. |Latest PyPi Version| image:: https://img.shields.io/pypi/v/sunkit-spex.svg
   :target: https://pypi.python.org/pypi/sunkit-spex/

.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/sunkit-spex
   :target: https://pypi.python.org/pypi/sunkit-spex/

.. |Matrix Chat Room| image:: https://img.shields.io/matrix/sunxspex:openastronomy.org.svg?colorB=%23FE7900&label=Chat&logo=matrix&server_fqdn=matrix.org
   :target: https://app.element.io/#/room/#sunxspex:openastronomy.org

.. |Project Status: Active| image:: https://www.repostatus.org/badges/latest/active.svg
   :target: https://www.repostatus.org/#active

.. |Zenodo - Latest DOI| image:: https://zenodo.org/badge/175066331.svg
   :target: https://zenodo.org/doi/10.5281/zenodo.11526911

.. |Continuous Integration Status| image:: https://github.com/sunpy/sunkit-spex/actions/workflows/ci.yml/badge.svg?branch=main
   :target: https://github.com/sunpy/sunkit-spex/actions/workflows/ci.yml

.. |CodeCov Code Coverage| image:: https://codecov.io/gh/sunpy/sunkit-spex/graph/badge.svg?token=42ghDinUal
   :target: https://codecov.io/gh/sunpy/sunkit-spex

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

.. |Stable docs| image:: https://readthedocs.org/projects/sunkit-spex/badge/?version=stable
    :target: https://sunkit-spex.readthedocs.io/en/stable/?badge=stable
    :alt: Documentation Status

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>`__.

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

See the `installation guide <https://sunkit-spex.readthedocs.io/en/latest/tutorials/installation.html>`__.

If you are new to ``sunkit-spex``, the best place to start is the `example gallery <https://sunkit-spex.readthedocs.io/en/latest/generated/gallery/index.html>`__ it includes a collection of short, specific examples of using ``sunkit-spex``.

Changes
-------

See our `changelog <https://sunkit-spex.readthedocs.io/en/stable/whatsnew/changelog.html>`__ for the latest changes in ``sunkit-spex``.

Getting Help
------------

For more information or to ask questions about ``sunkit-spex`` please check out:

-  `sunkit-spex documentation <https://sunkit-spex.readthedocs.io/en/stable/?badge=stable>`__
-  `#sunxspex:openastronomy.org`_

Acknowledging or Citing ``sunkit-spex``
----------------------------------------

If you use ``sunkit-spex`` in your scientific work, we would appreciate your citing it in your publications |Zenodo - Latest DOI|.
The continued growth and development of ``sunkit-spex`` is dependent on the community being aware of ``sunkit-spex``.

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

We love contributions! sunkit-spex 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.
Stop by our chat room `#sunxspex:openastronomy.org`_ if you have any questions.
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`_.

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

License
-------

This project is Copyright (c) The SunPy Community and licensed under
the terms of the BSD 3-Clause license. This package is based upon
the `Openastronomy packaging guide <https://github.com/OpenAstronomy/packaging-guide>`_
which is licensed under the BSD 3-clause licence. See the licenses folder for
more information.

.. _`#sunxspex:openastronomy.org`: https://app.element.io/#/room/#sunxspex:openastronomy.org
.. _Developers Guide: https://docs.sunpy.org/en/latest/dev_guide/index.html
.. _issues page: https://github.com/sunpy/sunkit-spex/issues
.. _Newcomers' guide: https://docs.sunpy.org/en/latest/dev_guide/contents/newcomers.html
