A SunPy affiliated package for solar instrument-specific tools.
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:
- Hold instrument tools that are so few they do not warrant their own package;
- Hold tools for instruments with no instrument team or the instrument team does not currently support solar applications;
- 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 as a great example of this type of collaboration.
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.
We love contributions! sunkit-instruments 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. 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 at to follow our code of conduct.