openforis-whisp 2.0.0a4__tar.gz → 2.0.0a6__tar.gz

{openforis_whisp-2.0.0a4 → openforis_whisp-2.0.0a6}/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.0a4 → openforis_whisp-2.0.0a6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: openforis-whisp
-Version: 2.0.0a4
+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
@@ -77,8 +77,6 @@ Description-Content-Type: text/markdown
 
 
   ## Whisp datasets <a name="whisp_datasets"></a>
-  All output columns from Whisp are described in [this excel file](https://github.com/forestdatapartnership/whisp/blob/main/whisp_columns.xlsx)
-
   ***Whisp***  implements the convergence of evidence approach by providing a transparent and public processing flow using datasets covering the following categories:
 
   1) Tree and forest cover (at the end of 2020);
@@ -86,27 +84,39 @@ Description-Content-Type: text/markdown
   3) Disturbances **before 2020** (i.e., degradation or deforestation until 2020-12-31);
   4) Disturbances **after 2020** (i.e., degradation or deforestation from 2021-01-01 onward).
 
+Additional categories are specific for the timber commodity, considering a harvesting date in 2023:
+
+  5) Primary forests in 2020;
+  6) Naturally regenerating forests in 2020;
+  7) Planted and plantation forests in 2020;
+  8) Planted and plantation forests in 2023;
+  9) Treecover in 2023;
+  10) Commodities or croplands in 2023.
+  11) Logging concessions;
+
   There are multiple datasets for each category. Find the full current [list of datasets used in Whisp here](https://github.com/forestdatapartnership/whisp/blob/main/layers_description.md).
-  Whisp checks the plots provided by the user by running zonal statistics on them to answer the following questions:
+
+  ### Whisp risk assessment <a name="whisp_risk"></a>  
+
+Whisp checks the plots provided by the user by running zonal statistics on them to answer the following questions:
 
   1) Was there tree cover in 2020?
   2) Were there commodity plantations or other agricultural uses in 2020?
   3) Were there disturbances until 2020-12-31?
   4) Were there disturbances after 2020-12-31 / starting 2021-01-01?
 
-  If no treecover dataset indicates any tree cover for a plot by the end of 2020, **Whisp will categorize the deforestation risk as low.**
-
-  If one or more treecover datasets indicate tree cover on a plot by the end of 2020, but a commodity dataset indicates agricultural use by the end of 2020, **Whisp will categorize the deforestation risk as low.**
-
-  If treecover datasets indicate tree cover on a plot by late 2020, no commodity datasets indicate agricultural use, but a disturbance dataset indicates disturbances before the end of 2020, **Whisp will categorize the deforestation risk as <u>low</u>.** Such deforestation has happened before 2020, which aligns with the cutoff date for legislation such as EUDR, and is therefore not considered high risk.
-
-  Now, if the datasets under 1., 2. & 3. indicate that there was tree cover, but no agriculture and no disturbances before or by the end of 2020, the Whisp algorithm checks whether degradation or deforestation have been reported in a disturbance dataset after 2020-12-31. If they have, **Whisp will categorize the deforestation risk as <u>high</u>.** <br>
-  However, under the same circumstances but with <u>no</u> disturbances reported after 2020-12-31 there is insufficient evidence and the **Whisp output will be "More info needed".** Such can be the case for, e.g., cocoa or coffee grown under the shade of treecover or agroforestry.
+And specifically for the timber commodity, considering a harvesting date in 2023:
 
+  5) Were there primary forests in 2020?
+  6) Were there naturally regenerating forests in 2020?
+  7) Were there planted and plantation forests in 2020?
+  8) Were there planted and plantation forests in 2023?
+  9) Was there treecover in 2023?
+  10) Were there commodity plantations or other agricultural uses in 2023?
+  11) Is it part of a logging concession?
 
