SOARClient#

class sunpy_soar.SOARClient[source]#

Bases: BaseClient

Provides access to Solar Orbiter Archive (SOAR) which provides data for Solar Orbiter.

References

Methods Summary

add_join_to_query(query, data_table, ...)

Construct the WHERE, FROM, and SELECT parts of the ADQL query.

fetch(query_results, *, path, downloader, ...)

Queue a set of results to be downloaded.

load_dataset_values()

Loads the net attribute values from the JSON file.

register_values()

Register the SOAR specific attributes with Fido.

search(*query, **kwargs)

Query this client for a list of results.

Methods Documentation

static add_join_to_query(
query: list[str],
data_table: str,
instrument_table: str,
)[source]#

Construct the WHERE, FROM, and SELECT parts of the ADQL query.

Parameters:

  • query (list[str]) – List of query items.

  • data_table (str) – Name of the data table.

  • instrument_table (str) – Name of the instrument table.

Returns:

tuple[str, str, str] – WHERE, FROM, and SELECT parts of the query.

fetch(query_results, *, path, downloader, **kwargs) → None[source]#

Queue a set of results to be downloaded. sunpy.net.base_client.BaseClient does the actual downloading, so we just have to queue up the downloader.

Parameters:

  • query_results (sunpy.net.fido_factory.UnifiedResponse) – Results from a Fido search.

  • path (str) – Path to download files to. Must be a format string with a file field for the filename.

  • downloader (parfive.Downloader) – Downloader instance used to download data.

  • kwargs – Keyword arguments aren’t used by this client.

static load_dataset_values()[source]#

Loads the net attribute values from the JSON file.

Returns:

dict – The dictionary containing the values formed into attributes.

classmethod register_values()[source]#

Register the SOAR specific attributes with Fido.

Returns:

dict – The dictionary containing the values formed into attributes.

search(*query, **kwargs)[source]#

Query this client for a list of results.

Parameters:

  • *args (tuple) – sunpy.net.attrs objects representing the query.

  • **kwargs (dict) – Any extra keywords to refine the search. Unused by this client.

Returns:

A QueryResponseTable instance containing the query result.