openforis-whisp 2.0.0a5__py3-none-any.whl → 2.0.0a6__py3-none-any.whl

openforis_whisp/utils.py

@@ -1,154 +1,154 @@
-import base64
-import ee
-import math
-import os
-import pandas as pd
-
-import importlib.resources as pkg_resources
-
-from dotenv import load_dotenv
-from pathlib import Path
-
-from .logger import StdoutLogger
-
-
-logger = StdoutLogger(__name__)
-
-
-def get_example_data_path(filename):
-    """
-    Get the path to an example data file included in the package.
-
-    Parameters:
-    -----------
-    filename : str
-        The name of the example data file.
-
-    Returns:
-    --------
-    str
-        The path to the example data file.
-    """
-    return os.path.join("..", "tests", "fixtures", filename)
-
-
-def load_env_vars() -> None:
-    """Loads the environment variables required for testing the codebase.
-
-    Returns
-    -------
-    out : None
-    """
-
-    all_dotenv_paths = [Path(__file__).parents[2] / ".env", Path.cwd() / ".env"]
-    dotenv_loaded = False
-
-    for dotenv_path in all_dotenv_paths:
-        logger.logger.debug(f"dotenv_path: {dotenv_path}")
-        if dotenv_path.exists():
-            dotenv_loaded = load_dotenv(dotenv_path)
-            break
-
-    if not dotenv_loaded:
-        raise DotEnvNotFoundError
-    logger.logger.info(f"Loaded evironment variables from '{dotenv_path}'")
-
-
-def init_ee() -> None:
-    """Initialize earth engine according to the environment"""
-
-    # only do the initialization if the credential are missing
-    if not ee.data._credentials:
-
-        # if in test env use the private key
-        if "EE_PRIVATE_KEY" in os.environ:
-
-            # key need to be decoded in a file
-            content = base64.b64decode(os.environ["EE_PRIVATE_KEY"]).decode()
-            with open("ee_private_key.json", "w") as f:
-                f.write(content)
-
-            # connection to the service account
-            service_account = "test-sepal-ui@sepal-ui.iam.gserviceaccount.com"
-            credentials = ee.ServiceAccountCredentials(
-                service_account, "ee_private_key.json"
-            )
-            ee.Initialize(credentials)
-            logger.logger.info(f"Used env var")
-
-        # if in local env use the local user credential
-        else:
-            try:
-                load_env_vars()
-                logger.logger.info("Called 'ee.Initialize()'.")
-                ee.Initialize(project=os.environ["PROJECT"])
-            except ee.ee_exception.EEException:
-                logger.logger.info("Called 'ee.Authenticate()'.")
-                ee.Authenticate()
-                ee.Initialize(project=os.environ["PROJECT"])
-
-
-def clear_ee_credentials():
-
-    path_to_creds = Path().home() / ".config" / "earthengine" / "credentials"
-    if not path_to_creds.exists():
-        logger.logger.error(
-            f"GEE credentials file '{path_to_creds}' not found, could not de-authenticate."
-        )
-    else:
-        path_to_creds.unlink()
-        logger.logger.warning(f"GEE credentials file deleted.")
-
-
-def remove_geometry_from_feature_collection(feature_collection):
-    """Define the function to remove geometry from features in a feature collection"""
-    # Function to remove geometry from features
-    def remove_geometry(feature):
-        # Remove the geometry property
-        feature = feature.setGeometry(None)
-        return feature
-
-    # Apply the function to remove geometry to the feature collection
-    feature_collection_no_geometry = feature_collection.map(remove_geometry)
-    return feature_collection_no_geometry
-
-
-# Compute centroids of each polygon including the external_id_column
-def get_centroid(feature, external_id_column="external_id"):
-    keepProperties = [external_id_column]
-    # Get the centroid of the feature's geometry.
-    centroid = feature.geometry().centroid(1)
-    # Return a new Feature, copying properties from the old Feature.
-    return ee.Feature(centroid).copyProperties(feature, keepProperties)
-
-
-def buffer_point_to_required_area(feature, area, area_unit):
-    """buffers feature to get a given area (needs math library); area unit in 'ha' or 'km2' (the default)"""
-    area = feature.get("REP_AREA")
-
-    # buffer_size = get_radius_m_to_buffer_for_given_area(area,"km2")# should work but untested in this function
-
-    buffer_size = (
-        (ee.Number(feature.get("REP_AREA")).divide(math.pi)).sqrt().multiply(1000)
-    )  # calculating radius in metres from REP_AREA in km2
-
-    return ee.Feature(feature).buffer(buffer_size, 1)
-    ### buffering (incl., max error parameter should be 0m. But put as 1m anyhow - doesn't seem to make too much of a difference for speed)
-
-
-def get_radius_m_to_buffer_to_required_area(area, area_unit="km2"):
-    """gets radius in metres to buffer to get an area (needs math library); area unit ha or km2 (the default)"""
-    if area_unit == "km2":
-        unit_fix_factor = 1000
-    elif area_unit == "ha":
-        unit_fix_factor = 100
-    radius = ee.Number(area).divide(math.pi).sqrt().multiply(unit_fix_factor)
-    return radius
-
-
-class DotEnvNotFoundError(FileNotFoundError):
-    def __init__(self) -> None:
-        super().__init__(
-            "Running tests requires setting an appropriate '.env' in the root directory or in your current working "
-            "directory. You may copy and edit the '.env.template' file from the root directory or from the README.",
-        )
+import base64
+import ee
+import math
+import os
+import pandas as pd
+
+import importlib.resources as pkg_resources
+
+from dotenv import load_dotenv
+from pathlib import Path
+
+from .logger import StdoutLogger
+
+
+logger = StdoutLogger(__name__)
+
+
+def get_example_data_path(filename):
+    """
+    Get the path to an example data file included in the package.
+
+    Parameters:
+    -----------
+    filename : str
+        The name of the example data file.
+
+    Returns:
+    --------
+    str
+        The path to the example data file.
+    """
+    return os.path.join("..", "tests", "fixtures", filename)
+
+
+def load_env_vars() -> None:
+    """Loads the environment variables required for testing the codebase.
+
+    Returns
+    -------
+    out : None
+    """
+
+    all_dotenv_paths = [Path(__file__).parents[2] / ".env", Path.cwd() / ".env"]
+    dotenv_loaded = False
+
+    for dotenv_path in all_dotenv_paths:
+        logger.logger.debug(f"dotenv_path: {dotenv_path}")
+        if dotenv_path.exists():
+            dotenv_loaded = load_dotenv(dotenv_path)
+            break
+
+    if not dotenv_loaded:
+        raise DotEnvNotFoundError
+    logger.logger.info(f"Loaded evironment variables from '{dotenv_path}'")
+
+
+def init_ee() -> None:
+    """Initialize earth engine according to the environment"""
+
+    # only do the initialization if the credential are missing
+    if not ee.data._credentials:
+
+        # if in test env use the private key
+        if "EE_PRIVATE_KEY" in os.environ:
+
+            # key need to be decoded in a file
+            content = base64.b64decode(os.environ["EE_PRIVATE_KEY"]).decode()
+            with open("ee_private_key.json", "w") as f:
+                f.write(content)
+
+            # connection to the service account
+            service_account = "test-sepal-ui@sepal-ui.iam.gserviceaccount.com"
+            credentials = ee.ServiceAccountCredentials(
+                service_account, "ee_private_key.json"
+            )
+            ee.Initialize(credentials)
+            logger.logger.info(f"Used env var")
+
+        # if in local env use the local user credential
+        else:
+            try:
+                load_env_vars()
+                logger.logger.info("Called 'ee.Initialize()'.")
+                ee.Initialize(project=os.environ["PROJECT"])
+            except ee.ee_exception.EEException:
+                logger.logger.info("Called 'ee.Authenticate()'.")
+                ee.Authenticate()
+                ee.Initialize(project=os.environ["PROJECT"])
+
+
+def clear_ee_credentials():
+
+    path_to_creds = Path().home() / ".config" / "earthengine" / "credentials"
+    if not path_to_creds.exists():
+        logger.logger.error(
+            f"GEE credentials file '{path_to_creds}' not found, could not de-authenticate."
+        )
+    else:
+        path_to_creds.unlink()
+        logger.logger.warning(f"GEE credentials file deleted.")
+
+
+def remove_geometry_from_feature_collection(feature_collection):
+    """Define the function to remove geometry from features in a feature collection"""
+    # Function to remove geometry from features
+    def remove_geometry(feature):
+        # Remove the geometry property
+        feature = feature.setGeometry(None)
+        return feature
+
+    # Apply the function to remove geometry to the feature collection
+    feature_collection_no_geometry = feature_collection.map(remove_geometry)
+    return feature_collection_no_geometry
+
+
+# Compute centroids of each polygon including the external_id_column
+def get_centroid(feature, external_id_column="external_id"):
+    keepProperties = [external_id_column]
+    # Get the centroid of the feature's geometry.
+    centroid = feature.geometry().centroid(1)
+    # Return a new Feature, copying properties from the old Feature.
+    return ee.Feature(centroid).copyProperties(feature, keepProperties)
+
+
+def buffer_point_to_required_area(feature, area, area_unit):
+    """buffers feature to get a given area (needs math library); area unit in 'ha' or 'km2' (the default)"""
+    area = feature.get("REP_AREA")
+
+    # buffer_size = get_radius_m_to_buffer_for_given_area(area,"km2")# should work but untested in this function
+
+    buffer_size = (
+        (ee.Number(feature.get("REP_AREA")).divide(math.pi)).sqrt().multiply(1000)
+    )  # calculating radius in metres from REP_AREA in km2
+
+    return ee.Feature(feature).buffer(buffer_size, 1)
+    ### buffering (incl., max error parameter should be 0m. But put as 1m anyhow - doesn't seem to make too much of a difference for speed)
+
+
+def get_radius_m_to_buffer_to_required_area(area, area_unit="km2"):
+    """gets radius in metres to buffer to get an area (needs math library); area unit ha or km2 (the default)"""
+    if area_unit == "km2":
+        unit_fix_factor = 1000
+    elif area_unit == "ha":
+        unit_fix_factor = 100
+    radius = ee.Number(area).divide(math.pi).sqrt().multiply(unit_fix_factor)
+    return radius
+
+
+class DotEnvNotFoundError(FileNotFoundError):
+    def __init__(self) -> None:
+        super().__init__(
+            "Running tests requires setting an appropriate '.env' in the root directory or in your current working "
+            "directory. You may copy and edit the '.env.template' file from the root directory or from the README.",
+        )