-  *The Whisp algorithm for **Perennial Crops** visualized:*
-  ![CoE_Graphic 5](https://github.com/user-attachments/assets/007b5f50-3939-4707-95fa-98be4d56745f)
   The Whisp algorithm outputs multiple statistical columns with disaggregated data from the input datasets, followed by aggregated indicator columns, and the final risk assessment columns.
+    All output columns from Whisp are described in [this excel file](https://github.com/forestdatapartnership/whisp/blob/main/whisp_columns.xlsx)
 
 The **relevant risk assessment column depends on the commodity** in question:
 
@@ -141,47 +151,28 @@ The **relevant risk assessment column depends on the commodity** in question:
   </tr>
 </table>
 
-  The decision tree for the timber risk assessment slightly differs from the above. For more information see below.
-
-
+  *The Whisp algorithm for **Perennial Crops** visualized:*
+  ![CoE_Graphic 5](https://github.com/user-attachments/assets/007b5f50-3939-4707-95fa-98be4d56745f)
+  
+  If no treecover dataset indicates any tree cover for a plot by the end of 2020, **Whisp will categorize the deforestation risk as low.**
 
+  If one or more treecover datasets indicate tree cover on a plot by the end of 2020, but a commodity dataset indicates agricultural use by the end of 2020, **Whisp will categorize the deforestation risk as low.**
 
-  ## Whisp datasets for timber <a name="whisp_datasets_timber"></a>
-  ***Whisp***  implements the convergence of evidence approach by providing a transparent and public processing flow using datasets covering the following categories:
-  1) Tree and forest cover (at the end of 2020);
-  2) Commodities (i.e., crop plantations and other agricultural uses at the end of 2020);
-  3) Disturbances **before 2020** (i.e., degradation or deforestation until 2020-12-31);
-  4) Disturbances **after 2020** (i.e., degradation or deforestation from 2021-01-01 onward).
-  5) Primary forests in 2020;
-  6) Naturally regenerating forests in 2020;
-  7) Planted and plantation forests in 2020;
-  8) Planted and plantation forests in 2023;
-  9) Treecover in 2023;
-  10) Commodities or croplands in 2023.
-  11) Logging concessions;
+  If treecover datasets indicate tree cover on a plot by late 2020, no commodity datasets indicate agricultural use, but a disturbance dataset indicates disturbances before the end of 2020, **Whisp will categorize the deforestation risk as <u>low</u>.** Such deforestation has happened before 2020, which aligns with the cutoff date for legislation such as EUDR, and is therefore not considered high risk.
 
-  There are multiple datasets for each category. Find the full current [list of datasets used in Whisp here](https://github.com/forestdatapartnership/whisp/blob/main/layers_description.md).
-  Whisp checks the plots provided by the user by running zonal statistics on them to answer the following questions:
+  Now, if the datasets under 1., 2. & 3. indicate that there was tree cover, but no agriculture and no disturbances before or by the end of 2020, the Whisp algorithm checks whether degradation or deforestation have been reported in a disturbance dataset after 2020-12-31. If they have, **Whisp will categorize the deforestation risk as <u>high</u>.** <br>
+  However, under the same circumstances but with <u>no</u> disturbances reported after 2020-12-31 there is insufficient evidence and the **Whisp output will be "More info needed".** Such can be the case for, e.g., cocoa or coffee grown under the shade of treecover or agroforestry.
 
-  1) Was there tree cover in 2020?
-  2) Were there commodity plantations or other agricultural uses in 2020?
-  3) Were there disturbances until 2020-12-31?
-  4) Were there disturbances after 2020-12-31 / starting 2021-01-01?
-  5) Were there primary forests in 2020?
-  6) Were there naturally regenerating forests in 2020?
-  7) Were there planted and plantation forests in 2020?
-  8) Were there planted and plantation forests in 2023?
-  9) Was there treecover in 2023?
-  10) Were there commodity plantations or other agricultural uses in 2023?
-  11) Were there logging concessions?
 
