README.rst

sunpy

sunpy is a Python software package that provides fundamental tools for accessing, loading and interacting with solar physics data in Python. It is the core library of the SunPy 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 miniforge. To install sunpy once miniforge is installed run the following command:

$ conda install sunpy

For detailed installation instructions, see the installation guide 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
>>>
>>> import matplotlib.pyplot as plt
>>>
>>> aia = sunpy.map.Map(AIA_171_IMAGE)
>>>
>>> aia.plot()
>>>
>>> plt.show()

Getting Help

For more information or to ask questions about sunpy or any other SunPy library, check out:

• sunpy documentation
• 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

If you would like to get involved, start by joining the SunPy Chat and check out our Newcomers' guide. This will walk you through getting set up for contributing.

Code of Conduct

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