{openforis_whisp-2.0.0a5.dist-info → openforis_whisp-2.0.0a6.dist-info}/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2023 lecrabe
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2023 lecrabe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

{openforis_whisp-2.0.0a5.dist-info → openforis_whisp-2.0.0a6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: openforis-whisp
-Version: 2.0.0a5
+Version: 2.0.0a6
 Summary: Whisp (What is in that plot) is an open-source solution which helps to produce relevant forest monitoring information and support compliance with deforestation-related regulations.
 License: MIT
 Keywords: whisp,geospatial,data-processing

openforis_whisp-2.0.0a6.dist-info/RECORD

@@ -0,0 +1,17 @@
+openforis_whisp/__init__.py,sha256=OOCc-TFeVPAdYb06jMNzHqpeLBhoaWKOvzhAe2QaeLE,2328
+openforis_whisp/data_conversion.py,sha256=u4lJ39B22H2KBKDFEd-lgwH_IRW2MTldaOxFQjmDGA0,16416
+openforis_whisp/datasets.py,sha256=aDwoPmO_MViiGjyqmn7Sp17YYxaz-_gDKEdslSCz0Zc,50629
+openforis_whisp/logger.py,sha256=73Eppe-Rd8wtzUGswUNUY3jOaNrNHy0N7qJ1TxgLSKk,2233
+openforis_whisp/parameters/__init__.py,sha256=1ThsS9HYwZJzBR_3_BWU2UkyVtzN9u4CgdnmuClt4ug,334
+openforis_whisp/parameters/config_runtime.py,sha256=wm1dC9cuDkrNPBMMoncK2a4TKcwd8Jw47HY_zsUuk_0,1377
+openforis_whisp/parameters/lookup_context_and_metadata.csv,sha256=_UQ8u7WOJH1ZHOGUVUNirfj-XdyALuLk_ele1ANSvZk,1285
+openforis_whisp/parameters/lookup_gee_datasets.csv,sha256=5K1LQyuvwvG1vOdlyCknv_foDtRUKHPU3VvOU_zsoWQ,17626
+openforis_whisp/pd_schemas.py,sha256=lTv7fbwwG9bGOi6M4-tsJ3xm_HpiWJW-fhrZ0ELUF2c,2604
+openforis_whisp/reformat.py,sha256=ckSO8N_2GySe7X_Pot72N88wz2Y0RFIB774asWY69lc,17427
+openforis_whisp/risk.py,sha256=DKfFN4RrqSkVDbDFcEEWjlFIiDfNO-XACSzxxI1MNNI,31182
+openforis_whisp/stats.py,sha256=oNLr6yU5M-BY61L6NIcDUy93t1VwUTLEgnh8T6YyweA,39748
+openforis_whisp/utils.py,sha256=jWfq12wiVxcnlPPAtfDy0scHwYwSNKANoY2rRsDYx88,5224
+openforis_whisp-2.0.0a6.dist-info/LICENSE,sha256=RmwgaoqiMSysLXZaB9GP-f106r1F1OiC7dLKxjrfh20,1064
+openforis_whisp-2.0.0a6.dist-info/METADATA,sha256=AbMJGBkxVId1lSEWTFRfRDoaieBqwLR_sR2sxTVPCVk,16681
+openforis_whisp-2.0.0a6.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+openforis_whisp-2.0.0a6.dist-info/RECORD,,

{openforis_whisp-2.0.0a5.dist-info → openforis_whisp-2.0.0a6.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 2.1.1
+Generator: poetry-core 2.1.3
 Root-Is-Purelib: true
 Tag: py3-none-any

openforis_whisp-2.0.0a5.dist-info/RECORD

@@ -1,17 +0,0 @@
-openforis_whisp/__init__.py,sha256=xfXNzskPfnlQkmf3QZHEydhte3U9_uLdoYM04eowNqw,2403
-openforis_whisp/data_conversion.py,sha256=_HSjYozNO1xAOAk-uGmzTVCTOc3W7x3GDlvEUgrnj_Q,16909
-openforis_whisp/datasets.py,sha256=9Ofxyy2ignnN6mSXfXDP9n6SsQ8QPQQWivuolS_i8LY,52013
-openforis_whisp/logger.py,sha256=n9k0EhAZYZKesnfskv8KyWnkGbjqRqk84ulx9-u_Jsc,2308
-openforis_whisp/parameters/__init__.py,sha256=KL7iORJVjSpZatYjoyWckcmQJnE89_DBC8R6_0_eR6o,349
-openforis_whisp/parameters/config_runtime.py,sha256=NOo39MAi60XCwEx5pwkS0EHKJBh0XY1q06y4j0HAABg,1421
-openforis_whisp/parameters/lookup_context_and_metadata.csv,sha256=KgK0ik_Gd4t_Nq5cUkGPT4ZFZVO93HWSG82jRrOukt4,1298
-openforis_whisp/parameters/lookup_gee_datasets.csv,sha256=5K1LQyuvwvG1vOdlyCknv_foDtRUKHPU3VvOU_zsoWQ,17626
-openforis_whisp/pd_schemas.py,sha256=W_ocS773LHfc05dJqvWRa-bRdX0wKFoNp0lMxgFx94Y,2681
-openforis_whisp/reformat.py,sha256=o3TpeuddR1UlP1C3uFeI957kIZYMQqEW1pXsjKbAtiY,17922
-openforis_whisp/risk.py,sha256=FNWH84xhSjVZW3yTnTWZF3MxiZtNA5jb154vu-C2kJ0,31951
-openforis_whisp/stats.py,sha256=_l2V8BWdbJ2GoK7N5Zswg0Gvs1I5RRT-JGgl9fyl2AY,40882
-openforis_whisp/utils.py,sha256=YqFYK1fH2WpuWolXa-gCeSGYiHdJ0_xQUIo15dQ9Sh8,5378
-openforis_whisp-2.0.0a5.dist-info/LICENSE,sha256=nqyqICO95iw_iwzP1t_IIAf7ZX3DPbL_M9WyQfh2q1k,1085
-openforis_whisp-2.0.0a5.dist-info/METADATA,sha256=4ii5-gyxRZZmWyAhorNo9phcbpQoLRcmhagxxCCKHeA,16681
-openforis_whisp-2.0.0a5.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
-openforis_whisp-2.0.0a5.dist-info/RECORD,,