-  # Run Whisp python package from a notebook <a name="whisp_notebooks"></a>
+  ## Run Whisp python package from a notebook <a name="whisp_notebooks"></a>
 
   For most users we suggest using the Whisp App to process their plot data. But for some, using the python package directly will fit their workflow.
 
   A simple example of the package functionality can be seen in this [Colab Notebook](https://github.com/forestdatapartnership/whisp/blob/main/notebooks/Colab_whisp_geojson_to_csv.ipynb)
 
-  ## Requirements for running the package
+  For an example notebook adapted for running locally (or in Sepal), see: [whisp_geojson_to_csv.ipynb](https://github.com/forestdatapartnership/whisp/blob/main/notebooks/whisp_geojson_to_csv.ipynb) or if datasets are very large, see [whisp_geojson_to_drive.ipynb](https://github.com/forestdatapartnership/whisp/blob/main/notebooks/whisp_geojson_to_drive.ipynb)
+
+  ### Requirements for running the package
 
   - A Google Earth Engine (GEE) account.
   - A registered cloud GEE project.
@@ -190,7 +181,7 @@ The **relevant risk assessment column depends on the commodity** in question:
   More info on Whisp can be found in [here](https://openknowledge.fao.org/items/e9284dc7-4b19-4f9c-b3e1-e6c142585865)
 
 
-  ## Python package installation
+  ### Python package installation
 
   The Whisp package is available on pip
   https://pypi.org/project/openforis-whisp/

{openforis_whisp-2.0.0a4 → openforis_whisp-2.0.0a6}/README.md

@@ -40,8 +40,6 @@
 
 
   ## Whisp datasets <a name="whisp_datasets"></a>
-  All output columns from Whisp are described in [this excel file](https://github.com/forestdatapartnership/whisp/blob/main/whisp_columns.xlsx)
-
   ***Whisp***  implements the convergence of evidence approach by providing a transparent and public processing flow using datasets covering the following categories:
 
   1) Tree and forest cover (at the end of 2020);
@@ -49,27 +47,39 @@
   3) Disturbances **before 2020** (i.e., degradation or deforestation until 2020-12-31);
   4) Disturbances **after 2020** (i.e., degradation or deforestation from 2021-01-01 onward).
 
+Additional categories are specific for the timber commodity, considering a harvesting date in 2023:
+
+  5) Primary forests in 2020;
+  6) Naturally regenerating forests in 2020;
+  7) Planted and plantation forests in 2020;
+  8) Planted and plantation forests in 2023;
+  9) Treecover in 2023;
+  10) Commodities or croplands in 2023.
+  11) Logging concessions;
+
   There are multiple datasets for each category. Find the full current [list of datasets used in Whisp here](https://github.com/forestdatapartnership/whisp/blob/main/layers_description.md).
-  Whisp checks the plots provided by the user by running zonal statistics on them to answer the following questions:
+
+  ### Whisp risk assessment <a name="whisp_risk"></a>  
+
+Whisp checks the plots provided by the user by running zonal statistics on them to answer the following questions:
 
   1) Was there tree cover in 2020?
   2) Were there commodity plantations or other agricultural uses in 2020?
   3) Were there disturbances until 2020-12-31?
   4) Were there disturbances after 2020-12-31 / starting 2021-01-01?
 
-  If no treecover dataset indicates any tree cover for a plot by the end of 2020, **Whisp will categorize the deforestation risk as low.**
-
-  If one or more treecover datasets indicate tree cover on a plot by the end of 2020, but a commodity dataset indicates agricultural use by the end of 2020, **Whisp will categorize the deforestation risk as low.**
-
-  If treecover datasets indicate tree cover on a plot by late 2020, no commodity datasets indicate agricultural use, but a disturbance dataset indicates disturbances before the end of 2020, **Whisp will categorize the deforestation risk as <u>low</u>.** Such deforestation has happened before 2020, which aligns with the cutoff date for legislation such as EUDR, and is therefore not considered high risk.
-
-  Now, if the datasets under 1., 2. & 3. indicate that there was tree cover, but no agriculture and no disturbances before or by the end of 2020, the Whisp algorithm checks whether degradation or deforestation have been reported in a disturbance dataset after 2020-12-31. If they have, **Whisp will categorize the deforestation risk as <u>high</u>.** <br>
-  However, under the same circumstances but with <u>no</u> disturbances reported after 2020-12-31 there is insufficient evidence and the **Whisp output will be "More info needed".** Such can be the case for, e.g., cocoa or coffee grown under the shade of treecover or agroforestry.
+And specifically for the timber commodity, considering a harvesting date in 2023:
 
+  5) Were there primary forests in 2020?
+  6) Were there naturally regenerating forests in 2020?
+  7) Were there planted and plantation forests in 2020?
+  8) Were there planted and plantation forests in 2023?
+  9) Was there treecover in 2023?
+  10) Were there commodity plantations or other agricultural uses in 2023?
+  11) Is it part of a logging concession?
 
