SunPy

SunPy: A Python package for Solar Physics - Published in JOSS (2020)

https://github.com/sunpy/sunpy

Keywords

Keywords from Contributors

Scientific Fields

Repository

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

Owner

JOSS Publication

SunPy: A Python package for Solar Physics

Published

February 14, 2020

DOI

10.21105/joss.01832

Volume 5, Issue 46, Page 1832

Authors

Stuart J. Mumford
SP2RC, School of Mathematics and Statistics, The University of Sheffield, UK, National Solar Observatory, 3665 Discovery Drive, Boulder, CO 80303, Aperio Software Ltd., Headingley Enterprise and Arts Centre, Bennett Road, Leeds LS6 3HN

Nabil Freij
Institute for Environmental Analytics, University of Reading, Reading RG6 6BX

Steven Christe
NASA Goddard Space Flight Center, Greenbelt, MD 20771, USA

Jack Ireland
NASA Goddard Space Flight Center, Greenbelt, MD 20771, USA

Florian Mayer
None

V. Keith Hughitt
Center for Cancer Research, National Cancer Institute, Bethesda, MD 20892-9760, USA

Albert Y. Shih
NASA Goddard Space Flight Center, Greenbelt, MD 20771, USA

Daniel F. Ryan
American University, Washington, DC 20016, USA, NASA Goddard Space Flight Center, Greenbelt, MD 20771, USA

Simon Liedtke
None

David Pérez-Suárez
University College London, Gower Street, London, UK

Pritish Chakraborty
Manav Rachna University

Vishnunarayan K
None

Andrew Inglis
Catholic University of America / NASA Goddard Space Flight Center, Greenbelt, MD 20771, USA

Punyaslok Pattnaik
International Institute of Information Technology, Hyderabad 500 032, India

Brigitta Sipőcz
DIRAC Institute, Department of Astronomy, University of Washington, Seattle, WA 98195, USA

Rishabh Sharma
None

Andrew Leonard
Aperio Software Ltd., Headingley Enterprise and Arts Centre, Bennett Road, Leeds LS6 3HN

David Stansby
Mullard Space Science Laboratory, University College London, Surrey, UK

Russell Hewett
Department of Mathematics, Virginia Polytechnic Institute and State University, Blacksburg, VA 24061-0123, USA

Alex Hamilton
None

Laura Hayes
NASA Goddard Space Flight Center, Greenbelt, MD 20771, USA

Asish Panda
None

Matt Earnshaw
None

Nitin Choudhary
Department of Mathematics, Indian Institute of Technology, Kharagpur, 721302, India

Ankit Kumar
None

Prateek Chanda
Department of Computer Science & Technology, Indian Institute of Engineering Science & Technology, Shibpur, 711103, India

Md Akramul Haque
Department of Mechanical Engineering, ZHCET, Aligarh Muslim University, Aligarh, India

Michael S. Kirk
Catholic University of America / NASA Goddard Space Flight Center, Greenbelt, MD 20771, USA

Michael Mueller
None

Sudarshan Konge
None

Rajul Srivastava
None

Yash Jain
Indian Institute of Technology, Kharagpur, 721302, India

Samuel Bennett
None

Ankit Baruah
None

Will Barnes
Lockheed Martin Solar and Astrophysics Laboratory / Bay Area Environmental Research Institute

Michael Charlton
None

Shane Maloney
Trinity College Dublin / Dublin Institute for Advanced Studies

Nicky Chorley
Centre for Fusion, Space and Astrophysics, Physics Department, University of Warwick, Coventry CV4 7AL, United Kingdom

Himanshu
None

Sanskar Modi
None

James Paul Mason
None

Naman9639
None

Jose Ivan Campos Rozo
Institut für Physik/IGAM - Karl-Franzens University of Graz, Austria

Larry Manley
None

Agneet Chatterjee
Jadavpur University, Kolkata

John Evans
None

Michael Malocha
None

Monica G. Bobra
W.W. Hansen Experimental Physics Laboratory, Stanford University, Stanford, CA 94305, USA

Sourav Ghosh
Jadavpur University, Kolkata

Airmansmith97
None

Dominik Stańczak
University of Warsaw

Ruben De Visscher
None

Shresth Verma
ABV-Indian Institute of Information Technology and Management, Gwalior, MP 474015, India

Ankit Agrawal
None

Dumindu Buddhika
None

