whisp

The Forest Data Partnership promotes a Convergence of Evidence approach for Forest and Commodities Monitoring.
https://github.com/forestdatapartnership/whisp

Category: Biosphere
Sub Category: Deforestation and Reforestation

Last synced: about 24 hours ago
JSON representation

Repository metadata

README.md

whisp

License: MIT
Data Protection Policy
DOI

Whisp_OpenForis_Banner_Github

Convergence of Evidence

Whisp stands for "What is in that plot"?

Numerous publicly available Earth Observation maps provide data on tree cover, land use, and forest disturbances. However, these maps often differ from one another because they use various definitions and classification systems. As a result, no single map can provide a complete picture of any specific area. To address this issue, the Forest Data Partnership (FDaP) and the AIM4Forests Programme advocate for the Convergence of Evidence approach.

The Forest Data Partnership promotes this approach for forest and commodities monitoring, assuming that

  • no single source of geospatial data can tell the whole story around any given plot of land;
  • all the existing, published and available datasets contribute to telling that story.

Contents

Whisp pathways

Whisp can currently be used directly or implemented in your own code through three different pathways:

  1. The Whisp App with its simple interface can be accessed here or called from other software by API. The Whisp App currently supports the processing of up to 3,000 geometries per job. The original JS & Python code behind the Whisp App and API can be found here.

  2. Whisp in Earthmap 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.

  3. Datasets of any size, especially when holding more than 3,000 geometries, can be analyzed with Whisp through the python package on pip. See example Colab Notebook for implementation with a geojson input. For further notebooks processing options see Whisp notebooks.

Whisp datasets

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).

Additional categories are specific for the timber commodity, considering a harvesting date in 2023:

  1. Primary forests in 2020;
  2. Naturally regenerating forests in 2020;
  3. Planted and plantation forests in 2020;
  4. Planted and plantation forests in 2023;
  5. Treecover in 2023;
  6. Commodities or croplands in 2023.
  7. Logging concessions;

There are multiple datasets for each category. Find the full current list of datasets used in Whisp here.

Whisp risk assessment

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?

And specifically for the timber commodity, considering a harvesting date in 2023:

  1. Were there primary forests in 2020?
  2. Were there naturally regenerating forests in 2020?
  3. Were there planted and plantation forests in 2020?
  4. Were there planted and plantation forests in 2023?
  5. Was there treecover in 2023?
  6. Were there commodity plantations or other agricultural uses in 2023?
  7. Is it part of a logging concession?

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

The relevant risk assessment column depends on the commodity in question:

The Whisp algorithm for Perennial Crops visualized:
CoE_Graphic 5

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 low. Such deforestation has happened before 2020, which aligns with the cutoff date for legislation, such as EUDR (European Union Deforestation Risk), 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 high.
However, under the same circumstances but with no 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.

Run Whisp python package from a notebook

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.

An example of the package functionality can be seen in this Colab Notebook

For running locally (or in Sepal), see: whisp_geojson_to_csv.ipynb or if datasets are very large (e.g., >100,000 features), see whisp_ee_asset_to_drive.ipynb

Requirements for running the package

  • A Google Earth Engine (GEE) account.
  • A registered cloud GEE project.
  • Some experience in Python or a similar language.

Python package installation

The Whisp package is available on pip
https://pypi.org/project/openforis-whisp/

It can be installed with one line of code:

pip install --pre openforis-whisp

The package relies upon the google earth engine api being setup correctly using a registered cloud project.

More info on Whisp can be found here

How to add data layers to Whisp

There are two main approaches:

  1. Request that a layer be incorporated into the core Whisp inputs, or

  2. Add your own data directly to complement the core datasets.


Requesting a layer addition

If you think a particular dataset has wide applicability for Whisp users, you can request it be added to the main Whisp repository by logging it as an issue in GitHub here.

Before submitting a request, consider the following:

  • Is the resolution high enough for plot-level analysis? (e.g., 30m or 10m resolution)

  • Is there an indication of data quality? (e.g., accuracy assessment detailed in a scientific publication)

  • Is there relevant metadata available?


Adding your own data directly

The python notebooks allow the user to add custom data layers. You can edit the Prepare layers section to do this in the Colab Notebook
To add your own data directly you will need some coding experience as well as familiarity with Google Earth Engine.

Contributing

Contributions are welcome!

  • Fork the repo, make changes, and open a pull request.
  • For adding new datasets to the codebase and for project-specific coding standards see .github/copilot-instructions.md

