eotdl 2023.11.2.post5__py3-none-any.whl → 2023.11.3.post2__py3-none-any.whl

eotdl/access/airbus/parameters.py

@@ -2,7 +2,11 @@
 Parameters to access Airbus data
 """
 
-class AirbusURL():
+
+class AirbusURL:
+    """
+    AIRBUS URLs
+    """
     PRICES = "https://data.api.oneatlas.airbus.com/api/v1/prices"
     ORDERS = "https://data.api.oneatlas.airbus.com/api/v1/orders"
     SEARCH = "https://search.foundation.api.oneatlas.airbus.com/api/v2/opensearch?constellation=SPOT"
@@ -10,16 +14,27 @@ class AirbusURL():
     ACCOUNT = "https://data.api.oneatlas.airbus.com/api/v1/me"
     ROLES = "https://data.api.oneatlas.airbus.com/api/v1/me/services"
 
+
 # Types are defined at: https://www.geoapi-airbusds.com/api-catalog-v2/oad-living-library/tutorials/#order-an-individual-product
 
-class AirbusProductType():
+
+class AirbusProductType:
+    """
+    Airbus product types
+    """
     MULTISPECTRAL = "multiSpectral"
 
 
-class AirbusRadiometricProcessing():
+class AirbusRadiometricProcessing:
+    """
+    Airbus radiometric processing
+    """
     REFLECTANCE = "REFLECTANCE"
 
 
-class AirbusImageFormat():
+class AirbusImageFormat:
+    """
+    Airbus image format
+    """
     GEOTIFF = "image/geotiff"
     JP2 = "image/jp2"

eotdl/access/airbus/utils.py

@@ -6,24 +6,29 @@ import requests
 
 
 def get_airbus_access_token(api_key: str) -> str:
-  """
-  Get Airbus access token
-
-  Returns:
-    str: access token
-  """
-  headers = {
-      'Content-Type': 'application/x-www-form-urlencoded',
-  }
-
-  data = [
-    ('apikey', api_key),
-    ('grant_type', 'api_key'),
-    ('client_id', 'IDP'),
-  ]
-
-  response = requests.post('https://authenticate.foundation.api.oneatlas.airbus.com/auth/realms/IDP/protocol/openid-connect/token', headers=headers, data=data)
-
-  access_token = response.json()['access_token']
-
-  return access_token
+    """
+    Get Airbus access token
+
+    Returns:
+      str: access token
+    """
+    headers = {
+        "Content-Type": "application/x-www-form-urlencoded",
+    }
+
+    data = [
+        ("apikey", api_key),
+        ("grant_type", "api_key"),
+        ("client_id", "IDP"),
+    ]
+
+    response = requests.post(
+        "https://authenticate.foundation.api.oneatlas.airbus.com/auth/realms/IDP/protocol/openid-connect/token",
+        headers=headers,
+        data=data,
+        timeout=60
+    )
+
+    access_token = response.json()["access_token"]
+
+    return access_token

eotdl/access/download.py

@@ -1,16 +1,28 @@
-from .sentinelhub import SHClient, SH_PARAMETERS_DICT, evaluate_sentinel_parameters, imagery_from_tmp_to_dir
-from .search import search_sentinel_imagery
+"""
+Download imagery
+"""
 
-from shutil import rmtree
 from datetime import datetime
 from typing import Union, List
 
+from .sentinelhub import (
+    SHClient,
+    SH_PARAMETERS_DICT,
+    evaluate_sentinel_parameters,
+    imagery_from_tmp_to_dir,
+)
+from .search import search_sentinel_imagery
+
 
-def download_sentinel_imagery(output: str,
-                              time_interval: Union[str, datetime, List[Union[str, datetime]]],
-                              bounding_box: List[Union[int, float]],
-                              sensor: str,
-                              ) -> None:
+def download_sentinel_imagery(
+    output: str,
+    time_interval: Union[str, datetime, List[Union[str, datetime]]],
+    bounding_box: List[Union[int, float]],
+    sensor: str,
+) -> None:
+    """
+    Download Sentinel imagery
+    """
     evaluate_sentinel_parameters(sensor, time_interval, bounding_box, output)
 
     client = SHClient()
@@ -21,11 +33,15 @@ def download_sentinel_imagery(output: str,
     imagery_from_tmp_to_dir(output)
 
 
-def search_and_download_sentinel_imagery(output: str,
-                              time_interval: Union[str, datetime, List[Union[str, datetime]]],
-                              bounding_box: List[Union[int, float]],
-                              sensor: str,
-                              ) -> None:
+def search_and_download_sentinel_imagery(
+    output: str,
+    time_interval: Union[str, datetime, List[Union[str, datetime]]],
+    bounding_box: List[Union[int, float]],
+    sensor: str,
+) -> None:
+    """
+    Search and download Sentinel imagery
+    """
     evaluate_sentinel_parameters(sensor, time_interval, bounding_box, output)
 
     client = SHClient()
@@ -34,7 +50,7 @@ def search_and_download_sentinel_imagery(output: str,
     results = search_sentinel_imagery(time_interval, bounding_box, sensor)
     timestamps = [date.strftime("%Y-%m-%d") for date in results.get_timestamps()]
 
-    requests_list = list()
+    requests_list = []
     for date in timestamps:
         requests_list.append(client.request_data(date, bounding_box, parameters))
     client.download_data(requests_list)

eotdl/access/search.py

@@ -1,13 +1,24 @@
-from .sentinelhub import SHClient, SH_PARAMETERS_DICT, evaluate_sentinel_parameters
+"""
+Search imagery
+"""
+
 from typing import Union, List
 from datetime import datetime
 
+from .sentinelhub import SHClient, SH_PARAMETERS_DICT, evaluate_sentinel_parameters
+
 
-def search_sentinel_imagery(time_interval: Union[str, datetime, List[Union[str, datetime]]],
-                            bounding_box: List[Union[int, float]],
-                            sensor: str,
-                            ) -> None:
-    evaluate_sentinel_parameters(sensor, time_interval, bounding_box, output_needed=False)
+def search_sentinel_imagery(
+    time_interval: Union[str, datetime, List[Union[str, datetime]]],
+    bounding_box: List[Union[int, float]],
+    sensor: str,
+) -> None:
+    """
+    Search Sentinel imagery
+    """
+    evaluate_sentinel_parameters(
+        sensor, time_interval, bounding_box, output_needed=False
+    )
 
     client = SHClient()
     parameters = SH_PARAMETERS_DICT[sensor]()

eotdl/access/sentinelhub/__init__.py

@@ -1,4 +1,8 @@
+"""
+Sentinel-Hub data access module.
+"""
+
 from .client import SHClient
 from .parameters import SHParameters, SH_PARAMETERS_DICT
 from .evalscripts import EvalScripts
-from .utils import evaluate_sentinel_parameters, imagery_from_tmp_to_dir
+from .utils import evaluate_sentinel_parameters, imagery_from_tmp_to_dir

eotdl/access/sentinelhub/client.py

@@ -5,14 +5,16 @@ Module for managing the Sentinel Hub configuration and data access
 import json
 from os import getenv
 from os.path import exists
-from sentinelhub import (SHConfig, 
-                         SentinelHubCatalog, 
-                         BBox, 
-                         bbox_to_dimensions, 
-                         CRS, 
-                         SentinelHubRequest, 
-                         SentinelHubDownloadClient,
-                         MimeType)
+from sentinelhub import (
+    SHConfig,
+    SentinelHubCatalog,
+    BBox,
+    bbox_to_dimensions,
+    CRS,
+    SentinelHubRequest,
+    SentinelHubDownloadClient,
+    MimeType,
+)
 
 from ...repos.AuthRepo import AuthRepo
 from .parameters import SHParameters
@@ -20,86 +22,87 @@ from ...tools.time_utils import prepare_time_interval
 from ...tools.geo_utils import compute_image_size
 
 
-class SHClient():
+class SHClient:
     """
     Client class to manage the Sentinel Hub Python interface.
     """
 
-    def __init__(self
-                 ) -> None:
-        """
-        """
+    def __init__(self) -> None:
+        """ """
         self.config = SHConfig()
-        if getenv('SH_CLIENT_ID') and getenv('SH_CLIENT_SECRET'):
+        if getenv("SH_CLIENT_ID") and getenv("SH_CLIENT_SECRET"):
             # If the user has provided the credentials in a .env file, we should save them
-            self.config.sh_client_id = getenv('SH_CLIENT_ID')
-            self.config.sh_client_secret = getenv('SH_CLIENT_SECRET')
+            self.config.sh_client_id = getenv("SH_CLIENT_ID")
+            self.config.sh_client_secret = getenv("SH_CLIENT_SECRET")
         else:
             # If the user has not provided the credentials, we should check if
             # the user is logged in
             auth_repo = AuthRepo()
             creds_file = auth_repo.creds_path
             if not exists(creds_file):
-                raise ValueError('Your are not logged in and have not provided Sentinel Hub credentials. Please, crete a .env file with your SH_CLIENT_ID and SH_CLIENT_SECRET, or login')
+                raise ValueError(
+                    "Your are not logged in and have not provided Sentinel Hub credentials. Please, crete a .env file with your SH_CLIENT_ID and SH_CLIENT_SECRET, or login"
+                )
             else:
-                creds = json.load(open(creds_file, 'r'))
-                if not 'SH_CLIENT_ID' in creds.keys() or not 'SH_CLIENT_SECRET' in creds.keys():
-                    raise ValueError('If you already had a Sentinel HUB account before accepting the Terms and Conditions, your SH credentials will NOT appear here. You can retrieve them from you Sentinel HUB dashboard)')
+                with open(creds_file, "r", encoding="utd-8") as f:
+                    creds = json.load(f)
+                if (
+                    "SH_CLIENT_ID" not in creds.keys()
+                    or "SH_CLIENT_SECRET" not in creds.keys()
+                ):
+                    raise ValueError(
+                        "If you already had a Sentinel HUB account before accepting the Terms and Conditions, your SH credentials will NOT appear here. You can retrieve them from you Sentinel HUB dashboard)"
+                    )
                 else:
-                    self.config.sh_client_id = creds['SH_CLIENT_ID']
-                    self.config.sh_client_secret = creds['SH_CLIENT_SECRET']
+                    self.config.sh_client_id = creds["SH_CLIENT_ID"]
+                    self.config.sh_client_secret = creds["SH_CLIENT_SECRET"]
         self.catalog = SentinelHubCatalog(config=self.config)
-        self.tmp_dir = '/tmp/sentinelhub' 
+        self.tmp_dir = "/tmp/sentinelhub"
 
-    def search_data(self,
-                    bounding_box: list,
-                    time_interval: list,
-                    parameters: SHParameters
-                    ) -> list:
+    def search_data(
+        self, bounding_box: list, time_interval: list, parameters: SHParameters
+    ) -> list:
         """
