Installation

Below are instructions for installing SunPy and its prerequisites on different platforms.

Installing Scientific Python

For instructions on setting up the scientific Python environment which is required by SunPy, choose your OS from the list below. When you are done come back here and follow the instructions below to install SunPy and its requirements.

Anaconda

Alternatively, available for all platforms is Anaconda, a scientific Python distribution that is available free of charge from https://store.continuum.io/cshop/anaconda/. It comes with a complete build environment so you will not need to worry about installing a compiler or likewise.

Head to the download page, install it and you are set. It can also be installed into your user directory without administrator permissions; be sure to use the Anaconda versions of the commands in the following listings if you have multiple Python environments installed.

Installing Python Modules

Making sure to have followed one of the guides previously. You will have installed on your system: Python, Numpy, Scipy, Matplotlib, git, pip and Qt. There are few more remaining dependencies which must be installed using pip. Depending on which system you are using some of these may already be installed but it does not hurt to upgrade:

pip install --upgrade distribute
pip install --upgrade pyfits
pip install --upgrade suds
pip install --upgrade pandas
pip install --upgrade beautifulsoup4

We also recommend you use ipython (a great python enviromnent). This can also be installed using pip:

pip install --upgrade ipython

All done with the SunPy Python prerequisites. You are now ready to install SunPy itself.

Installing SunPy

There are two different versions of SunPy. Currently, we recommend that users install the latest stable release. However, the bleeding edge version on our GitHub page is quite easy to install and you do get the latest and greatest but it may have bugs. Depending on your setup, you may need to preface each of the pip ... commands with sudo pip ....

Grabbing the stable SunPy

It is as simple as this:

pip install sunpy

If you are upgrading the package:

pip install --upgrade sunpy

For those who like to download the source. You have a range of download locations.

PyPi: Download

Github (tar.gz): Download

Github (zip): Download

Then you can use:

pip install ./<path to download>/SunPyDownload.file_extension

In some cases you may need the --no-deps flag if pip is trying to upgrade dependencies such as SciPy and Matplotlib that are difficult to build from source and the likely errors will abort the upgrade. That’s it folks!

Grabbing the latest SunPy

If you do fancy the latest version of SunPy. Then you will want to cd into directory you want to have SunPy located and now:

git clone [email protected]:sunpy/sunpy.git

or using HTTP:

git clone http://github.com/sunpy/sunpy.git

This will download the SunPy repository and create a sunpy folder at the current location. With time, updates will happen and you can update your local copy by:

git pull upstream master

Finally, to install or upgrade the local version of SunPy you can run:

python setup.py install --upgrade

Testing your installation

Now you can test your installation. Open a new Python shell and type these commands:

>>> import sunpy
>>> sunpy.Map(sunpy.AIA_171_IMAGE).peek()

If all goes well you should see an AIA 171 image on your screen.

Contributing to SunPy

If you are considering contributing to the development of SunPy and please do consider it. Please see Developer’s Guide Overview as it will explain everything required to start contributing.

Read the Docs v: v0.3.2
Versions
stable
latest
v0.3.2
v0.3.1
v0.3.0
0.2.0
v0.1
Downloads
PDF
HTML
Epub
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.