sunpy__sunpy.f8edfd5c

https://github.com/swesmith/sunpy__sunpy.f8edfd5c

Repository

README.rst

*********
``sunpy``
*********
|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/sunpy_logo_landscape.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&server_fqdn=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/Google_Groups_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 recommended following the `installation guide `__ 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 `__.
the `example gallery `__ also includes a collection of shorter and more specific examples of using ``sunpy``.

Changes
=======

See our `changelog `__. 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 `__
-  `SunPy Affiliated Packages `__
-  `SunPy Chat`_
-  `SunPy mailing list `__
-  `SunPy Community forum `__

Acknowledging or Citing ``sunpy``
=================================

If you use ``sunpy`` in your scientific work, we would appreciate your `citing it in your publications `__.
The continued growth and development of ``sunpy`` is dependent on the community being aware of ``sunpy``.

Contributing
============

The SunPy Project is a community-driven open-source project that welcomes any and all contributions.
Whether you are a developer, student, or user, you can help by contributing code, documentation, or community support.

If you would like to get involved, the `Newcomers Guide`_ guide explains the many different ways to contribute to the SunPy Project and also shows how to get set up with a development workflow.

Help is always welcome, so come and say hello by joining the `SunPy Chat`_ and look over the `Good First Issues list`_ for the ideal places to start.

.. _Newcomers Guide: https://docs.sunpy.org/en/latest/dev_guide/contents/newcomers.html
.. _Good First Issues list: https://github.com/sunpy/sunpy/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22Good+First+Issue%22

Usage of Generative AI
======================

We expect authentic engagement in our community.
Be wary of posting output from Large Language Models or similar generative AI as comments on GitHub or any other platform, as such comments tend to be formulaic and low quality content.
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.

Code of Conduct
===============

When you are interacting with the SunPy Community you are asked to follow our `Code of Conduct `__.

.. _SunPy Chat: https://app.element.io/#/room/#sunpy:openastronomy.org

Owner

Citation (CITATION.cff)

cff-version: '1.1.0'
message: 'Please cite the following work when using this software.'
authors:
  - name: 'The SunPy Community'
  - family-names: 'Barnes'
    given-names: 'Will T.'
  - family-names: 'Bobra'
    given-names: 'Monica G.'
  - family-names: 'Christe'
    given-names: 'Steven D.'
  - family-names: 'Freij'
    given-names: 'Nabil'
  - family-names: 'Hayes'
    given-names: 'Laura A.'
  - family-names: 'Ireland'
    given-names: 'Jack'
  - family-names: 'Mumford'
    given-names: 'Stuart'
  - family-names: 'Perez-Suarez'
    given-names: 'David'
  - family-names: 'Ryan'
    given-names: 'Daniel F.'
  - family-names: 'Shih'
    given-names: 'Albert Y.'
  - family-names: 'Chanda'
    given-names: 'Prateek'
  - family-names: 'Glogowski'
    given-names: 'Kolja'
  - family-names: 'Hewett'
    given-names: 'Russell'
  - family-names: 'Hughitt'
    given-names: 'V. Keith'
  - family-names: 'Hill'
    given-names: 'Andrew'
  - family-names: 'Hiware'
    given-names: 'Kaustubh'
  - family-names: 'Inglis'
    given-names: 'Andrew'
  - family-names: 'Kirk'
    given-names: 'Michael S. F.'
  - family-names: 'Konge'
    given-names: 'Sudarshan'
  - family-names: 'Mason'
    given-names: 'James Paul'
  - family-names: 'Maloney'
    given-names: 'Shane Anthony'
  - family-names: 'Murray'
    given-names: 'Sophie A.'
  - family-names: 'Panda'
    given-names: 'Asish'
  - family-names: 'Park'
    given-names: 'Jongyeob'
  - family-names: 'Pereira'
    given-names: 'Tiago M. D.'
  - family-names: 'Reardon'
    given-names: 'Kevin'
  - family-names: 'Savage'
    given-names: 'Sabrina'
  - family-names: 'Sipőcz'
    given-names: 'Brigitta M.'
  - family-names: 'Stansby'
    given-names: 'David'
  - family-names: 'Jain'
    given-names: 'Yash'
  - family-names: 'Taylor'
    given-names: 'Garrison'
  - family-names: 'Yadav'
    given-names: 'Tannmay'
  - family-names: 'Rajul'
  - family-names: 'Dang'
    given-names: 'Trung Kien'
doi: '10.3847/1538-4357/ab4f7a'
identifiers:
  - type: 'doi'
    value: '10.3847/1538-4357/ab4f7a'
  - type: 'url'
    value: 'https://iopscience.iop.org/article/10.3847/1538-4357/ab4f7a'
title: 'The SunPy Project: Open Source Development and Status of the Version 1.0 Core Package'
url: 'https://iopscience.iop.org/article/10.3847/1538-4357/ab4f7a'

GitHub Events