cecil 0.0.21__py3-none-any.whl → 0.0.23__py3-none-any.whl

cecil/client.py

@@ -1,12 +1,14 @@
 import os
-from typing import Dict, List
 
 import pandas as pd
 import requests
 import snowflake.connector
+import xarray
+
 from pydantic import BaseModel
 from requests import auth
 from cryptography.hazmat.primitives import serialization
+from typing import Dict, List, Optional
 
 from .errors import (
     Error,
@@ -31,8 +33,10 @@ from .models import (
     TransformationCreate,
     User,
     UserCreate,
+    DataRequestMetadata,
 )
 from .version import __version__
+from .xarray import load_xarray
 
 
 class Client:
@@ -43,9 +47,12 @@ class Client:
         )
         self._snowflake_user_creds = None
 
-    def create_aoi(self, name: str, geometry: Dict) -> AOI:
+    def create_aoi(self, geometry: Dict, external_ref: Optional[str] = None) -> AOI:
         # TODO: validate geometry
-        res = self._post(url="/v0/aois", model=AOICreate(name=name, geometry=geometry))
+        res = self._post(
+            url="/v0/aois",
+            model=AOICreate(geometry=geometry, external_ref=external_ref),
+        )
         return AOI(**res)
 
     def get_aoi(self, id: str) -> AOI:
@@ -56,10 +63,14 @@ class Client:
         res = self._get(url="/v0/aois")
         return [AOIRecord(**record) for record in res["records"]]
 
-    def create_data_request(self, aoi_id: str, dataset_id: str) -> DataRequest:
+    def create_data_request(
+        self, aoi_id: str, dataset_id: str, external_ref: Optional[str] = None
+    ) -> DataRequest:
         res = self._post(
             url="/v0/data-requests",
-            model=DataRequestCreate(aoi_id=aoi_id, dataset_id=dataset_id),
+            model=DataRequestCreate(
+                aoi_id=aoi_id, dataset_id=dataset_id, external_ref=external_ref
+            ),
         )
         return DataRequest(**res)
 
@@ -71,6 +82,11 @@ class Client:
         res = self._get(url="/v0/data-requests")
         return [DataRequest(**record) for record in res["records"]]
 
+    def load_xarray(self, id: str) -> xarray.Dataset:
+        res = self._get(url=f"/v0/data-requests/{id}/metadata")
+        metadata = DataRequestMetadata(**res)
+        return load_xarray(metadata)
+
     def create_transformation(
         self, data_request_id: str, crs: str, spatial_resolution: float
     ) -> Transformation:

cecil/models.py

@@ -1,5 +1,5 @@
 import datetime
-from typing import Dict, Optional
+from typing import Dict, Optional, List
 
 from pydantic import BaseModel, ConfigDict, SecretStr
 from pydantic.alias_generators import to_camel
@@ -8,7 +8,7 @@ from pydantic.alias_generators import to_camel
 class AOI(BaseModel):
     model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
     id: str
-    name: str
+    external_ref: Optional[str]
     geometry: Dict
     hectares: float
     created_at: datetime.datetime
@@ -18,7 +18,7 @@ class AOI(BaseModel):
 class AOIRecord(BaseModel):
     model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
     id: str
-    name: str
+    external_ref: Optional[str]
     hectares: float
     created_at: datetime.datetime
     created_by: str
@@ -26,8 +26,8 @@ class AOIRecord(BaseModel):
 
 class AOICreate(BaseModel):
     model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
-    name: str
     geometry: Dict
+    external_ref: Optional[str]
 
 
 class DataRequest(BaseModel):
@@ -35,6 +35,7 @@ class DataRequest(BaseModel):
     id: str
     aoi_id: str
     dataset_id: str
+    external_ref: Optional[str]
     created_at: datetime.datetime
     created_by: str
 
@@ -43,6 +44,7 @@ class DataRequestCreate(BaseModel):
     model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
     aoi_id: str
     dataset_id: str
+    external_ref: Optional[str]
 
 
 class OrganisationSettings(BaseModel):
@@ -108,3 +110,28 @@ class UserCreate(BaseModel):
     first_name: str
     last_name: str
     email: str
+
+
+class Band(BaseModel):
+    model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
+    variable_name: str
+    time: str
+    time_pattern: str
+    number: int
+
+
+class File(BaseModel):
+    model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
+    url: str
+    bands: List[Band]
+
+
+class DataRequestMetadata(BaseModel):
+    model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
+    provider_name: str
+    dataset_id: str
+    dataset_name: str
+    dataset_crs: str
+    aoi_id: str
+    data_request_id: str
+    files: List[File]

cecil/version.py

@@ -1 +1 @@
-__version__ = "0.0.21"
+__version__ = "0.0.23"

cecil/xarray.py

