Skip to main content

A sunpy FIDO plugin for accessing data in the Solar Orbiter Archive (SOAR).

Project description

CI status Code coverage

A sunpy Fido plugin for accessing data in the Solar Orbiter Archive (SOAR).

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 usage

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sunpy-soar-1.9.tar.gz (23.7 kB view details)

Uploaded Source

Built Distribution

sunpy_soar-1.9-py3-none-any.whl (15.3 kB view details)

Uploaded Python 3

File details

Details for the file sunpy-soar-1.9.tar.gz.

File metadata

  • Download URL: sunpy-soar-1.9.tar.gz
  • Upload date:
  • Size: 23.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for sunpy-soar-1.9.tar.gz
Algorithm Hash digest
SHA256 256ed51f4b55ffb8dbb2c923932b90a060d815e147231e6f30f2eb333f0f87a9
MD5 7d0e2aceb1dee850af881159af3686b9
BLAKE2b-256 3c3fc2a310b6bec5f6ec9bbfe63feb3f1e021526faa3e47c63322f575e20468f

See more details on using hashes here.

File details

Details for the file sunpy_soar-1.9-py3-none-any.whl.

File metadata

  • Download URL: sunpy_soar-1.9-py3-none-any.whl
  • Upload date:
  • Size: 15.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for sunpy_soar-1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 ac22d858c31413e43274e86cef895a3c9b421bafc067a1bdfa37759148391d56
MD5 84615c1f4712fa81893b099068aaccca
BLAKE2b-256 e0aa1f643f5e7a71ea374e3ef04c60a55be1dd090f0e972a8212e4c8754c6f05

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page