User’s Guide

Welcome to the user guide for SunPy. SunPy is a community-developed, free and open-source solar data analysis environment. It is meant to provide the core functionality and tools to analyze solar data with Python. This guide provides a walkthrough of the major features in SunPy. For more details checkout the Code Reference.

• Installation
  • Requirements
  • Installing Scientific Python and sunpy
    • Installing sunpy using Miniconda
    • Updating sunpy
  • Advanced sunpy Installation
    • Advanced Installation Instructions
    • Testing sunpy
    • sunpy’s Requirements
• Brief Tour
  • Sample Data
  • Maps
  • TimeSeries
  • Plotting
  • Solar Physical Constants
  • Quantities and Units
  • Working with Times
  • Obtaining Data
  • Database Package
• Data Acquisition
  • Downloading Sample Data
  • Finding and Downloading Data using Fido
    • Import
    • Search Attributes
    • Searching for Data Using Fido
    • Indexing search results
    • Downloading data
    • Fido Clients
  • Querying and Downloading Data from JSOC
    • Setup
    • Querying the JSOC
    • Downloading data
    • Using JSOCClient for complex usage
  • Using SunPy’s HEK module
    • 1. Setting up the client
    • 2. A simple query
    • 3. The result
    • 4. More complex queries
    • 5. Getting data for your event
  • Querying Helioviewer.org with SunPy
  • Using the database package
    • 1. Connecting and initializing the database
    • 2. Adding new entries
    • 3. Displaying entries in a table
    • 4. Removing entries
    • 5. Editing entries
    • 6. Undoing and redoing operations
    • 7. Querying the database
    • 8. Caching
• Data Types
  • Maps
    • Creating maps
    • Creating Custom Maps
    • Inspecting maps
    • Getting at the data
    • Plotting
    • Masking and Clipping Data
    • Composite Maps and Overlaying Maps
    • Working with your map
    • MapSequences
    • Coalignment of MapSequences
    • Compensating for solar rotation in MapSequences
  • TimeSeries
    • 1. Creating a TimeSeries from an observational data source
    • 1.1 Creating a Single TimeSeries from Multiple Files
    • 2. Creating Custom TimeSeries
    • 2.1 Creating a TimeSeries from a Pandas DataFrame
    • 2.2 Creating Custom TimeSeries from an Astropy Table
    • 3. Inspecting TimeSeries & Getting at the Data
    • 4. Plotting
    • 5 Manipulating TimeSeries
    • 5.1 Modifying the Data
    • 5.2 Truncating a TimeSeries
    • 5.3 Down and Up Sampling a TimeSeries Using Pandas
    • 5.4 Concatenating TimeSeries
    • 5.5 Creating an Astropy Table from a TimeSeries
    • 6. A Detailed Look at the Metadata
• Plotting
  • 1. Matplotlib Tutorial
  • 2. Pyplot
  • 3. Advanced Pyplot
  • 4. SunPy Plotting Convention
  • 4.1 peek()
  • 4.2 plot()
  • Plotting Maps with wcsaxes
• Units and Coordinates
  • Units in SunPy
  • Quantities as function arguments
  • Physical Coordinates in SunPy
    • Observer Location
    • Using Coordinates with SunPy Map
• Time
  • 1. Parsing Times
    • Strings
    • Other formats
    • astropy.time.Time API comparision
  • 2. Time Ranges
• Regions of Interest
  • 1. Creating an ROI
• Customizing SunPy
  • The sunpyrc file
  • Dynamic settings
    • A sample sunpyrc file
• Logging system
  • Overview
  • Configuring the logging system
  • Context managers
• SSWIDL/SunPy Cheat Sheet
• Troubleshooting and Bugs
  • Obtaining sunpy version
  • System Info
  • sunpy install location
  • .sunpy directory location
  • Reporting Bugs