@@ -0,0 +1,74 @@
+import os
+import rioxarray
+import xarray
+
+from datetime import datetime
+
+from .errors import Error
+from .models import DataRequestMetadata
+
+os.environ["GDAL_NUM_THREADS"] = "1"
+os.environ["GDAL_DISABLE_READDIR_ON_OPEN"] = "FALSE"
+
+
+def align_pixel_grids(time_series):
+    # Use the first timestep as reference
+    reference_da = time_series[0]
+    aligned_series = [reference_da]
+
+    # Align all other timesteps to the reference grid
+    for i, da in enumerate(time_series[1:], 1):
+        try:
+            aligned_da = da.rio.reproject_match(reference_da)
+            aligned_series.append(aligned_da)
+        except Exception as e:
+            raise Error
+            continue
+
+    return aligned_series
+
+
+def load_xarray(metadata: DataRequestMetadata) -> xarray.Dataset:
+    data_vars = {}
+
+    for f in metadata.files:
+        dataset = rioxarray.open_rasterio(
+            f.url,
+            chunks={"x": 2000, "y": 2000},
+        )
+
+        for b in f.bands:
+            band = dataset.sel(band=b.number, drop=True)
+
+            if b.time and b.time_pattern:
+                time = datetime.strptime(b.time, b.time_pattern)
+                band = band.expand_dims("time")
+                band = band.assign_coords(time=[time])
+
+            band.name = b.variable_name
+
+            if b.variable_name not in data_vars:
+                data_vars[b.variable_name] = []
+
+            data_vars[b.variable_name].append(band)
+
+    for variable_name, time_series in data_vars.items():
+        if "time" in time_series[0].dims:
+            # time_series = align_pixel_grids(time_series)
+            data_vars[variable_name] = xarray.concat(
+                time_series, dim="time", join="exact"
+            )
+        else:
+            data_vars[variable_name] = time_series[0]
+
+    return xarray.Dataset(
+        data_vars=data_vars,
+        attrs={
+            "provider_name": metadata.provider_name,
+            "dataset_id": metadata.dataset_id,
+            "dataset_name": metadata.dataset_name,
+            "dataset_crs": metadata.dataset_crs,
+            "aoi_id": metadata.aoi_id,
+            "data_request_id": metadata.data_request_id,
+        },
+    )

{cecil-0.0.21.dist-info → cecil-0.0.23.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cecil
-Version: 0.0.21
+Version: 0.0.23
 Summary: Python SDK for Cecil Earth
 License-Expression: MIT
 License-File: LICENSE.txt

cecil-0.0.23.dist-info/RECORD

@@ -0,0 +1,10 @@
+cecil/__init__.py,sha256=AEcRl73BDSAQe6W0d1PDD87IEcumARtREl7dCVa_YQY,86
+cecil/client.py,sha256=MabuVG8UgFnjjED9duDS8cpPmPs_uT_D4M11uY2aYQk,7897
+cecil/errors.py,sha256=ZNiSTYH2MgNZ7tNIgV07-Ge3KtmdncfzWiBi9yjURGs,1818
+cecil/models.py,sha256=3W892XywxLIZL6TDCHM8_PVRHzR48bJXT5kTV7UU_bY,3509
+cecil/version.py,sha256=CO0VmekjZ_r8LBYVaUXTM3i08rEVwYKhjb9sy0X7vz0,23
+cecil/xarray.py,sha256=CvqfJ7NBMLLA4jf73ek2ZtV3sj8xOII__5S0_l3KXYI,2161
+cecil-0.0.23.dist-info/METADATA,sha256=o3aYhhB16HENBSy8mVkzfeRardw7dddyATL326yJ7Eo,2659
+cecil-0.0.23.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+cecil-0.0.23.dist-info/licenses/LICENSE.txt,sha256=mUexcmfYx3bG1VIzAdQTOf_NzStYw6-QkKVdUY_d4i4,1066
+cecil-0.0.23.dist-info/RECORD,,

cecil-0.0.21.dist-info/RECORD

@@ -1,9 +0,0 @@
-cecil/__init__.py,sha256=AEcRl73BDSAQe6W0d1PDD87IEcumARtREl7dCVa_YQY,86
-cecil/client.py,sha256=TXcTdNUF8ER8gs8KQBzHIsoQPqDLj3npFeF0PWEi4EI,7430
-cecil/errors.py,sha256=ZNiSTYH2MgNZ7tNIgV07-Ge3KtmdncfzWiBi9yjURGs,1818
-cecil/models.py,sha256=GpW1pT9NBKS5y4Os0pW8UR3MO9kVJe1r8jOK-MjADLA,2799
-cecil/version.py,sha256=PsqtE_T084MVsMv47JyTQ3DK2CRZJ3Kd9Q_vnw02oZk,23
-cecil-0.0.21.dist-info/METADATA,sha256=2Q9DsNWUMtimtqNDdDqbssyFGT33DgWaVjrYHrkLmrs,2659
-cecil-0.0.21.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-cecil-0.0.21.dist-info/licenses/LICENSE.txt,sha256=mUexcmfYx3bG1VIzAdQTOf_NzStYw6-QkKVdUY_d4i4,1066
-cecil-0.0.21.dist-info/RECORD,,