SunPy net

sunpy.net Package

Classes

HelioviewerClient([url]) Helioviewer.org Client

Class Inheritance Diagram

Inheritance diagram of sunpy.net.helioviewer.HelioviewerClient

sunpy.net.vso Package

Classes

VSOClient([url, port, api]) Main VSO Client.
InteractiveVSOClient([url, port, api]) Client for use in the REPL.

Class Inheritance Diagram

Inheritance diagram of sunpy.net.vso.vso.VSOClient, sunpy.net.vso.vso.InteractiveVSOClient

sunpy.net.vso.attrs Module

Attributes that can be used to construct VSO queries. Attributes are the fundamental building blocks of queries that, together with the two operations of AND and OR (and in some rare cases XOR) can be used to construct complex queries. Most attributes can only be used once in an AND-expression, if you still attempt to do so it is called a collision, for a quick example think about how the system should handle Instrument(‘aia’) & Instrument(‘eit’).

Classes

Wave(wavemin, wavemax)
Time(start[, end, near]) Specify the time range of the query.
Extent(x, y, width, length, atype)
Field(fielditem)
Provider(value)
Source(value)
Instrument(value)
Physobs(value)
Pixels(value)
Level(value)
Resolution(value)
Detector(value)
Filter(value)
Sample(value) Time interval for data sampling.
Quicklook(value)
PScale(value)

Class Inheritance Diagram

Inheritance diagram of sunpy.net.vso.attrs.Wave, sunpy.net.vso.attrs.Time, sunpy.net.vso.attrs.Extent, sunpy.net.vso.attrs.Field, sunpy.net.vso.attrs.Provider, sunpy.net.vso.attrs.Source, sunpy.net.vso.attrs.Instrument, sunpy.net.vso.attrs.Physobs, sunpy.net.vso.attrs.Pixels, sunpy.net.vso.attrs.Level, sunpy.net.vso.attrs.Resolution, sunpy.net.vso.attrs.Detector, sunpy.net.vso.attrs.Filter, sunpy.net.vso.attrs.Sample, sunpy.net.vso.attrs.Quicklook, sunpy.net.vso.attrs.PScale

sunpy.net.hek Package

Classes

HEKClient([url]) Client to interact with the Heliophysics Event Knowledgebase (HEK).

Class Inheritance Diagram

Inheritance diagram of sunpy.net.hek.hek.HEKClient

sunpy.net.hek2vso Package

This module provides a translation layer between the HEK and the VSO. It allows you to acquire records of data that are available via the VSO, based on the data in HEK event entries.

Warning

This module is in beta and maybe unstable.

Functions

translate_results_to_query(results) Formulate VSO queries from HEK results.
vso_attribute_parse(phrase) Parses VSO attributes from a HEK result.

Classes

H2VClient() Class to handle HEK to VSO translations

Class Inheritance Diagram

Inheritance diagram of sunpy.net.hek2vso.hek2vso.H2VClient

sunpy.net.helio Package

A Module for accessing the HELIO web service

Warning

This module is still in beta and may be unstable

sunpy.net.helio.hec Module

Access the Helio Event Catalogue

Classes

HECClient([link]) A client class used to interface with and query HELIO webservices.

Class Inheritance Diagram

Inheritance diagram of sunpy.net.helio.hec.HECClient

sunpy.net.jsoc Package

Classes

Compression(value) Compression format for requested files.
JSOCClient This is a Client to the JSOC Data Export service.
JSOCResponse([table]) table : astropy.table.Table
Notify(value) An email address to get a notification to when JSOC has staged your request
Protocol(value) The type of download to request one of (“FITS”, “JPEG”, “MPG”, “MP4”, or “as-is”).
Sample(value) Time interval for data sampling.
Segment(value) Segments choose which files to download when there are more than one present for each record e.g.
Series(value) The JSOC Series to Download.
Time(start[, end, near]) Specify the time range of the query.
Wavelength(value) Wavelength or list of wavelengths to download.

Class Inheritance Diagram

Inheritance diagram of sunpy.net.jsoc.attrs.Compression, sunpy.net.jsoc.jsoc.JSOCClient, sunpy.net.jsoc.jsoc.JSOCResponse, sunpy.net.jsoc.attrs.Notify, sunpy.net.jsoc.attrs.Protocol, sunpy.net.jsoc.attrs.Sample, sunpy.net.jsoc.attrs.Segment, sunpy.net.jsoc.attrs.Series, sunpy.net.jsoc.attrs.Time, sunpy.net.jsoc.attrs.Wavelength