From f6170e2bed8ee3e2efe0181012ee6b77c36a5ba0 Mon Sep 17 00:00:00 2001 From: malmans2 Date: Fri, 27 Sep 2024 10:42:21 +0000 Subject: [PATCH] deploy: c263e15f8d26c733efd16afaf318b54fbd572782 --- .buildinfo | 2 +- _api/cads_api_client/ApiClient.html | 8 ++-- _api/cads_api_client/Collection.html | 18 ++++++-- _api/cads_api_client/Collections.html | 6 +-- _api/cads_api_client/Jobs.html | 6 +-- _api/cads_api_client/Process.html | 6 +-- _api/cads_api_client/Processes.html | 6 +-- _api/cads_api_client/Remote.html | 6 +-- _api/cads_api_client/Results.html | 42 ++++++++++++++++-- _api/cads_api_client/index.html | 6 +-- .../_api/cads_api_client/ApiClient.rst.txt | 2 +- .../_api/cads_api_client/Collection.rst.txt | 8 ++++ _sources/_api/cads_api_client/Results.rst.txt | 24 ++++++++++ _static/documentation_options.js | 2 +- genindex.html | 27 ++++++++--- index.html | 6 +-- objects.inv | Bin 838 -> 866 bytes py-modindex.html | 6 +-- search.html | 6 +-- searchindex.js | 2 +- 20 files changed, 143 insertions(+), 46 deletions(-) diff --git a/.buildinfo b/.buildinfo index 3b746d1..f565872 100644 --- a/.buildinfo +++ b/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 9df2cf85c25c1d48c18d768afe818bd2 +config: 4c90826020c57f287f6b35d612408211 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/_api/cads_api_client/ApiClient.html b/_api/cads_api_client/ApiClient.html index b79d440..8260822 100644 --- a/_api/cads_api_client/ApiClient.html +++ b/_api/cads_api_client/ApiClient.html @@ -8,7 +8,7 @@ - cads_api_client.ApiClient — cads_api_client 1.4.2 documentation + cads_api_client.ApiClient — cads_api_client 1.4.3 documentation @@ -36,7 +36,7 @@ - + @@ -119,7 +119,7 @@ -

cads_api_client 1.4.2 documentation

+

cads_api_client 1.4.3 documentation

@@ -448,7 +448,7 @@

cads_api_client.ApiClient
get_accepted_licences(scope=None)#
-

Retrieve acccepted licences.

+

Retrieve accepted licences.

Parameters:

scope ({None, 'all', 'dataset', 'portal'}) – Licence scope.

diff --git a/_api/cads_api_client/Collection.html b/_api/cads_api_client/Collection.html index cddcb4e..0054404 100644 --- a/_api/cads_api_client/Collection.html +++ b/_api/cads_api_client/Collection.html @@ -8,7 +8,7 @@ - cads_api_client.Collection — cads_api_client 1.4.2 documentation + cads_api_client.Collection — cads_api_client 1.4.3 documentation @@ -36,7 +36,7 @@ - + @@ -119,7 +119,7 @@ -

cads_api_client 1.4.2 documentation

+

cads_api_client 1.4.3 documentation

@@ -347,6 +347,17 @@

cads_api_client.Collection +
+property bbox: tuple[float, float, float, float]#
+

Bounding box of the collection (W, S, E, N).

+
+
Return type:
+

tuple[float,float,float,float]

+
+
+

+
property begin_datetime: datetime.datetime#
@@ -465,6 +476,7 @@

