Metadata-Version: 2.1
Name: sunkit-instruments
Version: 0.3.2
Summary: A SunPy-affiliated package for solar instrument-specific tools.
Home-page: https://sunpy.org
Author: The SunPy Community
Author-email: sunpy@googlegroups.com
License: BSD 3-Clause
Keywords: solar physics,solar,science,telescope,instrumentation
Platform: any
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Scientific/Engineering :: Physics
Provides: sunkit_instruments
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
Provides-Extra: tests
Provides-Extra: docs
Provides-Extra: dev
Provides-Extra: all
License-File: LICENSE.rst

A SunPy-affiliated package for solar instrument-specific tools.
---------------------------------------------------------------

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

What is sunkit-instruments?
---------------------------

sunkit-instruments is a SunPy-affiliated package for solar instrument-specific tools.
Its purpose is not to be a repository for all tools for all instruments.
Instead it is intended to perform three main roles:

1. Hold instrument tools that are so few they do not warrant their own package;
2. Hold tools for instruments with no instrument team or the instrument team does not currently support solar applications;
3. Act as an incubator for instrument-specific tools that can evolve into a separate instrument package, backed by an instrument team.

For instrument teams, this package can act as a forum to engage with their user base and learn how to best develop their tools within the SunPy/scientific Python ecosystem.
It also lowers the barrier to publishing Python-based instrument tools by providing packaging and release infrastructure and support.
However should instrument teams want to develop at their own pace or provide a large number of tools,
they should consider starting their own package for full control.
We encourage and support instrument teams in choosing this route and hope they will still engage and collaborate with the SunPy and wider community during their development.
We point to the recent development of `aiapy <https://gitlab.com/LMSAL_HUB/aia_hub/aiapy>`__ as a great example of this type of collaboration.

License
-------

This project is Copyright (c) The SunPy Developers 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.

Code of Conduct
---------------

sunkit-instruments follows the SunPy Project's `Code of Conduct <https://sunpy.org/coc>`__