Code of Conduct

Purpose
We are dedicated to maintaining a safe and respectful environment for all users. Harassment or abusive behavior will not be tolerated.

Scope
This Code applies to all interactions on the repository and on the app.

Expectations
- Respect others: Treat all contributors and users with courtesy and kindness.
- Constructive communication: Engage respectfully, even in disagreements.
- Protect privacy: Do not share personal information without consent.

Prohibited Conduct
- Harassment: Unwanted or abusive communication, stalking, threats, or bullying.
- Discrimination: Any form of hate speech or exclusion based on race, gender, orientation, or other identities.
- Inappropriate Content: Posting offensive, harmful, or explicit material.

Reporting
Users can report violations of this Code of Conduct confidentially by contacting the Open Foris team at
open-foris@fao.org.

Feedback

We welcome all feedback and contributions!


Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 4 days ago

Total Commits: 396
Total Committers: 7
Avg Commits per committer: 56.571
Development Distribution Score (DDS): 0.611

Commits in past year: 184
Committers in past year: 5
Avg Commits per committer in past year: 36.8
Development Distribution Score (DDS) in past year: 0.288

Name Email Commits
andyarnell a****l@h****m 154
andyarnell y****u@e****m 127
astridverhegghen a****n@g****m 43
Jonas Spekker 9****k 30
lecrabe l****e 29
jonnvega 4****a 12
p3ace m****i@g****m 1

Committer domains:


Issue and Pull Request metadata

Last synced: 5 days ago

Total issues: 44
Total pull requests: 132
Average time to close issues: about 1 month
Average time to close pull requests: 1 day
Total issue authors: 16
Total pull request authors: 8
Average comments per issue: 0.75
Average comments per pull request: 0.06
Merged pull request: 107
Bot issues: 0
Bot pull requests: 0

Past year issues: 28
Past year pull requests: 68
Past year average time to close issues: about 1 month
Past year average time to close pull requests: 1 day
Past year issue authors: 11
Past year pull request authors: 4
Past year average comments per issue: 0.82
Past year average comments per pull request: 0.0
Past year merged pull request: 57
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/forestdatapartnership/whisp

Top Issue Authors

  • andyarnell (21)
  • lecrabe (4)
  • FlorentScarpaSustaain (3)
  • julesntare (3)
  • astridverhegghen (2)
  • wilderbravo (1)
  • ollieg (1)
  • aurelgrooves (1)
  • GDieguezG (1)
  • melvinlippe23 (1)
  • sergiobm11 (1)
  • rurdea (1)
  • koensneyers-dot (1)
  • FLUM2022 (1)
  • 12rambau (1)

Top Pull Request Authors

  • andyarnell (87)
  • jo-spek (22)
  • astridverhegghen (9)
  • lecrabe (6)
  • FlorentScarpaSustaain (3)
  • dfguerrerom (2)
  • estellerambier (2)
  • p3ace-0 (1)

Top Issue Labels

Top Pull Request Labels


Package metadata

proxy.golang.org: github.com/forestdatapartnership/whisp

pypi.org: openforis-whisp

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.

  • Homepage: https://github.com/forestdatapartnership/whisp
  • Documentation: https://github.com/forestdatapartnership/whisp#readme
  • Licenses: MIT
  • Latest release: 0.0.1 (published 11 months ago)
  • Last Synced: 2026-01-27T08:32:38.936Z (2 days ago)
  • Versions: 28
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 384 Last month
  • Rankings:
    • Dependent packages count: 9.546%
    • Average: 31.65%
    • Dependent repos count: 53.755%
  • Maintainers (1)

Dependencies

poetry.lock pypi
  • 124 dependencies
pyproject.toml pypi
  • pre-commit >=2.15.0,<3.0.0 develop
  • pytest >=6.2.5,<7.0.0 develop
  • ruff >=0.0.1,<1.0.0 develop
  • country-converter >=0.7,<2.0.0
  • earthengine-api *
  • geojson >=2.5.0,<3.0.0
  • geopandas ^1.0.1
  • ipykernel >=6.17.1,<7.0.0
  • numpy >=1.21.0,<3.0.0
  • pandas >=1.3.0,<3.0.0
  • pandera >=0.22.1,<1.0.0
  • pydantic-core >=2.14.0,<3.0.0
  • python >=3.10
  • python-dotenv >=1.0.1,<2.0.0
  • rsa >=4.2,<5.0.0
  • shapely ^2.0.2

Score: 11.588032937457035