earthkit.data.sources.ecmwf_api¶

Classes¶

`ECMWFApi`	Base class for all sources.
`MARSAPIKeyPrompt`

Module Contents¶

class earthkit.data.sources.ecmwf_api.ECMWFApi(*args, request=None, prompt=True, log='default', **kwargs)¶

Bases: earthkit.data.sources.file.FileSource

Base class for all sources.

content_type = None¶

empty_reader(*args, **kwargs)¶

expect_any = False¶

filter = None¶

graph(depth=0)¶

ignore()¶

Indicates to ignore this source in concatenation/merging.

Return type:: bool

log = 'default'¶

classmethod merge(sources)¶

merger = None¶

mutate()¶

mutate_source()¶

name = None¶

property parent¶: The parent source, if any.

property parts¶

path¶

prompt = True¶

request = []¶

source_filename = None¶

stream = False¶

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

to_pandas(**kwargs)¶

to_target(*args, **kwargs)¶

class earthkit.data.sources.ecmwf_api.MARSAPIKeyPrompt¶

Bases: earthkit.data.sources.prompt.APIKeyPrompt

ask_user()¶

ask_user_and_save()¶

check(load=False)¶

config_env = ('ECMWF_API_KEY', 'ECMWF_API_URL')¶

existing_rcfile_path()¶

has_api_config()¶

has_config_env()¶

load(file)¶

prompts¶

rcfile = '~/.ecmwfapirc'¶

rcfile_env = 'ECMWF_API_RC_FILE'¶

rcfile_name()¶

register_or_sign_in_url = 'https://www.ecmwf.int/user/login/sso'¶

retrieve_api_key_url = 'https://api.ecmwf.int/v1/key/'¶

save(input, file)¶

validate(input)¶