openforis-whisp 0.1.0a5__tar.gz → 0.1.0a7__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (17) hide show
  1. {openforis_whisp-0.1.0a5 → openforis_whisp-0.1.0a7}/PKG-INFO +28 -5
  2. {openforis_whisp-0.1.0a5 → openforis_whisp-0.1.0a7}/README.md +26 -3
  3. {openforis_whisp-0.1.0a5 → openforis_whisp-0.1.0a7}/pyproject.toml +3 -2
  4. {openforis_whisp-0.1.0a5 → openforis_whisp-0.1.0a7}/src/openforis_whisp/risk.py +2 -2
  5. {openforis_whisp-0.1.0a5 → openforis_whisp-0.1.0a7}/LICENSE +0 -0
  6. {openforis_whisp-0.1.0a5 → openforis_whisp-0.1.0a7}/src/openforis_whisp/__init__.py +0 -0
  7. {openforis_whisp-0.1.0a5 → openforis_whisp-0.1.0a7}/src/openforis_whisp/data_conversion.py +0 -0
  8. {openforis_whisp-0.1.0a5 → openforis_whisp-0.1.0a7}/src/openforis_whisp/datasets.py +0 -0
  9. {openforis_whisp-0.1.0a5 → openforis_whisp-0.1.0a7}/src/openforis_whisp/logger.py +0 -0
  10. {openforis_whisp-0.1.0a5 → openforis_whisp-0.1.0a7}/src/openforis_whisp/parameters/__init__.py +0 -0
  11. {openforis_whisp-0.1.0a5 → openforis_whisp-0.1.0a7}/src/openforis_whisp/parameters/config_runtime.py +0 -0
  12. {openforis_whisp-0.1.0a5 → openforis_whisp-0.1.0a7}/src/openforis_whisp/parameters/lookup_context_and_metadata.csv +0 -0
  13. {openforis_whisp-0.1.0a5 → openforis_whisp-0.1.0a7}/src/openforis_whisp/parameters/lookup_gee_datasets.csv +0 -0
  14. {openforis_whisp-0.1.0a5 → openforis_whisp-0.1.0a7}/src/openforis_whisp/pd_schemas.py +0 -0
  15. {openforis_whisp-0.1.0a5 → openforis_whisp-0.1.0a7}/src/openforis_whisp/reformat.py +0 -0
  16. {openforis_whisp-0.1.0a5 → openforis_whisp-0.1.0a7}/src/openforis_whisp/stats.py +0 -0
  17. {openforis_whisp-0.1.0a5 → openforis_whisp-0.1.0a7}/src/openforis_whisp/utils.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.3
2
2
  Name: openforis-whisp
3
- Version: 0.1.0a5
3
+ Version: 0.1.0a7
4
4
  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.
5
5
  License: MIT
6
6
  Keywords: whisp,geospatial,data-processing
@@ -21,6 +21,7 @@ Requires-Dist: country_converter (>=0.7,<2.0.0)
21
21
  Requires-Dist: earthengine-api
22
22
  Requires-Dist: geemap
23
23
  Requires-Dist: geojson (>=2.5.0,<3.0.0)
24
+ Requires-Dist: geopandas (>=1.0.1,<2.0.0)
24
25
  Requires-Dist: ipykernel (>=6.17.1,<7.0.0)
25
26
  Requires-Dist: numpy (>=1.21.0,<3.0.0)
26
27
  Requires-Dist: pandas (>=1.3.0,<3.0.0)
@@ -30,7 +31,7 @@ Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
30
31
  Requires-Dist: rsa (>=4.2,<5.0.0)
31
32
  Requires-Dist: shapely (>=2.0.2,<3.0.0)
32
33
  Project-URL: Documentation, https://github.com/forestdatapartnership/whisp#readme
33
- Project-URL: Development Branch, https://github.com/forestdatapartnership/whisp/tree/package-test-new-structure
34
+ Project-URL: Development Branch, https://github.com/forestdatapartnership/whisp/tree/main
34
35
  Project-URL: Issues, https://github.com/forestdatapartnership/whisp/issues
