earthkit.data.sources.ads¶

Attributes¶

`EXTENSIONS`
`source`

Classes¶

`ADSAPIKeyPrompt`
`AdsRetriever`	Base class for all sources.

Functions¶

Module Contents¶

class earthkit.data.sources.ads.ADSAPIKeyPrompt¶

Bases: earthkit.data.sources.prompt.APIKeyPrompt

ask_user()¶

ask_user_and_save()¶

check(load=False)¶

config_env = []¶

existing_rcfile_path()¶

has_api_config()¶

has_config_env()¶

load(file)¶

prompts¶

rc_message_base = Multiline-String¶

Show Value

"""You have to store the credentials in {rcfile}; if you follow the
           instructions below it will be automatically done for you.
    """

rcfile = '~/.adsapirc'¶

rcfile_env = None¶

rcfile_name()¶

register_or_sign_in_url = 'https://ads.atmosphere.copernicus.eu/'¶

retrieve_api_key_url = 'https://ads.atmosphere.copernicus.eu/how-to-api'¶

save(input, file)¶

validate(input)¶

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

Bases: earthkit.data.sources.cds.CdsRetriever

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

"""
    AdsRetriever
    """

stream = False¶

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

to_target(*args, **kwargs)¶

earthkit.data.sources.ads.EXTENSIONS¶

earthkit.data.sources.ads.client()¶

earthkit.data.sources.ads.source¶