/sunpy

SunPy - Python for Solar Physics

Primary LanguagePythonBSD 2-Clause "Simplified" LicenseBSD-2-Clause

SunPy

Latest Version codecov matrix Research software impact DOI Powered by NumFOCUS

SunPy is an open-source Python library for Solar Physics data analysis and visualization. Our homepage SunPy has more information about the project.

For some examples of using SunPy see our gallery, to see the latest changes in SunPy see our Changelog.

Installation

The recommended way to install SunPy is with miniconda. To install SunPy once conda is installed run the following two commands:

$ conda config --append channels conda-forge
$ conda install sunpy

For detailed installation instructions, see the installation guide in the SunPy docs.

Developing

If you want to develop SunPy you will need to install from GitHub. For detailed installation instructions, see Development installation in the SunPy docs.

Usage

Here is a quick example of plotting an AIA image:

>>> import sunpy.map
>>> from sunpy.data.sample import AIA_171_IMAGE
>>> aia = sunpy.map.Map(AIA_171_IMAGE)
>>> aia.peek()

Getting Help

For more information or to ask questions about SunPy, check out:

Acknowledging or Citing sunpy

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

Please see https://sunpy.org/about#acknowledging-or-citing-sunpy on how to do this.

Contributing

Open Source Helpers

If you would like to get involved, start by joining the SunPy mailing list and 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.

Code of Conduct

When you are interacting with the SunPy community you are asked to follow our Code of Conduct.