Skip to content

Latest commit

 

History

History
113 lines (83 loc) · 3.04 KB

README.md

File metadata and controls

113 lines (83 loc) · 3.04 KB

Whisp: Geospatial Analysis Tool for Zero-Deforestation Claims

Overview

Whisp is a tool that provides a detailed geospatial analysis via Google Earth Engine (GEE) to aid in zero-deforestation claims. It ingests geometries in either WKT (Well-Known Text) or GeoJSON format.

Currently the application can be found here.

Endpoints

Analyze WKT

  • Method: POST
  • URL: https://whisp.openforis.org/api/wkt
  • Summary: Send wkt geometry and obtain JSON table containing data
  • Request Body: 
    {
  "wkt": "string"
}
  • Responses: 
    {
  "data": {"object"},
  "token": "string"
}

Analyze GeoJson

  • Method: POST
  • URL: https://whisp.openforis.org/api/wkt
  • Summary: Send geojson according to standard RFC 7946, with a FeatureCollection or a single Feature with a polygon as its geometry, comes back with JSON table containing data for each individual polygon detected
  • Request Body: 
    {
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [longitude, latitude], [longitude, latitude], [longitude, latitude]
          ]
        ]
      }
    }
  ],
}```
  • Responses: 
    {
  "data": {"object"},
  "token": "string"
}```

Getting Started

To get started with Whisp, ensure you have Node.js and Python 3.11 installed on your system. We assume you are a registered user in Asset Registry and Collect Earth Online. Then, follow these steps:

  1. Clone the Repository

    git clone /~https://github.com/yourusername/whisp.git
cd whisp

  2. Install Dependencies

    • Install Google Earth Engine library

      pip install earthengine-api --upgrade

    • Install project dependencies

      npm install

  3. Configure the Application

    • Create a .env.local file for development at the root directory with the following environment variables:

      PYTHON_PATH=

    • Create a credentials.json in the root directory with your Google Earth Engine service account details.

  4. Create a Temp Folder

    Create a temp directory at the root to store analyses locally. This folder will be used for temporary storage during the geospatial analysis process.

  5. Run the Application

    npm run dev

    The application will start running on http://localhost:3000.

Contributing

Contributions are welcome! If you'd like to contribute, please fork the repository and create a pull request with your changes. For major changes, please open an issue first to discuss what you would like to change.

License

MIT

Built with ❤️ for forests and biodiversity.