Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 76 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,47 @@
``sunkit-spex``
===============

A package for solar X-ray spectroscopy.
+-----------------------------------+-----------------------------------+-----------------------------------+
| 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| | |
+-----------------------------------+-----------------------------------+-----------------------------------+

.. image:: http://img.shields.io/badge/powered%20by-SunPy-orange.svg?style=flat
.. |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
----------------------

Expand All @@ -15,21 +50,56 @@ We expect authentic engagement in our community.
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 `#sunpy:openastronomy.org`_ if you have any questions.
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
.. _`#sunpy:openastronomy.org`: https://app.element.io/#/room/#sunpy:openastronomy.org
.. _issues page: https://github.com/sunpy/sunkit-spex/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>`__.