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 2 hours ago
JSON representation

Repository metadata

SunPy - Python for Solar Physics

• Host: GitHub
• URL: https://github.com/sunpy/sunpy
• Owner: sunpy
• License: bsd-2-clause
• Created: 2011-08-06T15:34:08.000Z (over 14 years ago)
• Default Branch: main
• Last Pushed: 2026-04-07T10:07:07.000Z (10 days ago)
• Last Synced: 2026-04-11T16:06:20.630Z (6 days ago)
• Topics: astronomy, astropy, hacktoberfest, python, solar, solar-physics, sun, sunpy
• Language: Python
• Homepage: http://www.sunpy.org
• Size: 68.8 MB
• Stars: 1,008
• Watchers: 45
• Forks: 656
• Open Issues: 274
• Releases: 158
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE.rst
  • Citation: CITATION.cff
  • Zenodo: .zenodo.json

README.rst

          ``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/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 recommend 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``.

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

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/dev_guide/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/dev_guide/contents/newcomers.html

When you are interacting with the SunPy community you are asked at to follow our `code of conduct `__.

        

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

• Name: SunPy
• Login: sunpy
• Email:
• Kind: organization
• Description: Python for Solar Physics
• Website: https://www.sunpy.org
• Location:
• Twitter:
• Company:
• Icon url: https://avatars.githubusercontent.com/u/963197?v=4
• Repositories: 49
• Last ynced at: 2024-10-29T10:54:43.114Z
• Profile URL: https://github.com/sunpy

---

GitHub Events

Total

• Create event: 55
• Release event: 10
• Issues event: 162
• Watch event: 67
• Delete event: 38
• Issue comment event: 1302
• Push event: 342
• Gollum event: 10
• Pull request review comment event: 2004
• Pull request review event: 2081
• Pull request event: 748
• Fork event: 49

Last Year

• Create event: 48
• Release event: 9
• Issues event: 153
• Watch event: 60
• Delete event: 32
• Issue comment event: 1225
• Push event: 311
• Gollum event: 10
• Pull request review event: 1939
• Pull request review comment event: 1883
• Pull request event: 681
• Fork event: 44

---

Committers metadata

Last synced: 2 days ago

Name	Email	Commits
Stuart J. Mumford	s****t@c****m	3069
Nabil Freij	n****j@g****m	2287
David Stansby	d****y@g****m	1156
Albert Y. Shih	a****h@g****m	935
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****]	79
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 233 more...

Committer domains:

• nasa.gov: 5
• stsci.edu: 3
• tcd.ie: 2
• oma.be: 2
• swri.org: 2
• physik.uni-kiel.de: 1
• utu.fi: 1
• humboldt.edu: 1
• iitgn.ac.in: 1
• iitb.ac.in: 1
• fhnw.ch: 1
• akenza.io: 1
• vt.edu: 1
• gmx.at: 1
• cfa.harvard.edu: 1
• nso.edu: 1
• ucl.ac.uk: 1
• stanford.edu: 1
• nitk.edu.in: 1
• iitbhu.ac.in: 1
• mac.com: 1
• itekako.com: 1
• earnshaw.org.uk: 1
• dias.ie: 1
• mit.edu: 1
• students.iiit.ac.in: 1
• macbride.me: 1
• yahoo.co.in: 1
• rice.edu: 1
• bitsrc.org: 1
• lasp.colorado.edu: 1
• babuschk.in: 1
• cornell.edu: 1
• unal.edu.co: 1
• kurtmckee.org: 1
• kgpian.iitkgp.ac.in: 1
• uwaterloo.ca: 1
• tiger-222.fr: 1
• mindspring.com: 1
• mail.com: 1
• sheffield.ac.uk: 1
• tutamail.com: 1
• iress.com: 1
• astro.uio.no: 1
• riseup.net: 1
• uva.nl: 1
• iszf.irk.ru: 1
• umn.edu: 1
• pauljwright.co.uk: 1
• njit.edu: 1
• comcast.net: 1
• fasteroute.com: 1
• suse.de: 1
• daniel-williams.co.uk: 1
• khu.ac.kr: 1
• northumbria.ac.uk: 1
• aip.de: 1
• tty.sk: 1
• umich.edu: 1
• ph.iitr.ac.in: 1
• cadair.com: 1

---

Issue and Pull Request metadata

Last synced: 2 days ago

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

---

---

---

Package metadata

• Total packages: 3
• Total downloads:
  • conda: 2,551,405 total
  • pypi: 87,097 last-month
• Total docker downloads: 90
• Total dependent packages: 45 (may contain duplicates)
• Total dependent repositories: 105 (may contain duplicates)
• Total versions: 427
• Total maintainers: 4

---

Dependencies

Score: 27.51414541090046