sunpy

A Python software package that provides fundamental tools for accessing, loading and interacting with solar physics data in Python.
https://github.com/sunpy/sunpy

Category: Climate Change
Sub Category: Earth and Climate Modeling

Keywords

astronomy astropy hacktoberfest python solar solar-physics sun sunpy

Keywords from Contributors

closember numfocus wcs nddata blackhole sphinx spec-0 computer-algebra wx gtk

Last synced: about 13 hours ago
JSON representation

Repository metadata

SunPy - Python for Solar Physics

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

        

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'

Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 4 days ago

Total Commits: 15,291
Total Committers: 262
Avg Commits per committer: 58.363
Development Distribution Score (DDS): 0.801

Commits in past year: 538
Committers in past year: 35
Avg Commits per committer in past year: 15.371
Development Distribution Score (DDS) in past year: 0.691

Name Email Commits
Stuart J. Mumford s****t@c****m 3041
Nabil Freij n****j@g****m 2286
David Stansby d****y@g****m 1156
Albert Y. Shih a****h@g****m 927
Jack Ireland j****d@n****v 792
Steven Christe s****e@n****v 762
Florian Mayer f****r@b****g 725
V. Keith Hughitt k****t@g****m 447
Daniel F. Ryan r****5@t****e 415
Will Barnes w****2@r****u 368
Simon Liedtke l****n@g****m 344
Laura Hayes h****a@t****e 266
Vishnunarayan K I. a****r@g****m 231
David Pérez-Suárez d****o@g****m 196
Pritish Chakraborty c****h@g****m 174
Andrew Inglis a****s@g****m 159
Brigitta Sipőcz b****z@g****m 149
Punyaslok Pattnaik p****k@y****n 147
Ahmed Hossam h****4@g****m 136
Andrew Leonard a****d@g****m 119
Conor MacBride c****r@m****e 115
Rishabh Sharma r****a@s****n 111
Abhijeet Manhas a****0@g****m 93
Russell Hewett r****t@m****u 88
Alex Hamilton a****n@h****m 82
pre-commit-ci[bot] 6****] 77
Asish Panda a****5@g****m 73
Nitin Choudhary n****3@g****m 66
Ankit Kumar a****r 65
Raahul Singh r****2@g****m 57
and 232 more...

Committer domains:


Issue and Pull Request metadata

Last synced: 6 days ago

Total issues: 393
Total pull requests: 1,942
Average time to close issues: 10 months
Average time to close pull requests: 23 days
Total issue authors: 83
Total pull request authors: 109
Average comments per issue: 3.7
Average comments per pull request: 1.95
Merged pull request: 1,480
Bot issues: 1
Bot pull requests: 134

Past year issues: 74
Past year pull requests: 623
Past year average time to close issues: 13 days
Past year average time to close pull requests: 7 days
Past year issue authors: 28
Past year pull request authors: 45
Past year average comments per issue: 1.73
Past year average comments per pull request: 1.38
Past year merged pull request: 453
Past year bot issues: 1
Past year bot pull requests: 33

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/sunpy/sunpy

Top Issue Authors

  • Cadair (54)
  • dstansby (43)
  • wtbarnes (43)
  • ayshih (43)
  • samaloney (27)
  • hayesla (25)
  • nabobalis (23)
  • wafels (10)
  • ehsteve (6)
  • alasdairwilson (6)
  • tanishy7777 (5)
  • jgieseler (5)
  • dpshelio (4)
  • olebole (4)
  • dgarciabriseno (4)

Top Pull Request Authors

  • meeseeksmachine (484)
  • nabobalis (387)
  • Cadair (168)
  • ayshih (160)
  • dstansby (87)
  • github-actions[bot] (82)
  • wtbarnes (67)
  • Sauravroy34 (32)
  • pre-commit-ci[bot] (31)
  • Prtm2110 (28)
  • ankitkhushwaha (26)
  • alasdairwilson (25)
  • samaloney (23)
  • dependabot[bot] (21)
  • CyclingNinja (20)

