mirca / sunpy

SunPy - Python for Solar Physics

SunPy

SunPy is an open-source Python library for solar physics data analysis. See sunpy.org for more information about the project.

For some examples of using SunPy see our gallery.

Installation

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

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

If you want to develop SunPy you will need to install from git. The best way to do this is to create a new conda environment and install the git version of SunPy in it:

$ conda config --append channels conda-forge
$ conda create -n sunpy-dev python sunpy hypothesis pytest-mock
$ source activate sunpy-dev
$ conda remove sunpy
$ git clone https://github.com/sunpy/sunpy.git sunpy-git
$ cd sunpy-git
$ pip install -e .

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
>>> aia = sunpy.map.Map(AIA_171_IMAGE)
>>> aia.peek()

Getting Help

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

• SunPy Documentation
• SunPy Mailing List
• SunPy Matrix Channel

Contributing

If you would like to get involved, start by joining the SunPy mailing list and check out the Developer's Guide section of the SunPy docs. Stop by our IRC chat room named #sunpy on irc.freenode.net 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 a list of some known outstanding items.

Code of Conduct

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