speasy.webservices.amda package

speasy.amda.amda

This package contains the definition of the AMDA_Webservice class, the object that manages the connexion to AMDA and allows users to list available products, get their description and downloading the corresponding data.

AMDA provides the following kinds products :

• parameters, measurements as timeseries

  • list them with get_parameter()

  • download them with list_parameters()

• datasets, collections of parameters with the same time axis

  • list them with get_dataset()

  • download them with list_datasets()

• timetables, lists of time ranges

  • list them with get_timetable()

  • download them with list_timetables()

• catalogs, timetables with metadata for each time range

  • list them with get_catalog()

  • download them with list_catalogs()

See user documentation for a more accessible documentation.

Notes

You should not create an instance of AMDA_Webservice but use the speasy.amda instance instead.

Submodules

• speasy.webservices.amda.exceptions module
  • MissingCredentials
• speasy.webservices.amda.inventory module
  • AmdaXMLParser
    • AmdaXMLParser.fix_names()
    • AmdaXMLParser.fix_xmlid()
    • AmdaXMLParser.index_ctor_args()
    • AmdaXMLParser.make_any_node()
    • AmdaXMLParser.make_catalogue_node()
    • AmdaXMLParser.make_component_node()
    • AmdaXMLParser.make_dataset_node()
    • AmdaXMLParser.make_instrument_node()
    • AmdaXMLParser.make_parameter_node()
    • AmdaXMLParser.make_path_node()
    • AmdaXMLParser.make_timetable_node()
    • AmdaXMLParser.make_user_parameter_node()
    • AmdaXMLParser.parse()
  • to_dataset_index()
  • to_parameter_index()
  • to_xmlid()
• speasy.webservices.amda.rest_client module
  • Endpoint
    • Endpoint.AUTH
    • Endpoint.GETCAT
    • Endpoint.GETPARAM
    • Endpoint.GETSTATUS
    • Endpoint.GETTT
    • Endpoint.LISTCAT
    • Endpoint.LISTPARAM
    • Endpoint.LISTTT
    • Endpoint.OBSTREE
  • auth_args()
  • get_catalog()
  • get_catalogs_xml_tree()
  • get_obs_data_tree()
  • get_parameter()
  • get_timetable()
  • get_timetables_xml_tree()
  • get_user_catalogs_xml_tree()
  • get_user_parameters_xml_tree()
  • get_user_timetables_xml_tree()
  • is_server_up()
  • request_url()
  • send_indirect_request()
  • send_request()
  • send_request_json()
  • token()
• speasy.webservices.amda.utils module
  • get_parameter_args()
  • load_catalog()
  • load_csv()
  • load_timetable()
• speasy.webservices.amda.ws module
  • AMDA_Webservice
    • AMDA_Webservice.build_inventory()
    • AMDA_Webservice.build_private_inventory()
    • AMDA_Webservice.dataset_range()
    • AMDA_Webservice.get_catalog()
    • AMDA_Webservice.get_data()
    • AMDA_Webservice.get_dataset()
    • AMDA_Webservice.get_parameter()
    • AMDA_Webservice.get_timetable()
    • AMDA_Webservice.get_user_catalog()
    • AMDA_Webservice.get_user_parameter()
    • AMDA_Webservice.get_user_timetable()
    • AMDA_Webservice.has_time_restriction()
    • AMDA_Webservice.is_server_up()
    • AMDA_Webservice.is_user_catalog()
    • AMDA_Webservice.is_user_parameter()
    • AMDA_Webservice.is_user_timetable()
    • AMDA_Webservice.list_catalogs()
    • AMDA_Webservice.list_datasets()
    • AMDA_Webservice.list_parameters()
    • AMDA_Webservice.list_timetables()
    • AMDA_Webservice.list_user_catalogs()
    • AMDA_Webservice.list_user_parameters()
    • AMDA_Webservice.list_user_timetables()
    • AMDA_Webservice.parameter_range()
    • AMDA_Webservice.product_type()
    • AMDA_Webservice.product_version()
  • ProductType
    • ProductType.CATALOG
    • ProductType.COMPONENT
    • ProductType.DATASET
    • ProductType.PARAMETER
    • ProductType.TIMETABLE
    • ProductType.UNKNOWN