Swapnil Sharma
None

Jongyeob Park
Space Science Division, Korea Astronomy and Space Science Institute, Daejeon 34055, South Korea

Matt Bates
None

Dhruv Goel
None

Garrison Taylor
Harvard-Smithsonian Center for Astrophysics, Cambridge, MA 02138, USA

Goran Cetusic
None

Jacob
None

Mateo Inchaurrandieta
None

Sally Dacie
Mullard Space Science Laboratory, University College London, Holmbury St. Mary, Surrey, RH5 6NT, UK

Sanjeev Dubey
None

Deepankar Sharma
None

Erik M. Bray
None

Jai Ram Rideout
Dogfox Software LLC, Flagstaff, AZ 86001, USA

Serge Zahniy
NASA Goddard Space Flight Center, Greenbelt, MD 20771, USA

Tomas Meszaros
None

Abhigyan Bose
None

André Chicrala
Northumbria University, England

Ankit
None

Chloé Guennou
None

Daniel D'Avella
None

Daniel Williams
SUPA, University of Glasgow, Glasgow G12 8QQ, United Kingdom

Jordan Ballew
None

Nick Murphy
Center for Astrophysics | Harvard & Smithsonian

Priyank Lodha
None

Thomas Robitaille
None

Yash Krishan
None

Andrew Hill
None

Arthur Eigenbrot
National Solar Observatory

Benjamin Mampaey
Royal Observatory of Belgium

Bernhard M. Wiedemann
None

Carlos Molina
None

Duygu Keşkek
None

Ishtyaq Habib
None

Joseph Letts
None

Juanjo Bazán
CIEMAT, Astroparticle physics, Madrid, Spain.

Quinn Arbolante
Lockheed Martin Solar and Astrophysics Laboratory

Reid Gomillion
None

Yash Kothari
None

Yash Sharma
None

Abigail L. Stevens
Department of Physics & Astronomy, Michigan State University, 567 Wilson Road, East Lansing, MI 48824, USA, Department of Astronomy, University of Michigan, 1085 South University Avenue, Ann Arbor, MI 48109, USA

Adrian Price-Whelan
Center for Computational Astrophysics, Flatiron Institute, 162 Fifth Ave, New York, NY 10010, USA

Ambar Mehrotra
None

Arseniy Kustov
None

Brandon Stone
None

Trung Kien nil Dang
Saw Swee Hock School of Public Health, National University Health System, National University of Singapore, Singapore

Emmanuel Arias
None

Fionnlagh Mackenzie Dover
SP2RC, School of Mathematics and Statistics, The University of Sheffield, UK

Freek Verstringe
Royal Observatory of Belgium

Gulshan Kumar
International Institute of Information Technology, Hyderabad

Harsh Mathur
Indian Institute of Astrophysics, Bangalore

Igor Babuschkin
None

Jaylen Wimbish
None

Juan Camilo Buitrago-Casas
None

Kalpesh Krishna
University of Massachusetts, Amherst

Kaustubh Hiware
Indian Institute of Technology, Kharagpur

Manas Mangaonkar
None

Matthew Mendero
None

Mickaël Schoentgen
None

Norbert G. Gyenge
SP2RC, School of Mathematics and Statistics, University of Sheffield, Sheffield, S3 7RH, UK

Ole Streicher
Leibniz Institute for Astrophysics Potsdam, Germany

Rajasekhar Reddy Mekala
None

Rishabh Mishra
None

Shashank Srikanth
International Institute of Information Technology, Hyderabad

Sarthak Jain
None

Tannmay Yadav
Department of Chemical Engineering, Indian Institute of Technology Kharagpur, 721302, India

Tessa D. Wilkinson
None

Tiago M. d. Pereira
Rosseland Centre for Solar Physics, University of Oslo, P.O. Box 1029 Blindern, NO-0315 Oslo, Norway, Institute of Theoretical Astrophysics, University of Oslo, P.O. Box 1029 Blindern, NO-0315 Oslo, Norway

Yudhik Agrawal
International Institute of Information Technology, Hyderabad 500 032, India

Jamescalixto
None

Yasintoda
None

Sophie A. Murray
Trinity College Dublin, Ireland

Editor

Arfon Smith

Tags

Astronomy Solar physics

View PDF Review Thread Software Archive

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

Committers

Last synced: 5 months ago

Issues and Pull Requests

Last synced: 4 months ago

Packages