sunpy

SunPy core package: Python for Solar Physics

|SunPy Logo|

+-----------------------------------+-----------------------------------+-----------------------------------+ | Release | Development | Community | +===================================+===================================+===================================+ | |Latest PyPi Version| | |Python Versions| | |Matrix Chat Room| | +-----------------------------------+-----------------------------------+-----------------------------------+ | |Latest Conda Version| | |Project Status: Active| | |OpenAstronomy Discourse| | +-----------------------------------+-----------------------------------+-----------------------------------+ | |Zenodo - Latest DOI| | |Continuous Integration Status| | |Google Groups Mailing List| | +-----------------------------------+-----------------------------------+-----------------------------------+ | |sunpy stable documentation| | |CodeCov Code Coverage| | |Powered by NumFOCUS| | +-----------------------------------+-----------------------------------+-----------------------------------+ | |sunpy citation| | | |pyOpenSci| | +-----------------------------------+-----------------------------------+-----------------------------------+

.. |SunPy Logo| image:: https://raw.githubusercontent.com/sunpy/sunpy-logo/master/generated/sunpylogolandscape.png :width: 200px .. |Latest PyPi Version| image:: https://img.shields.io/pypi/v/sunpy.svg :target: https://pypi.python.org/pypi/sunpy/ .. |Python Versions| image:: https://img.shields.io/pypi/pyversions/sunpy :target: https://pypi.python.org/pypi/sunpy/ .. |Matrix Chat Room| image:: https://img.shields.io/matrix/sunpy:openastronomy.org.svg?colorB=%23FE7900&label=Chat&logo=matrix&serverfqdn=matrix.org :target: https://app.element.io/#/room/#sunpy:openastronomy.org .. |Latest Conda Version| image:: https://anaconda.org/conda-forge/sunpy/badges/version.svg :target: https://anaconda.org/conda-forge/sunpy .. |Project Status: Active| image:: https://www.repostatus.org/badges/latest/active.svg :target: https://www.repostatus.org/#active .. |OpenAstronomy Discourse| image:: https://cdck-file-uploads-global.s3.dualstack.us-west-2.amazonaws.com/try2/original/1X/5e1e3b3cada2d7fbae4734d4bc53999933d71c95.svg :height: 20px :target: https://community.openastronomy.org/ .. |Zenodo - Latest DOI| image:: https://zenodo.org/badge/2165383.svg :target: https://zenodo.org/badge/latestdoi/2165383 .. |Continuous Integration Status| image:: https://github.com/sunpy/sunpy/actions/workflows/ci.yml/badge.svg?branch=main :target: https://github.com/sunpy/sunpy/actions/workflows/ci.yml .. |Google Groups Mailing List| image:: https://upload.wikimedia.org/wikipedia/commons/2/27/GoogleGroups_logo.gif :height: 20px :target: https://groups.google.com/g/sunpy .. |sunpy stable documentation| image:: https://readthedocs.org/projects/sunpy/badge/?version=stable :target: https://docs.sunpy.org/ .. |CodeCov Code Coverage| image:: https://codecov.io/gh/sunpy/sunpy/branch/main/graph/badge.svg :target: https://codecov.io/gh/sunpy/sunpy .. |Powered by NumFOCUS| image:: https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A :target: https://numfocus.org .. |sunpy citation| image:: https://img.shields.io/badge/cite-sunpy-orange :target: https://docs.sunpy.org/en/stable/citation.html .. |pyOpenSci| image:: https://tinyurl.com/y22nb8up :target: https://github.com/pyOpenSci/software-submission/issues/147

sunpy is a Python software package that provides fundamental tools for accessing, loading and interacting with solar physics data in Python. It includes an interface for searching and downloading data from multiple data providers, data containers for image and time series data, commonly used solar coordinate frames and associated transformations, as well as other functionality needed for solar data analysis.

Installation

We recommend following the installation guide <https://docs.sunpy.org/en/stable/guide/installation.html>__ in the sunpy documentation. This will walk you through installing sunpy and all of its dependencies.

Usage

If you are new to sunpy, the best place to start is the tutorial <https://docs.sunpy.org/en/stable/tutorial/index.html>. The example gallery <https://docs.sunpy.org/en/stable/generated/gallery/index.html> also includes a collection of shorter and more specific examples of using sunpy.

Changes

See our changelog <https://docs.sunpy.org/en/stable/whatsnew/changelog.html>__ for the latest changes in sunpy.

Getting Help

For more information or to ask questions about sunpy or any other SunPy Project package, please check out:

• sunpy documentation <https://docs.sunpy.org/en/stable/>__
• SunPy Affiliated Packages <https://sunpy.org/affiliated>__
• SunPy Chat <https://app.element.io/#/room/#sunpy:openastronomy.org>__
• SunPy mailing list <https://groups.google.com/forum/#!forum/sunpy>__
• SunPy Community forum <https://community.openastronomy.org/c/sunpy/5>__

Acknowledging or Citing sunpy

If you use sunpy in your scientific work, we would appreciate your citing it in your publications <https://docs.sunpy.org/en/stable/citation.html>__. The continued growth and development of sunpy is dependent on the community being aware of sunpy.

Usage of Generative AI

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

Contributing

We love contributions! sunpy 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_.

.. Developers Guide: https://docs.sunpy.org/en/latest/devguide/index.html .. #sunpy:openastronomy.org: https://app.element.io/#/room/#sunpy:openastronomy.org .. _issues page: https://github.com/sunpy/sunpy/issues .. _Newcomers' guide: https://docs.sunpy.org/en/latest/devguide/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>__.