speasy.data_providers.amda.ws module

class speasy.data_providers.amda.ws.AmdaWebservice[source]

Bases: ImpexProvider

get_catalog(catalog_id: str, **kwargs) → Catalog | None[source]

Get catalog data by ID.

Parameters:

catalog_id: str or CatalogIndex: catalog id

Returns:

Optional[Catalog]: catalog data

Examples

>>> import speasy as spz
>>> spz.amda.get_catalog("sharedcatalog_22")
<Catalog: model_regions_plasmas_mms_2019>

get_real_product_id(product_id: str, **kwargs)[source]

get_timetable(timetable_id: str, **kwargs) → TimeTable | None[source]

Get timetable data by ID.

Parameters:

timetable_id: str or TimetableIndex: time table id

Returns:

Optional[TimeTable]: timetable data

Examples

>>> import speasy as spz
>>> spz.amda.get_timetable("sharedtimeTable_0")
<TimeTable: FTE_c1>

get_user_catalog(catalog_id: str, **kwargs) → Catalog | None[source]

Get user catalog. Raises an exception if user is not authenticated.

Parameters:

catalog_id: str or CatalogIndex: catalog id

Returns:

Optional[Catalog]: user catalog

Warning

Calling get_user_catalog() without having defined AMDA_Webservice login credentials will result in a MissingCredentials exception being raised.

Examples

>>> import speasy as spz
>>> spz.amda.get_user_catalog("tt_0") 
<Catalog: test_alexis>

get_user_timetable(timetable_id: str, **kwargs) → TimeTable | None[source]

Get user timetable. Raises an exception if user is not authenticated.

Parameters:

timetable_id: str or TimetableIndex: timetable id

Returns:

Optional[TimeTable]: user timetable

Warning

Calling get_user_timetable() without having defined AMDA_Webservice login credentials will result in a MissingCredentials exception being raised.

Examples

>>> import speasy as spz
>>> spz.amda.get_user_timetable("tt_0") 
<TimeTable: test_alexis>

has_time_restriction(product_id: str, start_time: str, stop_time: str)[source]

Check if product is restricted for a given time range.

Parameters:

product_id: str or SpeasyIndex: product id
start_time: str or datetime: desired data start time
stop_time: str or datetime: desired data stop time

Returns:

bool: True if product is restricted for the given time range, False otherwise.

static is_server_up()[source]

Check if AMDA Webservice is up by sending a dummy request to the AMDA Webservice URL with a short timeout.

Returns:

bool: True if AMDA Webservice is up, False otherwise.

product_version(parameter_id: str)[source]

Get date of last modification of dataset or parameter.

Parameters:

parameter_id: str or ParameterIndex: parameter id

Returns:

str: product version