Top Issue Labels

  • Feature Request (109)
  • Package Novice (104)
  • Priority Low (100)
  • Effort Medium (80)
  • map (68)
  • Effort Low (65)
  • Priority Medium (65)
  • Bug (64)
  • Package Intermediate (51)
  • net (42)
  • Documentation (36)
  • coordinates (35)
  • Discussion (31)
  • Effort High (30)
  • Good First Issue (29)
  • Infrastructure (21)
  • Package Expert (20)
  • Examples (18)
  • io (18)
  • Refactoring (16)
  • Priority High (16)
  • Solar Physics Knowledge (14)
  • timeseries (12)
  • Upstream Fix Required (12)
  • Tests (10)
  • Remote Server Issue / VSO (8)
  • Affects Dev (7)
  • Affects Release (6)
  • Wont Fix (5)
  • Question (5)

Top Pull Request Labels

  • Minor Change (1,000)
  • No Changelog Entry Needed (991)
  • backport 6.0 (448)
  • No Backport (430)
  • backport 5.0 (334)
  • backport 5.1 (248)
  • map (223)
  • backport 6.1 (216)
  • Documentation (210)
  • Infrastructure (192)
  • Merge When CI Passes (154)
  • backport 7.0 (146)
  • Tests (107)
  • net (104)
  • coordinates (96)
  • Run cron CI (90)
  • Examples (76)
  • Whats New? (52)
  • Run publish (49)
  • io (36)
  • Needs Adoption (33)
  • util (32)
  • timeseries (31)
  • time (31)
  • Stale (29)
  • Needs Review (28)
  • dependencies (24)
  • backport 4.0 (20)
  • backport 4.1 (18)
  • Bug (18)

Package metadata

pypi.org: sunpy

SunPy core package: Python for Solar Physics

  • Homepage: https://sunpy.org
  • Documentation: https://docs.sunpy.org
  • Licenses: bsd-2-clause
  • Latest release: 7.1.0 (published 21 days ago)
  • Last Synced: 2025-12-28T04:32:02.200Z (2 days ago)
  • Versions: 187
  • Dependent Packages: 34
  • Dependent Repositories: 95
  • Downloads: 64,409 Last month
  • Docker Downloads: 90
  • Rankings:
    • Dependent packages count: 0.588%
    • Dependent repos count: 1.535%
    • Average: 1.813%
    • Docker downloads count: 2.096%
    • Stargazers count: 2.172%
    • Downloads: 2.24%
    • Forks count: 2.246%
  • Maintainers (4)
proxy.golang.org: github.com/sunpy/sunpy

  • Homepage:
  • Documentation: https://pkg.go.dev/github.com/sunpy/sunpy#section-documentation
  • Licenses: bsd-2-clause
  • Latest release: v7.1.0+incompatible (published 22 days ago)
  • Last Synced: 2025-12-24T11:04:36.260Z (6 days ago)
  • Versions: 151
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Rankings:
    • Dependent packages count: 5.442%
    • Average: 5.624%
    • Dependent repos count: 5.807%
conda-forge.org: sunpy

  • Homepage: https://www.sunpy.org/
  • Licenses: BSD-2-Clause
  • Latest release: 4.1.0 (published about 3 years ago)
  • Last Synced: 2025-12-24T11:04:35.675Z (6 days ago)
  • Versions: 85
  • Dependent Packages: 11
  • Dependent Repositories: 10
  • Rankings:
    • Dependent packages count: 5.48%
    • Forks count: 7.257%
    • Average: 9.521%
    • Dependent repos count: 11.016%
    • Stargazers count: 14.33%

Dependencies

.github/workflows/asv-regular.yml actions
  • JamesIves/github-pages-deploy-action v4 composite
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • webfactory/ssh-agent v0.8.0 composite
.github/workflows/changelog_bot.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • stefanzweifel/git-auto-commit-action v4 composite
.github/workflows/ci.yml actions
  • Cadair/matrix-notify-action main composite
  • actions/checkout v3 composite
  • codecov/codecov-action v3 composite
  • conda-incubator/setup-miniconda v2 composite
.github/workflows/scheduled_builds.yml actions
.github/workflows/stale_bot.yml actions
  • actions/stale v8 composite
pyproject.toml pypi
setup.py pypi

Score: 23.807547255019244