`sunpy-soar` Documentation#

This is the documentation for sunpy-soar.

Full Changelog

Installation#

sunpy-soar requires python >= 3.9 and sunpy >= 5.0. Currently it can only be installed from PyPI using:

pip install sunpy-soar

or conda using

conda install -c conda-forge sunpy-soar

Example#

The code below gives an example of how to search and download Solar Orbiter data using sunpy.net.Fido:

# Importing sunpy_soar registers the client with sunpy
>>> import sunpy_soar
>>> from sunpy.net import Fido
>>> import sunpy.net.attrs as a

# Create search attributes
>>> instrument = a.Instrument('EUI')
>>> time = a.Time('2021-02-01', '2021-02-02')
>>> level = a.Level(1)
>>> product = a.soar.Product('EUI-FSI174-IMAGE')

# Do search
>>> result = Fido.search(instrument & time & level & product)
>>> print(result)

# Download files
>>> files = Fido.fetch(result)
>>> print(files)

Available search attributes#

The easiest way to access search attributes is using import sunpy.net.attrs as a. When constructing a search for SOAR a.Time must be provided. Other search attributes can be used too - sunpy-soar recognises the following:

a.Instrument
a.Level - one of L0, L1, L2, L3, LL01, LL02, LL03
a.soar.Product

The third near argument to a.Time is not currently supported - you will have to manually filter the results if you want to find the one closest to a given time.

`sunpy-soar` and the VSO#

sunpy-soar queries the official repository of Solar Orbiter data, the SOAR. The Virtual Solar Observatory (VSO) as of writing (September 2022) mirrors a subset of the Solar Orbiter archive alongside many other solar physics data sources. The VSO allows data from multiple missions/observatories to be easily queried in one go, but users should be aware that the VSO is not the official repository for Solar Orbiter data and does not currently (as of September 2022) provide a comprehensive listing of all available Solar Orbiter data.

Getting Help#

For more information or to ask questions about sunpy-soar or any other SunPy library, check out:

Contributing#

If you would like to get involved, start by joining the SunPy Chat and check out our Newcomers’ guide. This will walk you through getting set up for contributing.

Code of Conduct#

When you are interacting with the SunPy community you are asked to follow our Code of Conduct.

Reference/API#

sunpy_soar Package#

Classes#

`SOARClient`()	Client to access the Solar Orbiter Archive (SOAR).
`Product`(value)	The data product descriptor to search for.
`SOOP`(value)	The SOOP name to search for.

sunpy-soar Documentation#