earthkit.data.sources.polytope¶

Attributes¶

Classes¶

`Polytope`	Retrieve data using the Polytope Web API.
`PolytopeWebKeyPrompt`

Module Contents¶

class earthkit.data.sources.polytope.Polytope(dataset, *args, request=None, stream=True, **kwargs)¶

Bases: earthkit.data.sources.Source

Retrieve data using the Polytope Web API. See polytope-client.readthedocs.io for more information.

Parameters:

dataset (str) – The name of the dataset to query.
request (dict[str, str]) – A collection of key : value pairs specifying the dataset.

Examples

>>> src = earthkit.data.from_source("polytope", "ecmwf-mars", request)
>>> src.to_pandas()  # if tabular data
>>> src.to_xarray()  # if datacube

client¶

dataset¶

graph(depth=0)¶

ignore()¶

Indicates to ignore this source in concatenation/merging.

Return type:: bool

mutate()¶

mutate_source()¶

name = None¶

property parent¶: The parent source, if any.

request = []¶

source_filename = None¶

stream = True¶

to_data_object()¶: Convert this source into a data object, if possible.

class earthkit.data.sources.polytope.PolytopeWebKeyPrompt¶

Bases: earthkit.data.sources.prompt.APIKeyPrompt

ask_user()¶

ask_user_and_save()¶

check(load=False)¶

config_env = ('POLYTOPE_USER_EMAIL', 'POLYTOPE_USER_KEY')¶

existing_rcfile_path()¶

has_api_config()¶

has_config_env()¶

load(file)¶

prompts¶

rcfile = '~/.polytopeapirc'¶

rcfile_env = None¶

rcfile_name()¶

register_or_sign_in_url = ('',)¶

retrieve_api_key_url = ('',)¶

save(input, file)¶

validate(input)¶

earthkit.data.sources.polytope.source¶