Topic Guides

These topic guides provide a set of in-depth explanations for various parts of the sunpy core package. They assumes you have some knowledge of what sunpy is and how it works - if you’re starting fresh you might want to check out the The sunpy tutorial first.

How to use the topic guides

The topic guides are designed to be read in a standalone manner, without running code at the same time. Although there are code snippets in various parts of each topic guide, these are present to help explanation, and are not structured in a way that they can be run as you are reading a topic guide.

• Coordinates
  • Calculating Carrington longitude
  • Differential rotation using coordinate frames
  • Coordinates with velocity information
  • Coordinates and WCS
  • The role of rsun in coordinate transformations
  • Design of the Coordinates Sub-Package
• Add a new rotation method to Map
• Deprecation, Versioning and Release Practices
  • Versioning Policy
  • Release Practices
  • Python and Package Support Policies
  • Deprecation Policy and Breaking Changes
• Adding new data sources to Fido
  • An explanation of how “scraper” clients work
  • Writing a new “scraper” client
  • Writing a “full” client
• Migrating to the new Scraper pattern system in sunpy 6.1
  • How to migrate
• How “HISTORY” and “COMMENT” FITS Keys are Handled in sunpy
• Advanced Installation
  • conda
  • pip
• Logging system
  • Overview
  • Configuring the logging system
  • Context managers
• Writing a new instrument Map class
• A Detailed Look at the TimeSeries Metadata
• The role of “rsun” in sunpy
  • Transforming between Helioprojective frames
  • Reprojecting between frames with different “rsun”