35
36
  Project-URL: Repository, https://github.com/forestdatapartnership/whisp
36
37
  Description-Content-Type: text/markdown
@@ -74,7 +75,7 @@ The Forest Data Partnership promotes this approach for forest and commodities mo
74
75
 
75
76
  2. [Whisp in Earthmap](https://whisp.earthmap.org/?aoi=WHISP&boundary=plot1&layers=%7B%22CocoaETH%22%3A%7B%22opacity%22%3A1%7D%2C%22JRCForestMask%22%3A%7B%22opacity%22%3A1%7D%2C%22planet_rgb%22%3A%7B%22opacity%22%3A1%2C%22date%22%3A%222020-12%22%7D%7D&map=%7B%22center%22%3A%7B%22lat%22%3A7%2C%22lng%22%3A4%7D%2C%22zoom%22%3A3%2C%22mapType%22%3A%22satellite%22%7D&statisticsOpen=true) supports the visualization of geometries on actual maps with the possibility to toggle different relevant map products around tree cover, commodities and deforestation. It is practical for demonstration purposes and spot checks of single geometries but not recommended for larger datasets.
76
77
 
77
- 3. Datasets of any size, especially when holding more than 1000 geometries, can be "whisped" through the [python package on pip](https://pypi.org/project/openforis-whisp/). See example [Colab Notebook](https://github.com/forestdatapartnership/whisp/blob/package-test-new-structure/notebooks/Colab_whisp_geojson_to_csv.ipynb) for implementation with a geojson input. For the detailed procedure please go to the section [Whisp notebooks](#whisp_notebooks).
78
+ 3. Datasets of any size, especially when holding more than 1000 geometries, can be "whisped" through the [python package on pip](https://pypi.org/project/openforis-whisp/). See example [Colab Notebook](https://github.com/forestdatapartnership/whisp/blob/main/notebooks/Colab_whisp_geojson_to_csv.ipynb) for implementation with a geojson input. For the detailed procedure please go to the section [Whisp notebooks](#whisp_notebooks).
78
79
 
79
80
 
80
81
  ## Whisp datasets <a name="whisp_datasets"></a>
@@ -111,7 +112,7 @@ However, under the same circumstances but with <u>no</u> disturbances reported a
111
112
 
112
113
  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.
113
114
 
114
- A simple example of the package functionality can be seen in this [Colab Notebook](https://github.com/forestdatapartnership/whisp/blob/package-test-new-structure/notebooks/Colab_whisp_geojson_to_csv.ipynb)
115
+ 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)
115
116
 
116
117
  ## Requirements for running the package
117
118
 
@@ -144,7 +145,7 @@ More info on Whisp can be found in [here](https://openknowledge.fao.org/items/e9
144
145
  There are two main approaches: to request a layer be incorporated into the core Whisp inputs, or to add in your own data directly to complement the core ones in Whisp. Currently the latter approach is under revision since moving to implementation in a python package. In the meantime please contact us through the issues page if this is functionality is useful to you.
145
146
 
146
147
  ## Contributing to the Whisp code base
147
- 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. If in doubt get in contact first or log as an issue [here](https://github.com/forestdatapartnership/whisp/issues/).
148
+ 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 in main. If in doubt get in contact first or log as an issue [here](https://github.com/forestdatapartnership/whisp/issues/).
148
149
 
149
150
  Install the package in editable mode with the additional dependencies required for testing and running pre-commit hooks:
150
151
  ```
@@ -162,3 +163,25 @@ You should be able to run the Pytest suite by simple running the `pytest` comman
162
163
 
163
164
  Please read the [contributing guidelines](contributing_guidelines.md) for good practice recommendations.
164
165
 
166
+
167
+ ## Code of Conduct <a name="whisp_conduct"></a>
168
+
169
+ **Purpose**
170
+ We are dedicated to maintaining a safe and respectful environment for all users. Harassment or abusive behavior will not be tolerated. <br>
171
+
172
+ **Scope**
173
+ This Code applies to all interactions on the repository and on the app.
174
+
175
+ **Expectations** <br>
176
+ *- Respect others:* Treat all contributors and users with courtesy and kindness. <br>
177
+ *- Constructive communication:* Engage respectfully, even in disagreements. <br>
178
+ *- Protect privacy:* Do not share personal information without consent.
179
+
180
+ **Prohibited Conduct** <br>
181
+ *- Harassment:* Unwanted or abusive communication, stalking, threats, or bullying.<br>
182
+ *- Discrimination:* Any form of hate speech or exclusion based on race, gender, orientation, or other identities.<br>
183
+ *- Inappropriate Content:* Posting offensive, harmful, or explicit material.
184
+
185
+ **Reporting**
186
+ Users can report violations directly to us by emailing the address listed in the "Contact Us" section of the website:
187
+ https://openforis.org/solutions/whisp/
@@ -37,7 +37,7 @@ The Forest Data Partnership promotes this approach for forest and commodities mo
37
37
 
38
38
  2. [Whisp in Earthmap](https://whisp.earthmap.org/?aoi=WHISP&boundary=plot1&layers=%7B%22CocoaETH%22%3A%7B%22opacity%22%3A1%7D%2C%22JRCForestMask%22%3A%7B%22opacity%22%3A1%7D%2C%22planet_rgb%22%3A%7B%22opacity%22%3A1%2C%22date%22%3A%222020-12%22%7D%7D&map=%7B%22center%22%3A%7B%22lat%22%3A7%2C%22lng%22%3A4%7D%2C%22zoom%22%3A3%2C%22mapType%22%3A%22satellite%22%7D&statisticsOpen=true) supports the visualization of geometries on actual maps with the possibility to toggle different relevant map products around tree cover, commodities and deforestation. It is practical for demonstration purposes and spot checks of single geometries but not recommended for larger datasets.
39
39
 
40
- 3. Datasets of any size, especially when holding more than 1000 geometries, can be "whisped" through the [python package on pip](https://pypi.org/project/openforis-whisp/). See example [Colab Notebook](https://github.com/forestdatapartnership/whisp/blob/package-test-new-structure/notebooks/Colab_whisp_geojson_to_csv.ipynb) for implementation with a geojson input. For the detailed procedure please go to the section [Whisp notebooks](#whisp_notebooks).
40
+ 3. Datasets of any size, especially when holding more than 1000 geometries, can be "whisped" through the [python package on pip](https://pypi.org/project/openforis-whisp/). See example [Colab Notebook](https://github.com/forestdatapartnership/whisp/blob/main/notebooks/Colab_whisp_geojson_to_csv.ipynb) for implementation with a geojson input. For the detailed procedure please go to the section [Whisp notebooks](#whisp_notebooks).
41
41
 
42
42
 
43
43
  ## Whisp datasets <a name="whisp_datasets"></a>
@@ -74,7 +74,7 @@ However, under the same circumstances but with <u>no</u> disturbances reported a
74
74
 
75
75
  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.
76
76
 
77
- A simple example of the package functionality can be seen in this [Colab Notebook](https://github.com/forestdatapartnership/whisp/blob/package-test-new-structure/notebooks/Colab_whisp_geojson_to_csv.ipynb)
77
+ 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)
78
78
 
79
79
  ## Requirements for running the package
80
80
 
@@ -107,7 +107,7 @@ More info on Whisp can be found in [here](https://openknowledge.fao.org/items/e9
107
107
  There are two main approaches: to request a layer be incorporated into the core Whisp inputs, or to add in your own data directly to complement the core ones in Whisp. Currently the latter approach is under revision since moving to implementation in a python package. In the meantime please contact us through the issues page if this is functionality is useful to you.
108
108
 
109
109
  ## Contributing to the Whisp code base
110
- 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. If in doubt get in contact first or log as an issue [here](https://github.com/forestdatapartnership/whisp/issues/).
110
+ 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 in main. If in doubt get in contact first or log as an issue [here](https://github.com/forestdatapartnership/whisp/issues/).
111
111
 
112
112
  Install the package in editable mode with the additional dependencies required for testing and running pre-commit hooks:
113
113
  ```
@@ -124,3 +124,26 @@ pre-commit install
124
124
  You should be able to run the Pytest suite by simple running the `pytest` command from the repo's root folder.
125
125
 
126
126
  Please read the [contributing guidelines](contributing_guidelines.md) for good practice recommendations.
127
+
128
+
129
+ ## Code of Conduct <a name="whisp_conduct"></a>
130
+
131
+ **Purpose**
132
+ We are dedicated to maintaining a safe and respectful environment for all users. Harassment or abusive behavior will not be tolerated. <br>
133
+
134
+ **Scope**
135
+ This Code applies to all interactions on the repository and on the app.
136
+
137
+ **Expectations** <br>
138
+ *- Respect others:* Treat all contributors and users with courtesy and kindness. <br>
139
+ *- Constructive communication:* Engage respectfully, even in disagreements. <br>
140
+ *- Protect privacy:* Do not share personal information without consent.
141
+
142
+ **Prohibited Conduct** <br>
143
+ *- Harassment:* Unwanted or abusive communication, stalking, threats, or bullying.<br>
144
+ *- Discrimination:* Any form of hate speech or exclusion based on race, gender, orientation, or other identities.<br>
145
+ *- Inappropriate Content:* Posting offensive, harmful, or explicit material.
146
+
147
+ **Reporting**
148
+ Users can report violations directly to us by emailing the address listed in the "Contact Us" section of the website:
149
+ https://openforis.org/solutions/whisp/
@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
4
4
 
5
5
  [tool.poetry]
6
6
  name = "openforis-whisp"
7
- version = "0.1.0a5"
7
+ version = "0.1.0a7"
8
8
  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."
9
9
  repository = "https://github.com/forestdatapartnership/whisp"
10
10
  authors = ["Andy Arnell <and.arnell@fao.org>"]
@@ -22,7 +22,7 @@ classifiers = [
22
22
 
23
23
  [tool.poetry.urls]
24
24
  "Documentation" = "https://github.com/forestdatapartnership/whisp#readme"
25
- "Development Branch" = "https://github.com/forestdatapartnership/whisp/tree/package-test-new-structure"
25
+ "Development Branch" = "https://github.com/forestdatapartnership/whisp/tree/main"
26
26
  "Issues" = "https://github.com/forestdatapartnership/whisp/issues"
27
27
 
28
28
  [tool.poetry.dependencies]
@@ -39,6 +39,7 @@ pydantic-core = ">=2.14.0,<3.0.0" # Updated version constraint
39
39
  rsa = ">=4.2,<5.0.0" # Updated version constraint
40
40
  ipykernel = ">=6.17.1,<7.0.0" # Compatible with Colab
41
41
  shapely = "^2.0.2"
42
+ geopandas = "^1.0.1"
42
43
 
43
44
  [tool.poetry.group.dev.dependencies]
44
45
  pytest = ">=6.2.5,<7.0.0"
@@ -21,8 +21,8 @@ def whisp_risk(
21
21
  df: data_lookup_type, # CHECK THIS
22
22
  ind_1_pcent_threshold: float = 10, # default values (draft decision tree and parameters)
23
23
  ind_2_pcent_threshold: float = 10, # default values (draft decision tree and parameters)
24
- ind_3_pcent_threshold: float = 0, # default values (draft decision tree and parameters)
25
- ind_4_pcent_threshold: float = 0, # default values (draft decision tree and parameters)
24
+ ind_3_pcent_threshold: float = 10, # default values (draft decision tree and parameters)
25
+ ind_4_pcent_threshold: float = 10, # default values (draft decision tree and parameters)
26
26
  ind_1_input_columns: pd.Series = None, # see lookup_gee_datasets for details
27
27
  ind_2_input_columns: pd.Series = None, # see lookup_gee_datasets for details
28
28
  ind_3_input_columns: pd.Series = None, # see lookup_gee_datasets for details