-  *The Whisp algorithm for **Perennial Crops** visualized:*
-  ![CoE_Graphic 5](https://github.com/user-attachments/assets/007b5f50-3939-4707-95fa-98be4d56745f)
   The Whisp algorithm outputs multiple statistical columns with disaggregated data from the input datasets, followed by aggregated indicator columns, and the final risk assessment columns.
+    All output columns from Whisp are described in [this excel file](https://github.com/forestdatapartnership/whisp/blob/main/whisp_columns.xlsx)
 
 The **relevant risk assessment column depends on the commodity** in question:
 
@@ -104,47 +114,28 @@ The **relevant risk assessment column depends on the commodity** in question:
   </tr>
 </table>
 
-  The decision tree for the timber risk assessment slightly differs from the above. For more information see below.
-
-
+  *The Whisp algorithm for **Perennial Crops** visualized:*
+  ![CoE_Graphic 5](https://github.com/user-attachments/assets/007b5f50-3939-4707-95fa-98be4d56745f)
+  
+  If no treecover dataset indicates any tree cover for a plot by the end of 2020, **Whisp will categorize the deforestation risk as low.**
 
+  If one or more treecover datasets indicate tree cover on a plot by the end of 2020, but a commodity dataset indicates agricultural use by the end of 2020, **Whisp will categorize the deforestation risk as low.**
 
-  ## Whisp datasets for timber <a name="whisp_datasets_timber"></a>
-  ***Whisp***  implements the convergence of evidence approach by providing a transparent and public processing flow using datasets covering the following categories:
-  1) Tree and forest cover (at the end of 2020);
-  2) Commodities (i.e., crop plantations and other agricultural uses at the end of 2020);
-  3) Disturbances **before 2020** (i.e., degradation or deforestation until 2020-12-31);
-  4) Disturbances **after 2020** (i.e., degradation or deforestation from 2021-01-01 onward).
-  5) Primary forests in 2020;
-  6) Naturally regenerating forests in 2020;
-  7) Planted and plantation forests in 2020;
-  8) Planted and plantation forests in 2023;
-  9) Treecover in 2023;
-  10) Commodities or croplands in 2023.
-  11) Logging concessions;
+  If treecover datasets indicate tree cover on a plot by late 2020, no commodity datasets indicate agricultural use, but a disturbance dataset indicates disturbances before the end of 2020, **Whisp will categorize the deforestation risk as <u>low</u>.** Such deforestation has happened before 2020, which aligns with the cutoff date for legislation such as EUDR, and is therefore not considered high risk.
 
-  There are multiple datasets for each category. Find the full current [list of datasets used in Whisp here](https://github.com/forestdatapartnership/whisp/blob/main/layers_description.md).
-  Whisp checks the plots provided by the user by running zonal statistics on them to answer the following questions:
+  Now, if the datasets under 1., 2. & 3. indicate that there was tree cover, but no agriculture and no disturbances before or by the end of 2020, the Whisp algorithm checks whether degradation or deforestation have been reported in a disturbance dataset after 2020-12-31. If they have, **Whisp will categorize the deforestation risk as <u>high</u>.** <br>
+  However, under the same circumstances but with <u>no</u> disturbances reported after 2020-12-31 there is insufficient evidence and the **Whisp output will be "More info needed".** Such can be the case for, e.g., cocoa or coffee grown under the shade of treecover or agroforestry.
 
-  1) Was there tree cover in 2020?
-  2) Were there commodity plantations or other agricultural uses in 2020?
-  3) Were there disturbances until 2020-12-31?
-  4) Were there disturbances after 2020-12-31 / starting 2021-01-01?
-  5) Were there primary forests in 2020?
-  6) Were there naturally regenerating forests in 2020?
-  7) Were there planted and plantation forests in 2020?
-  8) Were there planted and plantation forests in 2023?
-  9) Was there treecover in 2023?
-  10) Were there commodity plantations or other agricultural uses in 2023?
-  11) Were there logging concessions?
 