+        Search data from Sentinel Hub
         """
         search_iterator = self.catalog.search(
             parameters.DATA_COLLECTION,
             bbox=BBox(bounding_box, crs=CRS.WGS84),
             time=time_interval,
             filter=parameters.FILTER,
-            fields=parameters.FIELDS
+            fields=parameters.FIELDS,
         )
 
         return search_iterator
-    
-    def request_data(self,
-                     time_interval,
-                     bounding_box: list,
-                     parameters: SHParameters
-                     ) -> list:
+
+    def request_data(
+        self, time_interval, bounding_box: list, parameters: SHParameters
+    ) -> list:
         """
+        Request data from Sentinel Hub
         """
         time_interval = prepare_time_interval(time_interval)
-        bounding_box, bounding_box_size = compute_image_size(bounding_box, parameters)
+        bounding_box, _ = compute_image_size(bounding_box, parameters)
 
         return SentinelHubRequest(
-                    data_folder=self.tmp_dir,
-                    evalscript=parameters.EVALSCRIPT,
-                    input_data=[
-                        SentinelHubRequest.input_data(
-                            data_collection=parameters.DATA_COLLECTION,
-                            time_interval=time_interval,
-                            mosaicking_order=parameters.MOSAICKING_ORDER,
-                        )
-                    ],
-                    responses=[
-                                SentinelHubRequest.output_response("default", MimeType.TIFF)
-                    ],
-                    bbox=bounding_box,
-                    size=bbox_to_dimensions(bounding_box, parameters.RESOLUTION),
-                    config=self.config,
+            data_folder=self.tmp_dir,
+            evalscript=parameters.EVALSCRIPT,
+            input_data=[
+                SentinelHubRequest.input_data(
+                    data_collection=parameters.DATA_COLLECTION,
+                    time_interval=time_interval,
+                    mosaicking_order=parameters.MOSAICKING_ORDER,
                 )
+            ],
+            responses=[SentinelHubRequest.output_response("default", MimeType.TIFF)],
+            bbox=bounding_box,
+            size=bbox_to_dimensions(bounding_box, parameters.RESOLUTION),
+            config=self.config,
+        )
 
-    def download_data(self,
-                      requests: list
-                      ) -> list:
+    def download_data(self, requests: list) -> list:
         """
