eodag.plugins.apis.ecmwf.EcmwfApi#

class eodag.plugins.apis.ecmwf.EcmwfApi(provider, config)[source]#

A plugin that enables to build download-request and download data on ECMWF MARS.

Builds a single ready-to-download EOProduct during the search stage.

Download will then be performed on ECMWF Public Datasets (if dataset parameter is in query), or on MARS Operational Archive (if dataset parameter is not in query).

This class inherits from Api for compatibility, Download for download methods, and QueryStringSearch for metadata-mapping and query build methods.

__init__(provider, config)[source]#

Methods

__init__(provider, config)

authenticate()

Check credentials and returns information needed for auth

build_query_string(product_type, **kwargs)

Build The query string using the search parameters

clear()

Method used to clear a search context between two searches.

collect_search_urls([page, items_per_page, ...])

Build paginated urls

count_hits(count_url[, result_type])

Count the number of results satisfying some criteria

do_search([items_per_page])

Perform the actual search request.

download(product[, auth, progress_callback])

Download data from ECMWF MARS

download_all(products[, auth, ...])

Download all using parent (base plugin) method

format_free_text_search(**kwargs)

Build the free text search parameter using the search parameters

get_collections(**kwargs)

Get the collection to which the product belongs

get_product_type_def_params(product_type, ...)

Get the provider product type definition parameters

get_queryables(search_params)

Retrieve the metadata mappings that are query-able

map_product_type(product_type, **kwargs)

Map the eodag product type to the provider product type

normalize_results(results, **kwargs)

Build EOProducts from provider results

query([product_type, items_per_page, page, ...])

Build ready-to-download SearchResult

update_metadata_mapping(metadata_mapping)

Update plugin metadata_mapping with input metadata_mapping configuration

Attributes

COMPLEX_QS_REGEX

DEFAULT_ITEMS_PER_PAGE

extract_properties

plugins