cads_api_client.Collection
  • cads_api_client.Collection
  • +
    +
    +property content_length: int#
    +

    File size in Bytes.

    +
    +
    Return type:
    +

    int

    +
    +
    +
    + +
    +
    +property content_type: str#
    +

    File MIME type.

    +
    +
    Return type:
    +

    int

    +
    +
    +
    +
    property json: dict[str, Any]#
    @@ -371,6 +393,17 @@

    cads_api_client.Results

    +
    +
    +property location: str#
    +

    File location.

    +
    +
    Return type:
    +

    str

    +
    +
    +
    +
    property url: str#
    @@ -426,7 +459,10 @@

    cads_api_client.Resultscads_api_client.Results diff --git a/_api/cads_api_client/index.html b/_api/cads_api_client/index.html index 76daf80..b8305bf 100644 --- a/_api/cads_api_client/index.html +++ b/_api/cads_api_client/index.html @@ -8,7 +8,7 @@ - cads_api_client — cads_api_client 1.4.2 documentation + cads_api_client — cads_api_client 1.4.3 documentation @@ -36,7 +36,7 @@ - + @@ -119,7 +119,7 @@ -

    cads_api_client 1.4.2 documentation

    +

    cads_api_client 1.4.3 documentation

    diff --git a/_sources/_api/cads_api_client/ApiClient.rst.txt b/_sources/_api/cads_api_client/ApiClient.rst.txt index 47eb7e0..24fd079 100644 --- a/_sources/_api/cads_api_client/ApiClient.rst.txt +++ b/_sources/_api/cads_api_client/ApiClient.rst.txt @@ -96,7 +96,7 @@ cads_api_client.ApiClient .. py:method:: get_accepted_licences(scope = None) - Retrieve acccepted licences. + Retrieve accepted licences. :param scope: Licence scope. :type scope: ``{None, 'all', 'dataset', 'portal'}`` diff --git a/_sources/_api/cads_api_client/Collection.rst.txt b/_sources/_api/cads_api_client/Collection.rst.txt index 3c6fde0..0a5ddf1 100644 --- a/_sources/_api/cads_api_client/Collection.rst.txt +++ b/_sources/_api/cads_api_client/Collection.rst.txt @@ -20,6 +20,14 @@ cads_api_client.Collection + .. py:property:: bbox + :type: tuple[float, float, float, float] + + Bounding box of the collection (W, S, E, N). + + :rtype: :class:`tuple[float,float,float,float]` + + .. py:property:: begin_datetime :type: datetime.datetime diff --git a/_sources/_api/cads_api_client/Results.rst.txt b/_sources/_api/cads_api_client/Results.rst.txt index 1a56164..54fea3a 100644 --- a/_sources/_api/cads_api_client/Results.rst.txt +++ b/_sources/_api/cads_api_client/Results.rst.txt @@ -29,6 +29,22 @@ cads_api_client.Results :rtype: :class:`dict[str,Any]` + .. py:property:: content_length + :type: int + + File size in Bytes. + + :rtype: :class:`int` + + + .. py:property:: content_type + :type: str + + File MIME type. + + :rtype: :class:`int` + + .. py:property:: json :type: dict[str, Any] @@ -37,6 +53,14 @@ cads_api_client.Results :rtype: :class:`dict[str,Any]` + .. py:property:: location + :type: str + + File location. + + :rtype: :class:`str` + + .. py:property:: url :type: str diff --git a/_static/documentation_options.js b/_static/documentation_options.js index 6d656b6..4229cbf 100644 --- a/_static/documentation_options.js +++ b/_static/documentation_options.js @@ -1,5 +1,5 @@ const DOCUMENTATION_OPTIONS = { - VERSION: '1.4.2', + VERSION: '1.4.3', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/genindex.html b/genindex.html index 9fa8a1b..f9ffab7 100644 --- a/genindex.html +++ b/genindex.html @@ -7,7 +7,7 @@ - Index — cads_api_client 1.4.2 documentation + Index — cads_api_client 1.4.3 documentation @@ -35,7 +35,7 @@ - + @@ -116,7 +116,7 @@ -

    cads_api_client 1.4.2 documentation

    +

    cads_api_client 1.4.3 documentation

    @@ -285,6 +285,7 @@

    Index

    | G | I | J + | L | M | N | P @@ -313,6 +314,10 @@

    A

    B

    + - +
    @@ -452,6 +461,14 @@

    J

    +

    L

    + + +
    +

    M

      diff --git a/index.html b/index.html index 2267754..0872f7b 100644 --- a/index.html +++ b/index.html @@ -8,7 +8,7 @@ - Welcome to cads_api_client’s documentation! — cads_api_client 1.4.2 documentation + Welcome to cads_api_client’s documentation! — cads_api_client 1.4.3 documentation @@ -36,7 +36,7 @@ - + @@ -118,7 +118,7 @@ -

      cads_api_client 1.4.2 documentation

      +

      cads_api_client 1.4.3 documentation

      diff --git a/objects.inv b/objects.inv index 6f2b2c106e58c9fb2f37609ffd7caca56d9d5a83..eeddbf084c80e9a45d93c84fee8bc27d4f724d8f 100644 GIT binary patch delta 724 zcmV;_0xSK-2I2;gM*%aDNLPQDEe6-%-T2nm=_(l_RsJ5rNN!l0(N!dTJ?T1Tzw#`>dLDA+{uR%kSk^_`E;9i zvYePfSj{+x&QT>fXby+Yf@_S(1MfODQf{<$J(Jqm%zWMe|4G^48h?K$IdjtJ%o4)9 zXl0n7J=j5I{{pa1w#x~B& zBp2y*53O-f1YBZT_TYL6&$&BnhfOP85h!I^&==+}jLteJ4;Pa=Sa@br46fd6%x=&0 zao0ib##~s~N==1Nsy=_ULIDBrBV7dzOqcld)4J5j*rMe`jsN%&;h6 zJy$&{MdJ7(CDKCz3D&T4MZjGT&qct=Q4!#NJ+3H%@vt`vBWk}g!MYwpLpmFQ!nzlM z!a5XzLb@b$=)R*}6!bqEAT&F5>wpI13J@BH4LvjvTN;1RKxFJ-d4LWez`#-m z5C_H1;v^_`J|{vCSJ-5j#7^^ki23cb!3jEkGK*m@%Ri=vNUi_{m~9vqcRU=)2E>Ls z64%48!KcamL^@=3i*?KmHV^Q$^NYmc!7d7_Jp+&fh$Q-I==?oZptr6mf_7sES-~lR zjzr=^9SKxsJ^+8s21O>wH@xs^1F=rr3&Y6@buK{`4?n8NIz1|Mwb3KXyM&mOP0+G2 zFv`F z$in2Rmj4Dt`SU-cYkIW>Ju?*BfZ9`DpH6MQ>@TY~QfEjOKR|KQ0&(VA;P3B0miPuk z>u(Mj=UvqraYM5kSFbN7=;QPsY*Iga8)>#4ea6+7tu3&gH2 GJsXpHH&9jp delta 696 zcmV;p0!RJg2F3=EM*%XCNLPP^Ee6-%-Oa79(bwyfl!Saa8^ch+%^$<>PiBT0h&dCM zvR+cIBxpza?R{s&sDOMVyXSX&YH%mDfY)~8I`uvnE!hF5~{*$uNZTx?os z<0;Nm~`ojE$(M6r|Fj?Hu#&b5s;Mx_erKZAH zKVJj)uJ#$&!{D}s1i*j0q#|C53eYDT99$ect&|_%GU?Wi2@FGyyfFe-H z5XMQ%b2*EK?_ie%{m)4S&CcE9qrtcagvMc04-Le&1~d?vJ6L}npc4o%uv`b?px9NM z1;wuCOz8d!TMV<g$)0UJu?d-^{{b3WU>q+)y=O;7Wq=|P9 ztOmqYU`FTAeo`VA<%8U=MNKTx5&ZLlATx`rng3dmzrX)j;s=bKzuA8hc-M4B+|VrSw~OP80DTPKX@dI2+r+Tt e))z-T9c_UPd@~&wo`o^r!}}#$L-P-p37G(v)L%OQ diff --git a/py-modindex.html b/py-modindex.html index 7b846d5..d8511fd 100644 --- a/py-modindex.html +++ b/py-modindex.html @@ -7,7 +7,7 @@ - Python Module Index — cads_api_client 1.4.2 documentation + Python Module Index — cads_api_client 1.4.3 documentation @@ -35,7 +35,7 @@ - + @@ -123,7 +123,7 @@ -

      cads_api_client 1.4.2 documentation

      +

      cads_api_client 1.4.3 documentation

      diff --git a/search.html b/search.html index 81bba63..09372d9 100644 --- a/search.html +++ b/search.html @@ -6,7 +6,7 @@ - Search - cads_api_client 1.4.2 documentation + Search - cads_api_client 1.4.3 documentation @@ -34,7 +34,7 @@ - + @@ -118,7 +118,7 @@ -

      cads_api_client 1.4.2 documentation

      +

      cads_api_client 1.4.3 documentation

      diff --git a/searchindex.js b/searchindex.js index 1887918..a482ed4 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles": {"Classes": [[8, "classes"]], "Contents:": [[9, null]], "Indices and tables": [[9, "indices-and-tables"]], "Welcome to cads_api_client\u2019s documentation!": [[9, null]], "cads_api_client": [[8, null]], "cads_api_client.ApiClient": [[0, null]], "cads_api_client.Collection": [[1, null]], "cads_api_client.Collections": [[2, null]], "cads_api_client.Jobs": [[3, null]], "cads_api_client.Process": [[4, null]], "cads_api_client.Processes": [[5, null]], "cads_api_client.Remote": [[6, null]], "cads_api_client.Results": [[7, null]]}, "docnames": ["_api/cads_api_client/ApiClient", "_api/cads_api_client/Collection", "_api/cads_api_client/Collections", "_api/cads_api_client/Jobs", "_api/cads_api_client/Process", "_api/cads_api_client/Processes", "_api/cads_api_client/Remote", "_api/cads_api_client/Results", "_api/cads_api_client/index", "index"], "envversion": {"sphinx": 63, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["_api/cads_api_client/ApiClient.rst", "_api/cads_api_client/Collection.rst", "_api/cads_api_client/Collections.rst", "_api/cads_api_client/Jobs.rst", "_api/cads_api_client/Process.rst", "_api/cads_api_client/Processes.rst", "_api/cads_api_client/Remote.rst", "_api/cads_api_client/Results.rst", "_api/cads_api_client/index.rst", "index.md"], "indexentries": {"accept_licence() (cads_api_client.apiclient method)": [[0, "cads_api_client.ApiClient.accept_licence", false]], "apply_constraints() (cads_api_client.apiclient method)": [[0, "cads_api_client.ApiClient.apply_constraints", false]], "apply_constraints() (cads_api_client.process method)": [[4, "cads_api_client.Process.apply_constraints", false]], "asset (cads_api_client.results property)": [[7, "cads_api_client.Results.asset", false]], "begin_datetime (cads_api_client.collection property)": [[1, "cads_api_client.Collection.begin_datetime", false]], "cads_api_client": [[8, "module-cads_api_client", false]], "cads_api_client.apiclient (built-in class)": [[0, "cads_api_client.ApiClient", false]], "cads_api_client.collection (built-in class)": [[1, "cads_api_client.Collection", false]], "cads_api_client.collections (built-in class)": [[2, "cads_api_client.Collections", false]], "cads_api_client.jobs (built-in class)": [[3, "cads_api_client.Jobs", false]], "cads_api_client.process (built-in class)": [[4, "cads_api_client.Process", false]], "cads_api_client.processes (built-in class)": [[5, "cads_api_client.Processes", false]], "cads_api_client.remote (built-in class)": [[6, "cads_api_client.Remote", false]], "cads_api_client.results (built-in class)": [[7, "cads_api_client.Results", false]], "check_authentication() (cads_api_client.apiclient method)": [[0, "cads_api_client.ApiClient.check_authentication", false]], "collection_id (cads_api_client.remote property)": [[6, "cads_api_client.Remote.collection_id", false]], "collection_ids (cads_api_client.collections property)": [[2, "cads_api_client.Collections.collection_ids", false]], "delete() (cads_api_client.remote method)": [[6, "cads_api_client.Remote.delete", false]], "download() (cads_api_client.remote method)": [[6, "cads_api_client.Remote.download", false]], "download() (cads_api_client.results method)": [[7, "cads_api_client.Results.download", false]], "download_results() (cads_api_client.apiclient method)": [[0, "cads_api_client.ApiClient.download_results", false]], "end_datetime (cads_api_client.collection property)": [[1, "cads_api_client.Collection.end_datetime", false]], "estimate_costs() (cads_api_client.apiclient method)": [[0, "cads_api_client.ApiClient.estimate_costs", false]], "estimate_costs() (cads_api_client.process method)": [[4, "cads_api_client.Process.estimate_costs", false]], "get_accepted_licences() (cads_api_client.apiclient method)": [[0, "cads_api_client.ApiClient.get_accepted_licences", false]], "get_collection() (cads_api_client.apiclient method)": [[0, "cads_api_client.ApiClient.get_collection", false]], "get_collections() (cads_api_client.apiclient method)": [[0, "cads_api_client.ApiClient.get_collections", false]], "get_jobs() (cads_api_client.apiclient method)": [[0, "cads_api_client.ApiClient.get_jobs", false]], "get_licences() (cads_api_client.apiclient method)": [[0, "cads_api_client.ApiClient.get_licences", false]], "get_process() (cads_api_client.apiclient method)": [[0, "cads_api_client.ApiClient.get_process", false]], "get_processes() (cads_api_client.apiclient method)": [[0, "cads_api_client.ApiClient.get_processes", false]], "get_remote() (cads_api_client.apiclient method)": [[0, "cads_api_client.ApiClient.get_remote", false]], "get_results() (cads_api_client.apiclient method)": [[0, "cads_api_client.ApiClient.get_results", false]], "id (cads_api_client.collection property)": [[1, "cads_api_client.Collection.id", false]], "id (cads_api_client.process property)": [[4, "cads_api_client.Process.id", false]], "job_ids (cads_api_client.jobs property)": [[3, "cads_api_client.Jobs.job_ids", false]], "json (cads_api_client.collection property)": [[1, "cads_api_client.Collection.json", false]], "json (cads_api_client.collections property)": [[2, "cads_api_client.Collections.json", false]], "json (cads_api_client.jobs property)": [[3, "cads_api_client.Jobs.json", false]], "json (cads_api_client.process property)": [[4, "cads_api_client.Process.json", false]], "json (cads_api_client.processes property)": [[5, "cads_api_client.Processes.json", false]], "json (cads_api_client.remote property)": [[6, "cads_api_client.Remote.json", false]], "json (cads_api_client.results property)": [[7, "cads_api_client.Results.json", false]], "module": [[8, "module-cads_api_client", false]], "next (cads_api_client.collections property)": [[2, "cads_api_client.Collections.next", false]], "next (cads_api_client.jobs property)": [[3, "cads_api_client.Jobs.next", false]], "next (cads_api_client.processes property)": [[5, "cads_api_client.Processes.next", false]], "prev (cads_api_client.collections property)": [[2, "cads_api_client.Collections.prev", false]], "prev (cads_api_client.jobs property)": [[3, "cads_api_client.Jobs.prev", false]], "prev (cads_api_client.processes property)": [[5, "cads_api_client.Processes.prev", false]], "process (cads_api_client.collection property)": [[1, "cads_api_client.Collection.process", false]], "process_ids (cads_api_client.processes property)": [[5, "cads_api_client.Processes.process_ids", false]], "request (cads_api_client.remote property)": [[6, "cads_api_client.Remote.request", false]], "request_uid (cads_api_client.remote property)": [[6, "cads_api_client.Remote.request_uid", false]], "retrieve() (cads_api_client.apiclient method)": [[0, "cads_api_client.ApiClient.retrieve", false]], "status (cads_api_client.remote property)": [[6, "cads_api_client.Remote.status", false]], "submit() (cads_api_client.apiclient method)": [[0, "cads_api_client.ApiClient.submit", false]], "submit() (cads_api_client.collection method)": [[1, "cads_api_client.Collection.submit", false]], "submit() (cads_api_client.process method)": [[4, "cads_api_client.Process.submit", false]], "submit_and_wait_on_results() (cads_api_client.apiclient method)": [[0, "cads_api_client.ApiClient.submit_and_wait_on_results", false]], "url (cads_api_client.collection property)": [[1, "cads_api_client.Collection.url", false]], "url (cads_api_client.collections property)": [[2, "cads_api_client.Collections.url", false]], "url (cads_api_client.jobs property)": [[3, "cads_api_client.Jobs.url", false]], "url (cads_api_client.process property)": [[4, "cads_api_client.Process.url", false]], "url (cads_api_client.processes property)": [[5, "cads_api_client.Processes.url", false]], "url (cads_api_client.results property)": [[7, "cads_api_client.Results.url", false]]}, "objects": {"": [[8, 0, 0, "-", "cads_api_client"]], "cads_api_client": [[0, 1, 1, "", "ApiClient"], [1, 1, 1, "", "Collection"], [2, 1, 1, "", "Collections"], [3, 1, 1, "", "Jobs"], [4, 1, 1, "", "Process"], [5, 1, 1, "", "Processes"], [6, 1, 1, "", "Remote"], [7, 1, 1, "", "Results"]], "cads_api_client.ApiClient": [[0, 2, 1, "", "accept_licence"], [0, 2, 1, "", "apply_constraints"], [0, 2, 1, "", "check_authentication"], [0, 2, 1, "", "download_results"], [0, 2, 1, "", "estimate_costs"], [0, 2, 1, "", "get_accepted_licences"], [0, 2, 1, "", "get_collection"], [0, 2, 1, "", "get_collections"], [0, 2, 1, "", "get_jobs"], [0, 2, 1, "", "get_licences"], [0, 2, 1, "", "get_process"], [0, 2, 1, "", "get_processes"], [0, 2, 1, "", "get_remote"], [0, 2, 1, "", "get_results"], [0, 2, 1, "", "retrieve"], [0, 2, 1, "", "submit"], [0, 2, 1, "", "submit_and_wait_on_results"]], "cads_api_client.Collection": [[1, 3, 1, "", "begin_datetime"], [1, 3, 1, "", "end_datetime"], [1, 3, 1, "", "id"], [1, 3, 1, "", "json"], [1, 3, 1, "", "process"], [1, 2, 1, "", "submit"], [1, 3, 1, "", "url"]], "cads_api_client.Collections": [[2, 3, 1, "", "collection_ids"], [2, 3, 1, "", "json"], [2, 3, 1, "", "next"], [2, 3, 1, "", "prev"], [2, 3, 1, "", "url"]], "cads_api_client.Jobs": [[3, 3, 1, "", "job_ids"], [3, 3, 1, "", "json"], [3, 3, 1, "", "next"], [3, 3, 1, "", "prev"], [3, 3, 1, "", "url"]], "cads_api_client.Process": [[4, 2, 1, "", "apply_constraints"], [4, 2, 1, "", "estimate_costs"], [4, 3, 1, "", "id"], [4, 3, 1, "", "json"], [4, 2, 1, "", "submit"], [4, 3, 1, "", "url"]], "cads_api_client.Processes": [[5, 3, 1, "", "json"], [5, 3, 1, "", "next"], [5, 3, 1, "", "prev"], [5, 3, 1, "", "process_ids"], [5, 3, 1, "", "url"]], "cads_api_client.Remote": [[6, 3, 1, "", "collection_id"], [6, 2, 1, "", "delete"], [6, 2, 1, "", "download"], [6, 3, 1, "", "json"], [6, 3, 1, "", "request"], [6, 3, 1, "", "request_uid"], [6, 3, 1, "", "status"]], "cads_api_client.Results": [[7, 3, 1, "", "asset"], [7, 2, 1, "", "download"], [7, 3, 1, "", "json"], [7, 3, 1, "", "url"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "property", "Python property"]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:property"}, "terms": {"120": 0, "500": 0, "60": 0, "A": [0, 1, 2, 3, 4, 5, 6, 7], "If": [0, 6, 7], "acccept": 0, "accept": 0, "accept_lic": 0, "after": 0, "all": 0, "ani": [0, 1, 2, 3, 4, 5, 6, 7], "api": [0, 8, 9], "apirespons": [1, 4, 7], "apiresponsepagin": [2, 3, 5], "appli": [0, 4], "apply_constraint": [0, 4], "asset": 7, "authent": 0, "avail": [0, 5], "bar": 0, "base": [1, 2, 3, 4, 5, 7], "begin": 1, "begin_datetim": 1, "between": 0, "bool": 0, "cad": [0, 8, 9], "cads_api_kei": 0, "cads_api_rc": 0, "cads_api_url": 0, "catalogu": [0, 1, 2], "certif": 0, "chang": 0, "check": 0, "check_authent": 0, "class": [0, 1, 2, 3, 4, 5, 6, 7, 9], "cleanup": 0, "client": [0, 8, 9], "cmip6": 0, "collect": [0, 6], "collection_id": [0, 2, 6], "complet": 0, "connect": 0, "constraint": [0, 4], "content": [0, 1, 2, 3, 4, 5, 6, 7], "cost": [0, 4], "creat": 0, "data": 0, "dataset": 0, "datetim": 1, "default": 0, "delet": [0, 6], "dict": [0, 1, 2, 3, 4, 5, 6, 7], "dictionari": [0, 4, 7], "directori": [0, 6, 7], "displai": 0, "download": [0, 6, 7], "download_result": 0, "dure": 0, "e": 0, "end": [0, 1], "end_datetim": 1, "estim": [0, 4], "estimate_cost": [0, 4], "fail": 0, "fals": 0, "field": 0, "file": [0, 6, 7], "filter": 0, "float": 0, "from": 0, "full": 0, "g": 0, "get_accepted_lic": 0, "get_collect": 0, "get_job": 0, "get_lic": 0, "get_process": 0, "get_remot": 0, "get_result": 0, "how": 0, "httperror": 0, "id": [0, 1, 2, 3, 4, 5, 6], "index": 9, "infer": 0, "inform": 0, "int": 0, "interact": [0, 1, 2, 3, 4, 5, 6, 7], "job": [0, 6, 7], "job_id": 3, "json": [1, 2, 3, 4, 5, 6, 7], "kei": 0, "keyword": 0, "licenc": 0, "licence_id": 0, "licens": 0, "limit": 0, "list": [0, 2, 3, 5], "mani": 0, "maximum": 0, "maximum_tri": 0, "modul": 9, "next": [2, 3, 5], "none": [0, 2, 3, 5, 6, 7], "number": 0, "object": 0, "page": [0, 2, 3, 5, 9], "paramet": [0, 1, 4, 6, 7], "path": [0, 6, 7], "per": 0, "portal": 0, "prev": [2, 3, 5], "previou": [2, 3, 5], "process": [0, 1, 2], "process_id": 5, "progress": 0, "project": 0, "properti": [1, 2, 3, 4, 5, 6, 7], "python": [8, 9], "queri": 0, "rais": 0, "read": 0, "readi": 0, "refer": 9, "relev": 0, "remot": [0, 1, 4], "request": [0, 1, 4, 6], "request_uid": [0, 6], "respons": [0, 1, 2, 3, 4, 5, 6, 7], "result": [0, 6], "retri": 0, "retriev": [0, 6, 7], "retry_aft": 0, "return": [0, 1, 2, 3, 4, 5, 6, 7], "revis": 0, "run": 0, "scope": 0, "search": [0, 9], "second": 0, "self": [2, 3, 5], "send": 0, "server": 0, "session": 0, "sleep_max": 0, "sort": 0, "sortbi": 0, "statu": [0, 6], "str": [0, 1, 2, 3, 4, 5, 6, 7], "submit": [0, 1, 3, 4, 6], "submit_and_wait_on_result": 0, "success": 0, "target": [0, 6, 7], "text": 0, "time": 0, "timeout": 0, "titl": 0, "tl": 0, "true": 0, "tupl": 0, "type": [0, 1, 2, 3, 4, 5, 6, 7], "uid": [0, 6], "updat": 0, "url": [0, 1, 2, 3, 4, 5, 7], "valid": [0, 4], "valu": [0, 4], "verifi": 0, "wait": 0, "whether": 0, "while": 0, "work": [0, 6, 7]}, "titles": ["cads_api_client.ApiClient", "cads_api_client.Collection", "cads_api_client.Collections", "cads_api_client.Jobs", "cads_api_client.Process", "cads_api_client.Processes", "cads_api_client.Remote", "cads_api_client.Results", "cads_api_client", "Welcome to cads_api_client\u2019s documentation!"], "titleterms": {"": 9, "apicli": 0, "cads_api_cli": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9], "class": 8, "collect": [1, 2], "content": 9, "document": 9, "indic": 9, "job": 3, "process": [4, 5], "remot": 6, "result": 7, "tabl": 9, "welcom": 9}}) \ No newline at end of file +Search.setIndex({"alltitles": {"Classes": [[8, "classes"]], "Contents:": [[9, null]], "Indices and tables": [[9, "indices-and-tables"]], "Welcome to cads_api_client\u2019s documentation!": [[9, null]], "cads_api_client": [[8, null]], "cads_api_client.ApiClient": [[0, null]], "cads_api_client.Collection": [[1, null]], "cads_api_client.Collections": [[2, null]], "cads_api_client.Jobs": [[3, null]], "cads_api_client.Process": [[4, null]], "cads_api_client.Processes": [[5, null]], "cads_api_client.Remote": [[6, null]], "cads_api_client.Results": [[7, null]]}, "docnames": ["_api/cads_api_client/ApiClient", "_api/cads_api_client/Collection", "_api/cads_api_client/Collections", "_api/cads_api_client/Jobs", "_api/cads_api_client/Process", "_api/cads_api_client/Processes", "_api/cads_api_client/Remote", "_api/cads_api_client/Results", "_api/cads_api_client/index", "index"], "envversion": {"sphinx": 63, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["_api/cads_api_client/ApiClient.rst", "_api/cads_api_client/Collection.rst", "_api/cads_api_client/Collections.rst", "_api/cads_api_client/Jobs.rst", "_api/cads_api_client/Process.rst", "_api/cads_api_client/Processes.rst", "_api/cads_api_client/Remote.rst", "_api/cads_api_client/Results.rst", "_api/cads_api_client/index.rst", "index.md"], "indexentries": {"accept_licence() (cads_api_client.apiclient method)": [[0, "cads_api_client.ApiClient.accept_licence", false]], "apply_constraints() (cads_api_client.apiclient method)": [[0, "cads_api_client.ApiClient.apply_constraints", false]], "apply_constraints() (cads_api_client.process method)": [[4, "cads_api_client.Process.apply_constraints", false]], "asset (cads_api_client.results property)": [[7, "cads_api_client.Results.asset", false]], "bbox (cads_api_client.collection property)": [[1, "cads_api_client.Collection.bbox", false]], "begin_datetime (cads_api_client.collection property)": [[1, "cads_api_client.Collection.begin_datetime", false]], "cads_api_client": [[8, "module-cads_api_client", false]], "cads_api_client.apiclient (built-in class)": [[0, "cads_api_client.ApiClient", false]], "cads_api_client.collection (built-in class)": [[1, "cads_api_client.Collection", false]], "cads_api_client.collections (built-in class)": [[2, "cads_api_client.Collections", false]], "cads_api_client.jobs (built-in class)": [[3, "cads_api_client.Jobs", false]], "cads_api_client.process (built-in class)": [[4, "cads_api_client.Process", false]], "cads_api_client.processes (built-in class)": [[5, "cads_api_client.Processes", false]], "cads_api_client.remote (built-in class)": [[6, "cads_api_client.Remote", false]], "cads_api_client.results (built-in class)": [[7, "cads_api_client.Results", false]], "check_authentication() (cads_api_client.apiclient method)": [[0, "cads_api_client.ApiClient.check_authentication", false]], "collection_id (cads_api_client.remote property)": [[6, "cads_api_client.Remote.collection_id", false]], "collection_ids (cads_api_client.collections property)": [[2, "cads_api_client.Collections.collection_ids", false]], "content_length (cads_api_client.results property)": [[7, "cads_api_client.Results.content_length", false]], "content_type (cads_api_client.results property)": [[7, "cads_api_client.Results.content_type", false]], "delete() (cads_api_client.remote method)": [[6, "cads_api_client.Remote.delete", false]], "download() (cads_api_client.remote method)": [[6, "cads_api_client.Remote.download", false]], "download() (cads_api_client.results method)": [[7, "cads_api_client.Results.download", false]], "download_results() (cads_api_client.apiclient method)": [[0, "cads_api_client.ApiClient.download_results", false]], "end_datetime (cads_api_client.collection property)": [[1, "cads_api_client.Collection.end_datetime", false]], "estimate_costs() (cads_api_client.apiclient method)": [[0, "cads_api_client.ApiClient.estimate_costs", false]], "estimate_costs() (cads_api_client.process method)": [[4, "cads_api_client.Process.estimate_costs", false]], "get_accepted_licences() (cads_api_client.apiclient method)": [[0, "cads_api_client.ApiClient.get_accepted_licences", false]], "get_collection() (cads_api_client.apiclient method)": [[0, "cads_api_client.ApiClient.get_collection", false]], "get_collections() (cads_api_client.apiclient method)": [[0, "cads_api_client.ApiClient.get_collections", false]], "get_jobs() (cads_api_client.apiclient method)": [[0, "cads_api_client.ApiClient.get_jobs", false]], "get_licences() (cads_api_client.apiclient method)": [[0, "cads_api_client.ApiClient.get_licences", false]], "get_process() (cads_api_client.apiclient method)": [[0, "cads_api_client.ApiClient.get_process", false]], "get_processes() (cads_api_client.apiclient method)": [[0, "cads_api_client.ApiClient.get_processes", false]], "get_remote() (cads_api_client.apiclient method)": [[0, "cads_api_client.ApiClient.get_remote", false]], "get_results() (cads_api_client.apiclient method)": [[0, "cads_api_client.ApiClient.get_results", false]], "id (cads_api_client.collection property)": [[1, "cads_api_client.Collection.id", false]], "id (cads_api_client.process property)": [[4, "cads_api_client.Process.id", false]], "job_ids (cads_api_client.jobs property)": [[3, "cads_api_client.Jobs.job_ids", false]], "json (cads_api_client.collection property)": [[1, "cads_api_client.Collection.json", false]], "json (cads_api_client.collections property)": [[2, "cads_api_client.Collections.json", false]], "json (cads_api_client.jobs property)": [[3, "cads_api_client.Jobs.json", false]], "json (cads_api_client.process property)": [[4, "cads_api_client.Process.json", false]], "json (cads_api_client.processes property)": [[5, "cads_api_client.Processes.json", false]], "json (cads_api_client.remote property)": [[6, "cads_api_client.Remote.json", false]], "json (cads_api_client.results property)": [[7, "cads_api_client.Results.json", false]], "location (cads_api_client.results property)": [[7, "cads_api_client.Results.location", false]], "module": [[8, "module-cads_api_client", false]], "next (cads_api_client.collections property)": [[2, "cads_api_client.Collections.next", false]], "next (cads_api_client.jobs property)": [[3, "cads_api_client.Jobs.next", false]], "next (cads_api_client.processes property)": [[5, "cads_api_client.Processes.next", false]], "prev (cads_api_client.collections property)": [[2, "cads_api_client.Collections.prev", false]], "prev (cads_api_client.jobs property)": [[3, "cads_api_client.Jobs.prev", false]], "prev (cads_api_client.processes property)": [[5, "cads_api_client.Processes.prev", false]], "process (cads_api_client.collection property)": [[1, "cads_api_client.Collection.process", false]], "process_ids (cads_api_client.processes property)": [[5, "cads_api_client.Processes.process_ids", false]], "request (cads_api_client.remote property)": [[6, "cads_api_client.Remote.request", false]], "request_uid (cads_api_client.remote property)": [[6, "cads_api_client.Remote.request_uid", false]], "retrieve() (cads_api_client.apiclient method)": [[0, "cads_api_client.ApiClient.retrieve", false]], "status (cads_api_client.remote property)": [[6, "cads_api_client.Remote.status", false]], "submit() (cads_api_client.apiclient method)": [[0, "cads_api_client.ApiClient.submit", false]], "submit() (cads_api_client.collection method)": [[1, "cads_api_client.Collection.submit", false]], "submit() (cads_api_client.process method)": [[4, "cads_api_client.Process.submit", false]], "submit_and_wait_on_results() (cads_api_client.apiclient method)": [[0, "cads_api_client.ApiClient.submit_and_wait_on_results", false]], "url (cads_api_client.collection property)": [[1, "cads_api_client.Collection.url", false]], "url (cads_api_client.collections property)": [[2, "cads_api_client.Collections.url", false]], "url (cads_api_client.jobs property)": [[3, "cads_api_client.Jobs.url", false]], "url (cads_api_client.process property)": [[4, "cads_api_client.Process.url", false]], "url (cads_api_client.processes property)": [[5, "cads_api_client.Processes.url", false]], "url (cads_api_client.results property)": [[7, "cads_api_client.Results.url", false]]}, "objects": {"": [[8, 0, 0, "-", "cads_api_client"]], "cads_api_client": [[0, 1, 1, "", "ApiClient"], [1, 1, 1, "", "Collection"], [2, 1, 1, "", "Collections"], [3, 1, 1, "", "Jobs"], [4, 1, 1, "", "Process"], [5, 1, 1, "", "Processes"], [6, 1, 1, "", "Remote"], [7, 1, 1, "", "Results"]], "cads_api_client.ApiClient": [[0, 2, 1, "", "accept_licence"], [0, 2, 1, "", "apply_constraints"], [0, 2, 1, "", "check_authentication"], [0, 2, 1, "", "download_results"], [0, 2, 1, "", "estimate_costs"], [0, 2, 1, "", "get_accepted_licences"], [0, 2, 1, "", "get_collection"], [0, 2, 1, "", "get_collections"], [0, 2, 1, "", "get_jobs"], [0, 2, 1, "", "get_licences"], [0, 2, 1, "", "get_process"], [0, 2, 1, "", "get_processes"], [0, 2, 1, "", "get_remote"], [0, 2, 1, "", "get_results"], [0, 2, 1, "", "retrieve"], [0, 2, 1, "", "submit"], [0, 2, 1, "", "submit_and_wait_on_results"]], "cads_api_client.Collection": [[1, 3, 1, "", "bbox"], [1, 3, 1, "", "begin_datetime"], [1, 3, 1, "", "end_datetime"], [1, 3, 1, "", "id"], [1, 3, 1, "", "json"], [1, 3, 1, "", "process"], [1, 2, 1, "", "submit"], [1, 3, 1, "", "url"]], "cads_api_client.Collections": [[2, 3, 1, "", "collection_ids"], [2, 3, 1, "", "json"], [2, 3, 1, "", "next"], [2, 3, 1, "", "prev"], [2, 3, 1, "", "url"]], "cads_api_client.Jobs": [[3, 3, 1, "", "job_ids"], [3, 3, 1, "", "json"], [3, 3, 1, "", "next"], [3, 3, 1, "", "prev"], [3, 3, 1, "", "url"]], "cads_api_client.Process": [[4, 2, 1, "", "apply_constraints"], [4, 2, 1, "", "estimate_costs"], [4, 3, 1, "", "id"], [4, 3, 1, "", "json"], [4, 2, 1, "", "submit"], [4, 3, 1, "", "url"]], "cads_api_client.Processes": [[5, 3, 1, "", "json"], [5, 3, 1, "", "next"], [5, 3, 1, "", "prev"], [5, 3, 1, "", "process_ids"], [5, 3, 1, "", "url"]], "cads_api_client.Remote": [[6, 3, 1, "", "collection_id"], [6, 2, 1, "", "delete"], [6, 2, 1, "", "download"], [6, 3, 1, "", "json"], [6, 3, 1, "", "request"], [6, 3, 1, "", "request_uid"], [6, 3, 1, "", "status"]], "cads_api_client.Results": [[7, 3, 1, "", "asset"], [7, 3, 1, "", "content_length"], [7, 3, 1, "", "content_type"], [7, 2, 1, "", "download"], [7, 3, 1, "", "json"], [7, 3, 1, "", "location"], [7, 3, 1, "", "url"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "property", "Python property"]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:property"}, "terms": {"": 1, "120": 0, "500": 0, "60": 0, "A": [0, 1, 2, 3, 4, 5, 6, 7], "If": [0, 6, 7], "accept": 0, "accept_lic": 0, "after": 0, "all": 0, "ani": [0, 1, 2, 3, 4, 5, 6, 7], "api": [0, 8, 9], "apirespons": [1, 4, 7], "apiresponsepagin": [2, 3, 5], "appli": [0, 4], "apply_constraint": [0, 4], "asset": 7, "authent": 0, "avail": [0, 5], "bar": 0, "base": [1, 2, 3, 4, 5, 7], "bbox": 1, "begin": 1, "begin_datetim": 1, "between": 0, "bool": 0, "bound": 1, "box": 1, "byte": 7, "cad": [0, 8, 9], "cads_api_kei": 0, "cads_api_rc": 0, "cads_api_url": 0, "catalogu": [0, 1, 2], "certif": 0, "chang": 0, "check": 0, "check_authent": 0, "class": [0, 1, 2, 3, 4, 5, 6, 7, 9], "cleanup": 0, "client": [0, 8, 9], "cmip6": 0, "collect": [0, 6], "collection_id": [0, 2, 6], "complet": 0, "connect": 0, "constraint": [0, 4], "content": [0, 1, 2, 3, 4, 5, 6, 7], "content_length": 7, "content_typ": 7, "cost": [0, 4], "creat": 0, "data": 0, "dataset": 0, "datetim": 1, "default": 0, "delet": [0, 6], "dict": [0, 1, 2, 3, 4, 5, 6, 7], "dictionari": [0, 4, 7], "directori": [0, 6, 7], "displai": 0, "download": [0, 6, 7], "download_result": 0, "dure": 0, "e": [0, 1], "end": [0, 1], "end_datetim": 1, "estim": [0, 4], "estimate_cost": [0, 4], "fail": 0, "fals": 0, "field": 0, "file": [0, 6, 7], "filter": 0, "float": [0, 1], "from": 0, "full": 0, "g": 0, "get_accepted_lic": 0, "get_collect": 0, "get_job": 0, "get_lic": 0, "get_process": 0, "get_remot": 0, "get_result": 0, "how": 0, "httperror": 0, "id": [0, 1, 2, 3, 4, 5, 6], "index": 9, "infer": 0, "inform": 0, "int": [0, 7], "interact": [0, 1, 2, 3, 4, 5, 6, 7], "job": [0, 6, 7], "job_id": 3, "json": [1, 2, 3, 4, 5, 6, 7], "kei": 0, "keyword": 0, "licenc": 0, "licence_id": 0, "licens": 0, "limit": 0, "list": [0, 2, 3, 5], "locat": 7, "mani": 0, "maximum": 0, "maximum_tri": 0, "mime": 7, "modul": 9, "n": 1, "next": [2, 3, 5], "none": [0, 2, 3, 5, 6, 7], "number": 0, "object": 0, "page": [0, 2, 3, 5, 9], "paramet": [0, 1, 4, 6, 7], "path": [0, 6, 7], "per": 0, "portal": 0, "prev": [2, 3, 5], "previou": [2, 3, 5], "process": [0, 1, 2], "process_id": 5, "progress": 0, "project": 0, "properti": [1, 2, 3, 4, 5, 6, 7], "python": [8, 9], "queri": 0, "rais": 0, "read": 0, "readi": 0, "refer": 9, "relev": 0, "remot": [0, 1, 4], "request": [0, 1, 4, 6], "request_uid": [0, 6], "respons": [0, 1, 2, 3, 4, 5, 6, 7], "result": [0, 6], "retri": 0, "retriev": [0, 6, 7], "retry_aft": 0, "return": [0, 1, 2, 3, 4, 5, 6, 7], "revis": 0, "run": 0, "scope": 0, "search": [0, 9], "second": 0, "self": [2, 3, 5], "send": 0, "server": 0, "session": 0, "size": 7, "sleep_max": 0, "sort": 0, "sortbi": 0, "statu": [0, 6], "str": [0, 1, 2, 3, 4, 5, 6, 7], "submit": [0, 1, 3, 4, 6], "submit_and_wait_on_result": 0, "success": 0, "target": [0, 6, 7], "text": 0, "time": 0, "timeout": 0, "titl": 0, "tl": 0, "true": 0, "tupl": [0, 1], "type": [0, 1, 2, 3, 4, 5, 6, 7], "uid": [0, 6], "updat": 0, "url": [0, 1, 2, 3, 4, 5, 7], "valid": [0, 4], "valu": [0, 4], "verifi": 0, "w": 1, "wait": 0, "whether": 0, "while": 0, "work": [0, 6, 7]}, "titles": ["cads_api_client.ApiClient", "cads_api_client.Collection", "cads_api_client.Collections", "cads_api_client.Jobs", "cads_api_client.Process", "cads_api_client.Processes", "cads_api_client.Remote", "cads_api_client.Results", "cads_api_client", "Welcome to cads_api_client\u2019s documentation!"], "titleterms": {"": 9, "apicli": 0, "cads_api_cli": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9], "class": 8, "collect": [1, 2], "content": 9, "document": 9, "indic": 9, "job": 3, "process": [4, 5], "remot": 6, "result": 7, "tabl": 9, "welcom": 9}}) \ No newline at end of file