+        Download data from Sentinel Hub
         """
         download_client = SentinelHubDownloadClient(config=self.config)
         if not isinstance(requests, list):

eotdl/access/sentinelhub/evalscripts.py

@@ -1,6 +1,6 @@
-'''
+"""
 Evalscripts for Sentinel Hub requests
-'''
+"""
 
 
 class EvalScripts:
@@ -26,24 +26,24 @@ class EvalScripts:
                     return [sample.VH, sample.VV];
                 }
                 """
-    
+
     SENTINEL_2_L1C = """
                 //VERSION=3
                 function setup() {
                     return {
                         input: [{
-                            bands: ["B01", 
-                                    "B02", 
-                                    "B03", 
+                            bands: ["B01",
+                                    "B02",
+                                    "B03",
                                     "B04",
-                                    "B05", 
-                                    "B06", 
-                                    "B07", 
-                                    "B08", 
+                                    "B05",
+                                    "B06",
+                                    "B07",
+                                    "B08",
                                     "B8A",
                                     "B09",
                                     "B10",
-                                    "B11", 
+                                    "B11",
                                     "B12"],
                             units: "DN"
                         }],
@@ -59,39 +59,38 @@ class EvalScripts:
                 }
 
                 function evaluatePixel(sample) {
-                    return [sample.B01, 
-                            sample.B02, 
-                            sample.B03, 
-                            sample.B04, 
-                            sample.B05, 
-                            sample.B06, 
-                            sample.B07, 
-                            sample.B08, 
+                    return [sample.B01,
+                            sample.B02,
+                            sample.B03,
+                            sample.B04,
+                            sample.B05,
+                            sample.B06,
+                            sample.B07,
+                            sample.B08,
                             sample.B8A,
                             sample.B09,
                             sample.B10,
-                            sample.B11, 
+                            sample.B11,
                             sample.B12];
                 }
                 """
 
-    
     SENTINEL_2_L2A = """
                 //VERSION=3
                 function setup() {
                     return {
                         input: [{
-                            bands: ["B01", 
-                                    "B02", 
-                                    "B03", 
+                            bands: ["B01",
+                                    "B02",
+                                    "B03",
                                     "B04",
-                                    "B05", 
-                                    "B06", 
-                                    "B07", 
-                                    "B08", 
+                                    "B05",
+                                    "B06",
+                                    "B07",
+                                    "B08",
                                     "B8A",
                                     "B09",
-                                    "B11", 
+                                    "B11",
                                     "B12"],
                             units: "DN"
                         }],
@@ -103,21 +102,21 @@ class EvalScripts:
                 }
 
                 function evaluatePixel(sample) {
-                    return [sample.B01, 
-                            sample.B02, 
-                            sample.B03, 
-                            sample.B04, 
-                            sample.B05, 
-                            sample.B06, 
-                            sample.B07, 
-                            sample.B08, 
+                    return [sample.B01,
+                            sample.B02,
+                            sample.B03,
+                            sample.B04,
+                            sample.B05,
+                            sample.B06,
+                            sample.B07,
+                            sample.B08,
                             sample.B8A,
                             sample.B09,
-                            sample.B11, 
+                            sample.B11,
                             sample.B12];
                 }
                 """
-    
+
     DEM = """
         //VERSION=3
 

eotdl/access/sentinelhub/parameters.py

@@ -8,50 +8,70 @@ from .evalscripts import EvalScripts
 
 
 class SHParameters:
-
+    """
+    Sentinel Hub Parameters base class
+    """
     def __init__(self):
         pass
 
 
 class SHS2L2AParameters(SHParameters):
+    """
+    Sentinel-2-L2A parameters
+    """
     DATA_COLLECTION = DataCollection.SENTINEL2_L2A
     RESOLUTION = 10
     MOSAICKING_ORDER = MosaickingOrder.LEAST_CC
     EVALSCRIPT = EvalScripts.SENTINEL_2_L2A
-    FIELDS = {"include": ["id", 
-                        "properties.datetime",
-                        "properties.eo:cloud_cover"], 
-            "exclude": []}
+    FIELDS = {
+        "include": ["id", "properties.datetime", "properties.eo:cloud_cover"],
+        "exclude": [],
+    }
     FILTER = None
 
 
 class SHS2L1CParameters(SHParameters):
+    """
+    Sentinel-2-L1C parameters
+    """
     DATA_COLLECTION = DataCollection.SENTINEL2_L1C
     RESOLUTION = 10
     MOSAICKING_ORDER = MosaickingOrder.LEAST_CC
     EVALSCRIPT = EvalScripts.SENTINEL_2_L1C
-    FIELDS = {"include": ["id", 
-                        "properties.datetime",
-                        "properties.eo:cloud_cover"], 
-            "exclude": []}
-    
+    FIELDS = {
+        "include": ["id", "properties.datetime", "properties.eo:cloud_cover"],
+        "exclude": [],
+    }
+
 
 class SHS1Parameters(SHParameters):
+    """
+    Sentinel-1 parameters
+    """
     DATA_COLLECTION = DataCollection.SENTINEL1
     RESOLUTION = 3
     EVALSCRIPT = EvalScripts.SENTINEL_1
-    FIELDS = {"include": ["id", 
-                        "properties.datetime",
-                        "sar:instrument_mode", 
-                        "s1:polarization",
-                        "sat:orbit_state",
-                        "s1:resolution",
-                        "s1:timeliness"], 
-            "exclude": []},
+    FIELDS = (
+        {
+            "include": [
+                "id",
+                "properties.datetime",
+                "sar:instrument_mode",
+                "s1:polarization",
+                "sat:orbit_state",
+                "s1:resolution",
+                "s1:timeliness",
+            ],
+            "exclude": [],
+        },
+    )
     FILTER = None
 
 
 class SHDEMParameters(SHParameters):
+    """
+    Copernicus DEM parameters
+    """
     DATA_COLLECTION = DataCollection.DEM_COPERNICUS_30
     RESOLUTION = 3
     MOSAICKING_ORDER = None
@@ -60,11 +80,11 @@ class SHDEMParameters(SHParameters):
     FIELDS = None
 
 
-SUPPORTED_SENSORS = ('sentinel-1-grd', 'sentinel-2-l1c', 'sentinel-2-l2a', 'dem')
+SUPPORTED_SENSORS = ("sentinel-1-grd", "sentinel-2-l1c", "sentinel-2-l2a", "dem")
 
 SH_PARAMETERS_DICT = {
-    'sentinel-1-grd': SHS1Parameters,
-    'sentinel-2-l1c': SHS2L1CParameters,
-    'sentinel-2-l2a': SHS2L2AParameters,
-    'dem': SHDEMParameters
+    "sentinel-1-grd": SHS1Parameters,
+    "sentinel-2-l1c": SHS2L1CParameters,
+    "sentinel-2-l2a": SHS2L2AParameters,
+    "dem": SHDEMParameters,
 }