aidapy.aidafunc.load_data module

Loading data functions

This script contains the function load_data needed to make the interface with the user and also the associated functions for the check.

This file can be imported as a module and contains the following functions:

aidapy.aidafunc.load_data.get_mission_info(mission='mission', start_time=None, end_time=None, product=None, full_product_catalog=False, hide=False)[source]

Provide information on the mission

Parameters

  • mission (str) – The name of the mission from which the data are loaded/downloaded

  • start_time (datetime or Time) – Start time of the loading

  • end_time (datetime or Time) – End time of the loading

  • product (str) – Data product to look for in product_catalog

  • full_product_catalog (bool) – Tag to provide all available keys

  • hide (bool) – Tag to hide print messages when use in routines

Returns

info – String containing the AIDApy keyword of the queried product or Dictionary with information on the mission or queried product with the following keys: - name: - allowed_probes: - product_catalog:

Return type

dict or str

aidapy.aidafunc.load_data.load_data(mission, start_time, end_time, **kwargs)[source]

Load the data from the given mission on a specific time interface. The extra arguments gives details on the data to load.

Parameters

  • mission (str) – The name of the mission from which the data are loaded/downloaded

  • start_time (datetime or Time) – Start time of the loading

  • end_time (datetime or Time) – End time of the loading

  • **kwargs – Specific arguments for providing information for the mission or the download settings: - prod: high-level product to load. Can be a string or a list. The full list is available by using the get_mission_info() routine. - probes: probe number. Can be a string or a list. - coords: coordinate system to use. - mode: mode to define the data rate. Usually it can be either ‘low_res’ or ‘high_res’. The user can also specify a mode specific to a mission (for instance for MMS : ‘slow’, ‘fast’, ‘brst’, ‘srvy’) The list for these specific modes (or data_rate) can be found in the heliopy documentation. https://docs.heliopy.org/en/stable/reference/data/index.html - frame: frame used only for spacecraft attitude. Usually ‘dbcs’ Example: {‘prod’: [‘dc_mag’], ‘probes’: [‘1’, ‘2’], ‘coords’: ‘gse’, ‘mode’: ‘high_res’}

Returns

xarray_mission – Requested data contained within a xarray DataSet. Each data variable contains a specific product of a specific probe

Return type

DataSet