Speasy utils

speasy - an open source Python client for Space Physics web services such as CDAWEB or AMDA.

Functions

---

spzvars2pldf

 spzvars2pldf (vars:list[speasy.products.variable.SpeasyVariable])

---

spzvar2pldf

 spzvar2pldf (var:speasy.products.variable.SpeasyVariable)

---

get_time_resolution

 get_time_resolution (data:speasy.products.variable.SpeasyVariable)

---

get_parameter_index

 get_parameter_index (param:str, ds:str)

---

get_dataset_parameters

 get_dataset_parameters (v:str, provider:str='cda')

---

get_dataset_index

 get_dataset_index (v:str, provider:str='cda')

---

get_provider

 get_provider (v:str)

---

SpeasyVariable.preview

 SpeasyVariable.preview ()

Data Classes

Based on SpeasyVariable class from speasy.

---

Variable

 Variable (name:str=None, description:str=None, unit:str=None,
           timerange:list[datetime.datetime]=None)

---

Variable.dump

 Variable.dump (path:str)

Dump the configuration to a file.

---

Variable.plot

 Variable.plot (fig=None, ax:matplotlib.axes._axes.Axes=None)

---

SVariables

 SVariables ()

Initialize self. See help(type(self)) for accurate signature.

---

Variables

 Variables (timerange:list[datetime.datetime]=None,
            variables:list[__main__.Variable]=None,
            parameters:list[str]=None, dataset:str=None,
            provider:str='cda', products:list[str|speasy.core.inventory.in
            dexes.ParameterIndex]=None)

earth_start = "2019-04-09"
earth_end = "2019-04-12"
timerange = [earth_start, earth_end]

d = spz.get_data(
    get_parameter_index("MOM.P.MAGF", "WI_PLSP_3DP"),
    timerange,
)

Test

timerange = ["2019-04-07T01:00", "2019-04-07T12:00"]
vars = Variables(
    dataset="PSP_FLD_L2_MAG_RTN",
    parameters=["psp_fld_l2_mag_RTN"],
    timerange=timerange,
)

def data_provider_summary(data_provider: DataProvider = spz.cda):
    # show the name of the data_provider, the number of datasets, parameters and catalogs

    inventory = data_provider.flat_inventory
    print("Data Provider:", data_provider.provider_name)
    print("Datasets:", len(inventory.datasets))
    print("Parameters:", len(inventory.parameters))
    print("Catalogs:", len(inventory.catalogs))


# data_provider_summary(spz.cda)
# data_provider_summary(spz.amda)
# data_provider_summary(spz.csa)

Data Provider: cda
Datasets: 2608
Parameters: 58510
Catalogs: 0
Data Provider: amda
Datasets: 1074
Parameters: 5397
Catalogs: 24
Data Provider: csa
Datasets: 912
Parameters: 1993
Catalogs: 0