-  # Run Whisp python package from a notebook <a name="whisp_notebooks"></a>
+  ## Run Whisp python package from a notebook <a name="whisp_notebooks"></a>
 
   For most users we suggest using the Whisp App to process their plot data. But for some, using the python package directly will fit their workflow.
 
   A simple example of the package functionality can be seen in this [Colab Notebook](https://github.com/forestdatapartnership/whisp/blob/main/notebooks/Colab_whisp_geojson_to_csv.ipynb)
 
-  ## Requirements for running the package
+  For an example notebook adapted for running locally (or in Sepal), see: [whisp_geojson_to_csv.ipynb](https://github.com/forestdatapartnership/whisp/blob/main/notebooks/whisp_geojson_to_csv.ipynb) or if datasets are very large, see [whisp_geojson_to_drive.ipynb](https://github.com/forestdatapartnership/whisp/blob/main/notebooks/whisp_geojson_to_drive.ipynb)
+
+  ### Requirements for running the package
 
   - A Google Earth Engine (GEE) account.
   - A registered cloud GEE project.
@@ -153,7 +144,7 @@ The **relevant risk assessment column depends on the commodity** in question:
   More info on Whisp can be found in [here](https://openknowledge.fao.org/items/e9284dc7-4b19-4f9c-b3e1-e6c142585865)
 
 
-  ## Python package installation
+  ### Python package installation
 
   The Whisp package is available on pip
   https://pypi.org/project/openforis-whisp/

{openforis_whisp-2.0.0a4 → openforis_whisp-2.0.0a6}/pyproject.toml

@@ -1,85 +1,85 @@
-[build-system]
-requires = ["poetry-core>=1.0.0"]
-build-backend = "poetry.core.masonry.api"
-
-[tool.poetry]
-name = "openforis-whisp"
-version = "2.0.0a4"
-description = "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."
-repository = "https://github.com/forestdatapartnership/whisp"
-authors = ["Andy Arnell <and.arnell@fao.org>"]
-readme = "README.md"
-license = "MIT"
-keywords = ["whisp", "geospatial", "data-processing"]
-classifiers = [
-    "Development Status :: 3 - Alpha",
-    "Programming Language :: Python :: 3.10",
-    "License :: OSI Approved :: MIT License",
-    "Intended Audience :: Developers",
-    "Intended Audience :: Science/Research",
-    "Topic :: Software Development :: Libraries :: Python Modules"
-]
-
-[tool.poetry.urls]
-"Documentation" = "https://github.com/forestdatapartnership/whisp#readme"
-"Development Branch" = "https://github.com/forestdatapartnership/whisp/tree/main"
-"Issues" = "https://github.com/forestdatapartnership/whisp/issues"
-
-[tool.poetry.dependencies]
-python = ">=3.10"
-earthengine-api = "*"
-numpy = ">=1.21.0,<3.0.0"  # Updated version constraint
-pandas = ">=1.3.0,<3.0.0"
-pandera = {extras = ["io"], version = ">=0.22.1,<1.0.0"}
-country_converter = ">=0.7,<2.0.0"
-geojson = ">=2.5.0,<3.0.0"
-python-dotenv = ">=1.0.1,<2.0.0"
-pydantic-core = ">=2.14.0,<3.0.0"  # Updated version constraint
-rsa = ">=4.2,<5.0.0"  # Updated version constraint
-ipykernel = ">=6.17.1,<7.0.0"  # Compatible with Colab
-shapely = "^2.0.2"
-geopandas = "^1.0.1"
-
-[tool.poetry.group.dev.dependencies]
-pytest = ">=6.2.5,<7.0.0"
-pre-commit = ">=2.15.0,<3.0.0"
-ruff = ">=0.0.1,<1.0.0"
-
-[tool.setuptools]
-package-dir = {"" = "src"}
-include-package-data = true
-
-[tool.setuptools.packages.find]
-where = ["src"]
-
-[tool.setuptools.package-data]
-"whisp.parameters" = ["lookup_gee_datasets.csv", "lookup_context_and_metadata.csv"]
-
-[tool.pytest.ini_options]
-log_cli = true
-log_cli_level = "DEBUG"
-
-[tool.ruff]
-fix = true
-select = [
-    "A", "ANN", "ARG", "B", "C", "COM", "C90", "E", "ERA", "F", "I", "N", "PGH", "PL", "PLE", "PLR", "PLW", "PT",
-    "PTH", "Q", "RET", "RUF", "SLF", "SIM", "TID", "TRY", "UP", "W", "YTT"
-]
-ignore = [
-    "A003", "ANN002", "ANN003", "ANN101", "ANN102", "ANN401", "N805", "N818", "PLR0913", "RET504", "RET505"
-]
-fixable = [
-    "A", "ANN", "ARG", "B", "C", "COM", "C90", "E", "ERA", "F", "I", "PGH", "PL", "PLE", "PLR", "PLW", "PT",
-    "PTH", "Q", "RET", "RUF", "SLF", "SIM", "TID", "TRY", "UP", "W", "YTT"
-]
-unfixable = []
-
-exclude = [
-    ".bzr", ".direnv",
-]
-
-line-length = 120
-dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
-
-[tool.ruff.mccabe]
-max-complexity = 10
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry]
+name = "openforis-whisp"
+version = "2.0.0a6"
+description = "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."
+repository = "https://github.com/forestdatapartnership/whisp"
+authors = ["Andy Arnell <and.arnell@fao.org>"]
+readme = "README.md"
+license = "MIT"
+keywords = ["whisp", "geospatial", "data-processing"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Programming Language :: Python :: 3.10",
+    "License :: OSI Approved :: MIT License",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "Topic :: Software Development :: Libraries :: Python Modules"
+]
+
+[tool.poetry.urls]
+"Documentation" = "https://github.com/forestdatapartnership/whisp#readme"
+"Development Branch" = "https://github.com/forestdatapartnership/whisp/tree/main"
+"Issues" = "https://github.com/forestdatapartnership/whisp/issues"
+
+[tool.poetry.dependencies]
+python = ">=3.10"
+earthengine-api = "*"
+numpy = ">=1.21.0,<3.0.0"  # Updated version constraint
+pandas = ">=1.3.0,<3.0.0"
+pandera = {extras = ["io"], version = ">=0.22.1,<1.0.0"}
+country_converter = ">=0.7,<2.0.0"
+geojson = ">=2.5.0,<3.0.0"
+python-dotenv = ">=1.0.1,<2.0.0"
+pydantic-core = ">=2.14.0,<3.0.0"  # Updated version constraint
+rsa = ">=4.2,<5.0.0"  # Updated version constraint
+ipykernel = ">=6.17.1,<7.0.0"  # Compatible with Colab
+shapely = "^2.0.2"
+geopandas = "^1.0.1"
+
+[tool.poetry.group.dev.dependencies]
+pytest = ">=6.2.5,<7.0.0"
+pre-commit = ">=2.15.0,<3.0.0"
+ruff = ">=0.0.1,<1.0.0"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+"whisp.parameters" = ["lookup_gee_datasets.csv", "lookup_context_and_metadata.csv"]
+
+[tool.pytest.ini_options]
+log_cli = true
+log_cli_level = "DEBUG"
+
+[tool.ruff]
+fix = true
+select = [
+    "A", "ANN", "ARG", "B", "C", "COM", "C90", "E", "ERA", "F", "I", "N", "PGH", "PL", "PLE", "PLR", "PLW", "PT",
+    "PTH", "Q", "RET", "RUF", "SLF", "SIM", "TID", "TRY", "UP", "W", "YTT"
+]
+ignore = [
+    "A003", "ANN002", "ANN003", "ANN101", "ANN102", "ANN401", "N805", "N818", "PLR0913", "RET504", "RET505"
+]
+fixable = [
+    "A", "ANN", "ARG", "B", "C", "COM", "C90", "E", "ERA", "F", "I", "PGH", "PL", "PLE", "PLR", "PLW", "PT",
+    "PTH", "Q", "RET", "RUF", "SLF", "SIM", "TID", "TRY", "UP", "W", "YTT"
+]
+unfixable = []
+
+exclude = [
+    ".bzr", ".direnv",
+]
+
+line-length = 120
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+[tool.ruff.mccabe]
+max-complexity = 10

{openforis_whisp-2.0.0a4 → openforis_whisp-2.0.0a6}/src/openforis_whisp/__init__.py

@@ -1,75 +1,75 @@
-import ee
-from google.oauth2 import service_account
-
-
-def initialize_ee(credentials_path=None):
-    """Initializes Google Earth Engine using the provided path or defaults to normal if no path is given."""
-    try:
-        if not ee.data._initialized:
-            print(credentials_path)
-            if credentials_path:
-                credentials = service_account.Credentials.from_service_account_file(
-                    credentials_path,
-                    scopes=["https://www.googleapis.com/auth/earthengine"],
-                )
-                ee.Initialize(credentials)
-                print("EE initialized with credentials from:", credentials_path)
-            else:
-                ee.Initialize()
-                print("EE initialized with default credentials.")
-    except Exception as e:
-        print("Error initializing EE:", e)
-
-
-# Default to normal initialize if nobody calls whisp.initialize_ee.
-try:
-    if not ee.data._initialized:
-        ee.Initialize()
-        print("EE auto-initialized with default credentials.")
-except Exception as e:
-    print("Error in default EE initialization:", e)
-
-from openforis_whisp.datasets import (
-    combine_datasets,
-)
-
-from openforis_whisp.stats import (
-    whisp_stats_ee_to_ee,
-    whisp_stats_ee_to_df,
-    whisp_stats_geojson_to_df,
-    whisp_stats_geojson_to_ee,
-    whisp_stats_geojson_to_geojson,
-    whisp_stats_ee_to_drive,
-    whisp_stats_geojson_to_drive,
-    whisp_formatted_stats_ee_to_df,
-    whisp_formatted_stats_ee_to_geojson,
-    whisp_formatted_stats_geojson_to_df,
-    whisp_formatted_stats_geojson_to_geojson,
-    convert_iso3_to_iso2,
-)
-
-# temporary parameters to be removed once isio3 to iso2 conversion server side is implemented
-from openforis_whisp.parameters.config_runtime import (
-    iso3_country_column,
-    iso2_country_column,
-)
-
-from openforis_whisp.reformat import (
-    validate_dataframe_using_lookups,
-    validate_dataframe,
-    create_schema_from_dataframe,
-    load_schema_if_any_file_changed,
-    # log_missing_columns,
-)
-
-from openforis_whisp.data_conversion import (
-    convert_ee_to_df,
-    convert_geojson_to_ee,
-    convert_df_to_geojson,
-    convert_csv_to_geojson,
-    convert_ee_to_geojson,
-)
-
-from openforis_whisp.risk import whisp_risk, detect_unit_type
-
-from openforis_whisp.utils import get_example_data_path
+import ee
+from google.oauth2 import service_account
+
+
+def initialize_ee(credentials_path=None):
+    """Initializes Google Earth Engine using the provided path or defaults to normal if no path is given."""
+    try:
+        if not ee.data._initialized:
+            print(credentials_path)
+            if credentials_path:
+                credentials = service_account.Credentials.from_service_account_file(
+                    credentials_path,
+                    scopes=["https://www.googleapis.com/auth/earthengine"],
+                )
+                ee.Initialize(credentials)
+                print("EE initialized with credentials from:", credentials_path)
+            else:
+                ee.Initialize()
+                print("EE initialized with default credentials.")
+    except Exception as e:
+        print("Error initializing EE:", e)
+
+
+# Default to normal initialize if nobody calls whisp.initialize_ee.
+try:
+    if not ee.data._initialized:
+        ee.Initialize()
+        print("EE auto-initialized with default credentials.")
+except Exception as e:
+    print("Error in default EE initialization:", e)
+
+from openforis_whisp.datasets import (
+    combine_datasets,
+)
+
+from openforis_whisp.stats import (
+    whisp_stats_ee_to_ee,
+    whisp_stats_ee_to_df,
+    whisp_stats_geojson_to_df,
+    whisp_stats_geojson_to_ee,
+    whisp_stats_geojson_to_geojson,
+    whisp_stats_ee_to_drive,
+    whisp_stats_geojson_to_drive,
+    whisp_formatted_stats_ee_to_df,
+    whisp_formatted_stats_ee_to_geojson,
+    whisp_formatted_stats_geojson_to_df,
+    whisp_formatted_stats_geojson_to_geojson,
+    convert_iso3_to_iso2,
+)
+
+# temporary parameters to be removed once isio3 to iso2 conversion server side is implemented
+from openforis_whisp.parameters.config_runtime import (
+    iso3_country_column,
+    iso2_country_column,
+)
+
+from openforis_whisp.reformat import (
+    validate_dataframe_using_lookups,
+    validate_dataframe,
+    create_schema_from_dataframe,
+    load_schema_if_any_file_changed,
+    # log_missing_columns,
+)
+
+from openforis_whisp.data_conversion import (
+    convert_ee_to_df,
+    convert_geojson_to_ee,
+    convert_df_to_geojson,
+    convert_csv_to_geojson,
+    convert_ee_to_geojson,
+)
+
+from openforis_whisp.risk import whisp_risk, detect_unit_type
+
+from openforis_whisp.utils import get_example_data_path