dtc-query-client 1.0.4__tar.gz

dtc_query_client-1.0.4/PKG-INFO

@@ -0,0 +1,111 @@
+Metadata-Version: 2.4
+Name: dtc_query_client
+Version: 1.0.4
+Summary: DTC Query API
+Author-email: Earthwave Ltd <support@earthwave.co.uk>
+Project-URL: Homepage, https://dtc-ice-sheets.org
+Project-URL: Documentation, https://query.dtc-ice-sheets.org/docs
+Keywords: OpenAPI,OpenAPI-Generator,DTC Query API
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: aiohttp>=3.8.4
+Requires-Dist: aiohttp-retry>=2.8.3
+Requires-Dist: pydantic>=2.11
+Requires-Dist: typing-extensions>=4.7.1
+Dynamic: license-file
+
+# DTC-IS Query Client
+This package provides a Python client for the DTC Ice Sheets Query API.
+
+DTC Ice Sheets is a Digital Twin Component designed to provide an integrated, interactive, and holistic representation of the Greenland and Antarctic ice sheet systems and their two-way interaction with the Earth system: ocean, atmosphere and solid Earth. By combining Earth Observation data, numerical models, and data science and machine learning methods into a modular, executable framework, it enables users to analyse past and present conditions, simulate future scenarios, and explore the sensitivity, response, and impact of ice-sheets under different conditions. Developed under [ESA's Digital Twin Earth programme](https://eof.esa.int/dte/), the platform delivers these capabilities as trusted, API-first services.
+
+Queries require authentication via an API token, which can be obtained at [https://query.dtc-ice-sheets.org/auth/get-token](https://query.dtc-ice-sheets.org/auth/get-token)
+
+Refer to the [API documentation](https://query.dtc-ice-sheets.org/docs) for a complete list of available endpoints and their parameters.
+
+For more information about the project, please visit [https://dtc-ice-sheets.org/](https://dtc-ice-sheets.org/).
+
+## Installation
+
+Install this package from  PyPI:
+
+```sh
+pip install dtc-query-client
+```
+
+## Getting Started
+
+Start by importing the `dtc_query_client` and creating a `Configuration` object, passing in your authentication token:
+
+```python
+import dtc_query_client
+
+configuration = dtc_query_client.Configuration(
+    host="https://query.dtc-ice-sheets.org",
+    access_token="[your private token here]"
+)
+```
+
+API requests are made inside an `async with` block. For example, this snippet retrieves a list of available datasets:
+```python
+async with dtc_query_client.ApiClient(configuration) as client:
+    datasets = await dtc_query_client.GenericApi(client).dataset_overviews()
+
+print(datasets)
+```
+
+Some endpoints start a long-running job and return a job ID. This job ID can be used to track how the job is progressing, and to obtain results once the job completes. It is recommended to use the `wait_for_job()` or `iterate_job()` helper functions to handle these endpoints gracefully.
+
+The example snippet below uses the simpler `wait_for_job()`, which waits for the job to complete and returns the completed job state:
+```python
+async with dtc_query_client.ApiClient(configuration) as client:
+    # Start a job and get the job ID
+    response = await dtc_query_client.StateAndFateApi(client).run_summary_zarr_to_json(
+        ice_shelf_id="thwaites",
+    )
+    job_id = response.job_id
+    print(f"Started job with ID {job_id}")
+    
+    # Wait for job to complete
+    try:
+        job_state = await dtc_query_client.wait_for_job(client, job_id)
+    except RuntimeError as e:
+        # Failed jobs will raise a RuntimeError
+        print("Job has failed!")
+        raise e
+    
+    # Job has completed! Print results
+    print(f"Job completed successfully with status {job_state.status}.")
+    output_url = job_state.outputs["timeseries-zarr-to-json-module"]["output_json"]
+    print(f"Results URL: {output_url}")
+```
+
+Alternatively, the example snippet below uses the more advanced `iterate_job()`, which does the same thing but additionally provides live updates on job progress while it is running:
+```python
+async with dtc_query_client.ApiClient(configuration) as client:
+    # Start a job and get the job ID
+    response = await dtc_query_client.StateAndFateApi(client).run_summary_zarr_to_json(
+        ice_shelf_id="thwaites",
+    )
+    job_id = response.job_id
+    print(f"Started job with ID {job_id}")
+    
+    # Wait for job to complete, printing information on the job state as it progresses
+    try:
+        async for job_state in dtc_query_client.iterate_job(client, job_id):
+            print(
+                f"Job has status {job_state.status}.\n"
+                f"It has completed {job_state.progress_done} steps out of {job_state.progress_total}."
+            )
+    except RuntimeError as e:
+        # Failed jobs will raise a RuntimeError
+        print("Job has failed!")
+        raise e
+    
+    # Job has completed! Print results
+    print(f"Job completed successfully with status {job_state.status}.")
+    output_url = job_state.outputs["timeseries-zarr-to-json-module"]["output_json"]
+    print(f"Results URL: {output_url}")
+```

dtc_query_client-1.0.4/README.md

@@ -0,0 +1,93 @@
+# DTC-IS Query Client
+This package provides a Python client for the DTC Ice Sheets Query API.
+
+DTC Ice Sheets is a Digital Twin Component designed to provide an integrated, interactive, and holistic representation of the Greenland and Antarctic ice sheet systems and their two-way interaction with the Earth system: ocean, atmosphere and solid Earth. By combining Earth Observation data, numerical models, and data science and machine learning methods into a modular, executable framework, it enables users to analyse past and present conditions, simulate future scenarios, and explore the sensitivity, response, and impact of ice-sheets under different conditions. Developed under [ESA's Digital Twin Earth programme](https://eof.esa.int/dte/), the platform delivers these capabilities as trusted, API-first services.
+
+Queries require authentication via an API token, which can be obtained at [https://query.dtc-ice-sheets.org/auth/get-token](https://query.dtc-ice-sheets.org/auth/get-token)
+
+Refer to the [API documentation](https://query.dtc-ice-sheets.org/docs) for a complete list of available endpoints and their parameters.
+
+For more information about the project, please visit [https://dtc-ice-sheets.org/](https://dtc-ice-sheets.org/).
+
+## Installation
+
+Install this package from  PyPI:
+
+```sh
+pip install dtc-query-client
+```
+
+## Getting Started
+
+Start by importing the `dtc_query_client` and creating a `Configuration` object, passing in your authentication token:
+
+```python
+import dtc_query_client
+
+configuration = dtc_query_client.Configuration(
+    host="https://query.dtc-ice-sheets.org",
+    access_token="[your private token here]"
+)
+```
+
+API requests are made inside an `async with` block. For example, this snippet retrieves a list of available datasets:
+```python
+async with dtc_query_client.ApiClient(configuration) as client:
+    datasets = await dtc_query_client.GenericApi(client).dataset_overviews()
+
+print(datasets)
+```
+
+Some endpoints start a long-running job and return a job ID. This job ID can be used to track how the job is progressing, and to obtain results once the job completes. It is recommended to use the `wait_for_job()` or `iterate_job()` helper functions to handle these endpoints gracefully.
+
+The example snippet below uses the simpler `wait_for_job()`, which waits for the job to complete and returns the completed job state:
+```python
+async with dtc_query_client.ApiClient(configuration) as client:
+    # Start a job and get the job ID
+    response = await dtc_query_client.StateAndFateApi(client).run_summary_zarr_to_json(
+        ice_shelf_id="thwaites",
+    )
+    job_id = response.job_id
+    print(f"Started job with ID {job_id}")
+    
+    # Wait for job to complete
+    try:
+        job_state = await dtc_query_client.wait_for_job(client, job_id)
+    except RuntimeError as e:
+        # Failed jobs will raise a RuntimeError
+        print("Job has failed!")
+        raise e
+    
+    # Job has completed! Print results
+    print(f"Job completed successfully with status {job_state.status}.")
+    output_url = job_state.outputs["timeseries-zarr-to-json-module"]["output_json"]
+    print(f"Results URL: {output_url}")
+```
+
+Alternatively, the example snippet below uses the more advanced `iterate_job()`, which does the same thing but additionally provides live updates on job progress while it is running:
+```python
+async with dtc_query_client.ApiClient(configuration) as client:
+    # Start a job and get the job ID
+    response = await dtc_query_client.StateAndFateApi(client).run_summary_zarr_to_json(
+        ice_shelf_id="thwaites",
+    )
+    job_id = response.job_id
+    print(f"Started job with ID {job_id}")
+    
+    # Wait for job to complete, printing information on the job state as it progresses
+    try:
+        async for job_state in dtc_query_client.iterate_job(client, job_id):
+            print(
+                f"Job has status {job_state.status}.\n"
+                f"It has completed {job_state.progress_done} steps out of {job_state.progress_total}."
+            )
+    except RuntimeError as e:
+        # Failed jobs will raise a RuntimeError
+        print("Job has failed!")
+        raise e
+    
+    # Job has completed! Print results
+    print(f"Job completed successfully with status {job_state.status}.")
+    output_url = job_state.outputs["timeseries-zarr-to-json-module"]["output_json"]
+    print(f"Results URL: {output_url}")
+```

dtc_query_client-1.0.4/dtc_query_client/__init__.py

@@ -0,0 +1,113 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    DTC Query API
+
+    API for interacting with the DTC Ice Sheets system.<br><br>To authenticate, please navigate to <a href='https://query.dtc-ice-sheets.org/auth/get-token' target='_blank'>https://query.dtc-ice-sheets.org/auth/get-token</a> and include the obtained HTTPBearer token in the Authorization header for subsequent requests. <br><br>For more information on the project, please visit <a href='https://dtc-ice-sheets.org/' target='_blank'>https://dtc-ice-sheets.org/</a>.
+
+    The version of the OpenAPI document: 0.0.62
+    Contact: support@earthwave.co.uk
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+__version__ = "1.0.4"
+
+# Define package exports
+__all__ = [
+    "AuthApi",
+    "GeneralApi",
+    "GenericApi",
+    "JobsApi",
+    "SeaLevelResponseApi",
+    "StateAndFateApi",
+    "ApiResponse",
+    "ApiClient",
+    "Configuration",
+    "OpenApiException",
+    "ApiTypeError",
+    "ApiValueError",
+    "ApiKeyError",
+    "ApiAttributeError",
+    "ApiException",
+    "CovariateAnalysisRequest",
+    "CovariateAnalysisType",
+    "DataDownloadRequest",
+    "DatasetID",
+    "DatasetOverview",
+    "DatasetSummaryRequest",
+    "Epsg4326PolygonJson",
+    "FutureProjectionRequest",
+    "GenericResultURL",
+    "HTTPValidationError",
+    "IceShelfExtent",
+    "JobStatus",
+    "JobStatusResponse",
+    "JobSubmissionResponse",
+    "LocationInner",
+    "LogEvents",
+    "MultiPolygonModel",
+    "PolygonModel",
+    "ResponseGetGeometryIceShelvesIceShelfIdGeometryExtentGet",
+    "SeaLevelResponseRequest",
+    "SpatialCoverageOfTheDataset",
+    "StateAndFateVariablesResponseDataset",
+    "StateAndFateVariablesResponseVariable",
+    "ValidationError",
+    "VariableItem",
+    "VariableOverview",
+    "WhatIfRequest",
+]
+
+# import apis into sdk package
+from dtc_query_client.api.auth_api import AuthApi as AuthApi
+from dtc_query_client.api.general_api import GeneralApi as GeneralApi
+from dtc_query_client.api.generic_api import GenericApi as GenericApi
+from dtc_query_client.api.jobs_api import JobsApi as JobsApi
+from dtc_query_client.api.sea_level_response_api import SeaLevelResponseApi as SeaLevelResponseApi
+from dtc_query_client.api.state_and_fate_api import StateAndFateApi as StateAndFateApi
+
+# import ApiClient
+from dtc_query_client.api_response import ApiResponse as ApiResponse
+from dtc_query_client.api_client import ApiClient as ApiClient
+from dtc_query_client.configuration import Configuration as Configuration
+from dtc_query_client.exceptions import OpenApiException as OpenApiException
+from dtc_query_client.exceptions import ApiTypeError as ApiTypeError
+from dtc_query_client.exceptions import ApiValueError as ApiValueError
+from dtc_query_client.exceptions import ApiKeyError as ApiKeyError
+from dtc_query_client.exceptions import ApiAttributeError as ApiAttributeError
+from dtc_query_client.exceptions import ApiException as ApiException
+
+# import models into sdk package
+from dtc_query_client.models.covariate_analysis_request import CovariateAnalysisRequest as CovariateAnalysisRequest
+from dtc_query_client.models.covariate_analysis_type import CovariateAnalysisType as CovariateAnalysisType
+from dtc_query_client.models.data_download_request import DataDownloadRequest as DataDownloadRequest
+from dtc_query_client.models.dataset_id import DatasetID as DatasetID
+from dtc_query_client.models.dataset_overview import DatasetOverview as DatasetOverview
+from dtc_query_client.models.dataset_summary_request import DatasetSummaryRequest as DatasetSummaryRequest
+from dtc_query_client.models.epsg4326_polygon_json import Epsg4326PolygonJson as Epsg4326PolygonJson
+from dtc_query_client.models.future_projection_request import FutureProjectionRequest as FutureProjectionRequest
+from dtc_query_client.models.generic_result_url import GenericResultURL as GenericResultURL
+from dtc_query_client.models.http_validation_error import HTTPValidationError as HTTPValidationError
+from dtc_query_client.models.ice_shelf_extent import IceShelfExtent as IceShelfExtent
+from dtc_query_client.models.job_status import JobStatus as JobStatus
+from dtc_query_client.models.job_status_response import JobStatusResponse as JobStatusResponse
+from dtc_query_client.models.job_submission_response import JobSubmissionResponse as JobSubmissionResponse
+from dtc_query_client.models.location_inner import LocationInner as LocationInner
+from dtc_query_client.models.log_events import LogEvents as LogEvents
+from dtc_query_client.models.multi_polygon_model import MultiPolygonModel as MultiPolygonModel
+from dtc_query_client.models.polygon_model import PolygonModel as PolygonModel
+from dtc_query_client.models.response_get_geometry_ice_shelves_ice_shelf_id_geometry_extent_get import ResponseGetGeometryIceShelvesIceShelfIdGeometryExtentGet as ResponseGetGeometryIceShelvesIceShelfIdGeometryExtentGet
+from dtc_query_client.models.sea_level_response_request import SeaLevelResponseRequest as SeaLevelResponseRequest
+from dtc_query_client.models.spatial_coverage_of_the_dataset import SpatialCoverageOfTheDataset as SpatialCoverageOfTheDataset
+from dtc_query_client.models.state_and_fate_variables_response_dataset import StateAndFateVariablesResponseDataset as StateAndFateVariablesResponseDataset
+from dtc_query_client.models.state_and_fate_variables_response_variable import StateAndFateVariablesResponseVariable as StateAndFateVariablesResponseVariable
+from dtc_query_client.models.validation_error import ValidationError as ValidationError
+from dtc_query_client.models.variable_item import VariableItem as VariableItem
+from dtc_query_client.models.variable_overview import VariableOverview as VariableOverview
+from dtc_query_client.models.what_if_request import WhatIfRequest as WhatIfRequest
+

dtc_query_client-1.0.4/dtc_query_client/api/__init__.py

@@ -0,0 +1,10 @@
+# flake8: noqa
+
+# import apis into api package
+from dtc_query_client.api.auth_api import AuthApi
+from dtc_query_client.api.general_api import GeneralApi
+from dtc_query_client.api.generic_api import GenericApi
+from dtc_query_client.api.jobs_api import JobsApi
+from dtc_query_client.api.sea_level_response_api import SeaLevelResponseApi
+from dtc_query_client.api.state_and_fate_api import StateAndFateApi
+