openforis-whisp 2.0.0a3__tar.gz → 2.0.0a5__tar.gz

{openforis_whisp-2.0.0a3 → openforis_whisp-2.0.0a5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: openforis-whisp
-Version: 2.0.0a3
+Version: 2.0.0a5
 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
@@ -59,7 +59,6 @@ Description-Content-Type: text/markdown
   - [Whisp pathways](#whisp_pathways)
   - [Whisp datasets](#whisp_datasets)
   - [Whisp notebooks](#whisp_notebooks)
-  - [System setup](#whisp_setup)
   - [Add data layers](#whisp_add_data)
   - [Contribute to the code](#whisp_contribute)
   - [Code of conduct](#whisp_conduct)
@@ -78,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);
@@ -87,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:
 
@@ -142,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
+  ## 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 +180,8 @@ 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/
@@ -202,15 +193,15 @@ The **relevant risk assessment column depends on the commodity** in question:
   pip install --pre openforis-whisp
   ```
 
-  If running locally we recommend a [virtual environment](https://docs.python.org/3/library/venv.html) to keep your main python installation clean.
+  If running the package locally we recommend a [virtual environment](https://docs.python.org/3/library/venv.html) to keep your main python installation clean. For users running the package in Sepal see [here](https://docs.sepal.io/en/latest/cli/python.html#virtual-environment).
 
   The package relies upon the google earth engine api being setup correctly using a registered cloud project.
 
-  More info on Whisp can be found in [here](https://openknowledge.fao.org/items/e9284dc7-4b19-4f9c-b3e1-e6c142585865)
+  More info on Whisp can be found [here](https://openknowledge.fao.org/items/e9284dc7-4b19-4f9c-b3e1-e6c142585865)
 
 
 
-## How to add data layers to Whisp
+## How to add data layers to Whisp <a name="whisp_add_data"></a>
 
 
 
@@ -253,12 +244,24 @@ Before submitting a request, consider the following:
 ### Adding your own data directly
 
 
-
 To add your own data you will need some coding experience as well as familiarity with GitHub and Google Earth Engine.
 
+This approach is for those who want to run a bespoke analysis combining their own data with those already in Whisp.
 
-Firstly follow the steps to install the package in editable mode (as detailed below in Contributing to the Whisp code base). Once in editable mode you are running the Whisp package locally based on a cloned version of the code. This approach is for those who want to run a bespoke analysis combining their own data with those already in Whisp. If, however, you think the datasets are of use to the wider community and you have the code running smoothly, you can make a pull request from a forked repository. 
+Firstly follow the steps below to install the package in editable mode.
 
+As with the regular pip installation, we recommend a separate [virtual environment](https://docs.python.org/3/library/venv.html) for running in editable mode. For Sepal users see [here](https://docs.sepal.io/en/latest/cli/python.html#virtual-environment).
+
+```bash
+
+git  clone  https://github.com/forestdatapartnership/whisp.git
+
+cd  whisp/
+
+pip  install  -e  .[dev]
+
+```
+Once in editable mode you are running the Whisp package locally based on a cloned version of the code.
 
 
 
@@ -294,7 +297,7 @@ For example, if it is a dataset for tree cover in 2000, then add `'treecover'` u
 
 ```python
 
-def  nBR_my_custom_dataset_prep():
+def  my_custom_dataset_prep():
 
 image = ee.Image("MY/GEE/DATASET")
 
@@ -309,7 +312,6 @@ return binary.rename("My_custom_dataset")
 ---
 
 
-
 We are working on ways to make this process smoother. However, in the meantime do contact us through the [issues page on GitHub](https://github.com/forestdatapartnership/whisp/issues), or via the Open Foris email, if this functionality is useful to you or you need help.
 
 
@@ -318,28 +320,14 @@ We are working on ways to make this process smoother. However, in the meantime d
 
 
 
-## Contributing to the Whisp code base
-
-
-
-Contributions to the Whisp code in GitHub are welcome. They can be made by forking the repository, making and pushing the required changes, then making a pull request to the Whisp repository. After briefly reviewing the request, we can make a branch for which to make a new pull request to. After final checks, we can then incorporate the code into the main branch. If in doubt, get in contact first or log as an issue [here](https://github.com/forestdatapartnership/whisp/issues/).
-
+## Contributing to the Whisp code base <a name="whisp_contribute"></a>
 
+Contributions to the Whisp code in GitHub are welcome. These could be additional functionality, datasets or just cleaner code! Contributions can be made by forking the repository, making and pushing the required changes, then making a pull request to the Whisp repository. After briefly reviewing the request, we can make a branch for which to make a new pull request to. After final checks, we can then incorporate the code into the main branch. If in doubt, get in contact first or log as an issue [here](https://github.com/forestdatapartnership/whisp/issues/).
 
-Install the package in editable mode:
 
+Install the package in editable mode (see Adding your own data directly above):
 
-```bash
-
-git  clone  https://github.com/forestdatapartnership/whisp.git
-
-cd  whisp/
-
-pip  install  -e  .[dev]
-
-```
-
-Add additional dependencies required for testing and running pre-commit hooks:
+Then add additional dependencies required for testing and running pre-commit hooks:
 
 
 ```bash
@@ -352,7 +340,6 @@ pre-commit  install
 You should be able to run the Pytest suite by simply running the `pytest` command from the repo's root folder.
 
 
-
 Please read the [contributing guidelines](contributing_guidelines.md) for good practice recommendations
 
 

{openforis_whisp-2.0.0a3 → openforis_whisp-2.0.0a5}/README.md

@@ -22,7 +22,6 @@
   - [Whisp pathways](#whisp_pathways)
   - [Whisp datasets](#whisp_datasets)
   - [Whisp notebooks](#whisp_notebooks)
-  - [System setup](#whisp_setup)
   - [Add data layers](#whisp_add_data)
   - [Contribute to the code](#whisp_contribute)
   - [Code of conduct](#whisp_conduct)
@@ -41,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);
@@ -50,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:
 
@@ -105,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
+  ## 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 +143,8 @@ 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/
@@ -165,15 +156,15 @@ The **relevant risk assessment column depends on the commodity** in question:
   pip install --pre openforis-whisp
   ```
 
-  If running locally we recommend a [virtual environment](https://docs.python.org/3/library/venv.html) to keep your main python installation clean.
+  If running the package locally we recommend a [virtual environment](https://docs.python.org/3/library/venv.html) to keep your main python installation clean. For users running the package in Sepal see [here](https://docs.sepal.io/en/latest/cli/python.html#virtual-environment).
 
   The package relies upon the google earth engine api being setup correctly using a registered cloud project.
 
-  More info on Whisp can be found in [here](https://openknowledge.fao.org/items/e9284dc7-4b19-4f9c-b3e1-e6c142585865)
+  More info on Whisp can be found [here](https://openknowledge.fao.org/items/e9284dc7-4b19-4f9c-b3e1-e6c142585865)
 
 
 
-## How to add data layers to Whisp
+## How to add data layers to Whisp <a name="whisp_add_data"></a>
 
 
 
@@ -216,12 +207,24 @@ Before submitting a request, consider the following:
 ### Adding your own data directly
 
 
-
 To add your own data you will need some coding experience as well as familiarity with GitHub and Google Earth Engine.
 
+This approach is for those who want to run a bespoke analysis combining their own data with those already in Whisp.
 
-Firstly follow the steps to install the package in editable mode (as detailed below in Contributing to the Whisp code base). Once in editable mode you are running the Whisp package locally based on a cloned version of the code. This approach is for those who want to run a bespoke analysis combining their own data with those already in Whisp. If, however, you think the datasets are of use to the wider community and you have the code running smoothly, you can make a pull request from a forked repository. 
+Firstly follow the steps below to install the package in editable mode.
 
+As with the regular pip installation, we recommend a separate [virtual environment](https://docs.python.org/3/library/venv.html) for running in editable mode. For Sepal users see [here](https://docs.sepal.io/en/latest/cli/python.html#virtual-environment).
+
+```bash
+
+git  clone  https://github.com/forestdatapartnership/whisp.git
+
+cd  whisp/
+
+pip  install  -e  .[dev]
+
+```
+Once in editable mode you are running the Whisp package locally based on a cloned version of the code.
 
 
 
@@ -257,7 +260,7 @@ For example, if it is a dataset for tree cover in 2000, then add `'treecover'` u
 
 ```python
 
-def  nBR_my_custom_dataset_prep():
+def  my_custom_dataset_prep():
 
 image = ee.Image("MY/GEE/DATASET")
 
@@ -272,7 +275,6 @@ return binary.rename("My_custom_dataset")
 ---
 
 
-
 We are working on ways to make this process smoother. However, in the meantime do contact us through the [issues page on GitHub](https://github.com/forestdatapartnership/whisp/issues), or via the Open Foris email, if this functionality is useful to you or you need help.
 
 
@@ -281,28 +283,14 @@ We are working on ways to make this process smoother. However, in the meantime d
 
 
 
-## Contributing to the Whisp code base
-
-
-
-Contributions to the Whisp code in GitHub are welcome. They can be made by forking the repository, making and pushing the required changes, then making a pull request to the Whisp repository. After briefly reviewing the request, we can make a branch for which to make a new pull request to. After final checks, we can then incorporate the code into the main branch. If in doubt, get in contact first or log as an issue [here](https://github.com/forestdatapartnership/whisp/issues/).
-
+## Contributing to the Whisp code base <a name="whisp_contribute"></a>
 
+Contributions to the Whisp code in GitHub are welcome. These could be additional functionality, datasets or just cleaner code! Contributions can be made by forking the repository, making and pushing the required changes, then making a pull request to the Whisp repository. After briefly reviewing the request, we can make a branch for which to make a new pull request to. After final checks, we can then incorporate the code into the main branch. If in doubt, get in contact first or log as an issue [here](https://github.com/forestdatapartnership/whisp/issues/).
 
-Install the package in editable mode:
 
+Install the package in editable mode (see Adding your own data directly above):
 
-```bash
-
-git  clone  https://github.com/forestdatapartnership/whisp.git
-
-cd  whisp/
-
-pip  install  -e  .[dev]
-
-```
-
-Add additional dependencies required for testing and running pre-commit hooks:
+Then add additional dependencies required for testing and running pre-commit hooks:
 
 
 ```bash
@@ -315,7 +303,6 @@ pre-commit  install
 You should be able to run the Pytest suite by simply running the `pytest` command from the repo's root folder.
 
 
-
 Please read the [contributing guidelines](contributing_guidelines.md) for good practice recommendations
 
 

{openforis_whisp-2.0.0a3 → openforis_whisp-2.0.0a5}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "openforis-whisp"
-version = "2.0.0a3"
+version = "2.0.0a5"
 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>"]