SunPy timeseries


One of the core classes in SunPy is a timeseries. A number of instruments are supported through subclasses of the base GenericTimeSeries class. To see Instrument TimeSeries Classes for a list of all of them.

Creating a TimeSeries

TimeSeries can either be created manually or from source files using the factory. To create a custom GenericTimeSeries see the example in the class documentation below. Subclasses of GenericTimeSeries for specific instruments provide their own methods for opening files for their data. For more information see Instrument TimeSeries Classes.

Instrument TimeSeries Classes

The generic method to create an instrument-specific TimeSeries is to call the TimeSeries factory on a file from that dataset and pass the source keyword argument. Some sources use FITS files and these may define the source class themselves, in this case the TimeSeries factory can determine the source implicitly, but it’s good practice to explicitly state it. The following example shows the factory loading a sample file:

>>> import sunpy.timeseries as ts
>>> import  
>>> goes = ts.TimeSeries(, source='XRS')  

The TimeSeries factory will load the file and create the timeseries instance. The following instrument classes are supported.

sunpy.timeseries Package


TimeSeriesMetaData([meta, timerange, colnames])

Used to store metadata for TimeSeries that enables multiple sunpy.timeseries.TimeSeries metadata to be concatenated in an organized fashion.

GenericTimeSeries(data[, meta, units])

A generic time series object.



A factory for generating solar timeseries objects.

sunpy.timeseries.sources Package

This module provies a collection of datasource-specific TimeSeries classes.

Each mission should have its own file with one or more classes defined. Typically, these classes will be subclasses of the sunpy.timeseries.TimeSeries.


ESPTimeSeries(data[, meta, units])

SDO EVE/ESP Level 1 data.

EVESpWxTimeSeries(data[, meta, units])

SDO EVE LightCurve for level 0CS data.

GBMSummaryTimeSeries(data[, meta, units])

Fermi/GBM Summary lightcurve TimeSeries.

LYRATimeSeries(data[, meta, units])

Proba-2 LYRA Lightcurve TimeSeries.

NOAAIndicesTimeSeries(data[, meta, units])

NOAA Solar Cycle monthly indices.

NOAAPredictIndicesTimeSeries(data[, meta, units])

NOAA Solar Cycle Predicted Progression.

NoRHTimeSeries(data, header, units, **kwargs)

Nobeyama Radioheliograph Correlation lightcurve TimeSeries.

RHESSISummaryTimeSeries(data[, meta, units])

RHESSI X-ray Summary lightcurve TimeSeries.

XRSTimeSeries(data[, meta, units])

GOES XRS Time Series.

Class Inheritance Diagram

Inheritance diagram of sunpy.timeseries.sources.eve.ESPTimeSeries, sunpy.timeseries.sources.eve.EVESpWxTimeSeries, sunpy.timeseries.sources.fermi_gbm.GBMSummaryTimeSeries, sunpy.timeseries.sources.lyra.LYRATimeSeries, sunpy.timeseries.sources.noaa.NOAAIndicesTimeSeries, sunpy.timeseries.sources.noaa.NOAAPredictIndicesTimeSeries, sunpy.timeseries.sources.norh.NoRHTimeSeries, sunpy.timeseries.sources.rhessi.RHESSISummaryTimeSeries, sunpy.timeseries.sources.goes.XRSTimeSeries