earthkit.data.sources.cds¶

Attributes¶

`EXTENSIONS`
`source`

Classes¶

`CDSAPIKeyPrompt`
`CdsRetriever`	Base class for all sources.

Functions¶

client(use_prompt)

Module Contents¶

class earthkit.data.sources.cds.CDSAPIKeyPrompt¶

Bases: earthkit.data.sources.prompt.APIKeyPrompt

ask_user()¶

ask_user_and_save()¶

check(load=False)¶

config_env = ('CDSAPI_URL', 'CDSAPI_KEY')¶

existing_rcfile_path()¶

has_api_config()¶

has_config_env()¶

load(file)¶

prompts¶

rcfile = '~/.cdsapirc'¶

rcfile_env = 'CDSAPI_RC'¶

rcfile_name()¶

register_or_sign_in_url = 'https://cds.climate.copernicus.eu/'¶

retrieve_api_key_url = 'https://cds.climate.copernicus.eu/how-to-api'¶

save(input, file)¶

validate(input)¶

class earthkit.data.sources.cds.CdsRetriever(dataset, *args, request=None, prompt=True, **kwargs)¶

Bases: earthkit.data.sources.file.FileSource

Base class for all sources.

client()¶

content_type = None¶

dataset¶

filter = None¶

graph(depth=0)¶

ignore()¶

Indicates to ignore this source in concatenation/merging.

Return type:: bool

classmethod merge(sources)¶

merger = None¶

mutate()¶

mutate_source()¶

name = None¶

property parent¶: The parent source, if any.

property parts¶

path¶

prompt = True¶

request = []¶

property requests¶

source_filename = None¶

sphinxdoc = Multiline-String¶

Show Value

"""
    CdsRetriever
    """

stream = False¶

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

to_target(*args, **kwargs)¶

earthkit.data.sources.cds.EXTENSIONS¶

earthkit.data.sources.cds.client(use_prompt)¶

earthkit.data.sources.cds.source¶