12rambau / whisp-app

Whisp: Geospatial Analysis Tool for Zero-Deforestation Claims

Overview

Whisp is a powerful tool designed to support environmental conservation efforts by providing robust geospatial analysis. By ingesting geoids and geometries in either WKT (Well-Known Text) or GeoJSON formats, Whisp facilitates the creation of comprehensive supporting documentation necessary for claims under zero-deforestation regulatory mechanisms. This documentation can play a crucial role in validating efforts towards sustainability and compliance with environmental standards.

Currently the application can be here.

Features

• Data Ingestion: Accepts geoids and geometries in WKT or GeoJSON formats.
• Geospatial Analysis: Performs advanced analysis to support zero-deforestation claims.
• User-Friendly Interface: Built with Next.js 14, offering a seamless and intuitive user experience.

Endpoints

Analyze Geo IDs

• Method: POST
• URL: /geo-ids
• Summary: Analyze Geo IDs
• Description: Accepts an array of Geo IDs and returns analysis results.
• Request Body:

  {
    "geoIds": ["string"]
  }

• Responses:

  {
    "data": {"object"},
    "token": "string"
  }
  

Analyze WKT

• Method: POST
• URL: /wkt
• Summary: Send wkt geometry and obtain, comes back with JSON table containing data
• Description: Accepts an array of Geo IDs and returns analysis results
• Request Body:

  {
    "wkt": "string"
  }

• Responses:

  {
    "data": {"object"},
    "token": "string"
  }
  

Analyze GeoJson

• Method: POST
• URL: /geojson
• 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
• Description: Accepts an array of Geo IDs and returns analysis results
• Request Body:

  {
    "type": "FeatureCollection",
    "features": [
      {
        "type": "Feature",
        "geometry": {
          "type": "Polygon",
          "coordinates": [
            [
              [longitude, latitude], [longitude, latitude], [longitude, latitude]
            ]
          ]
        }
      }
    ]
  }

• Responses:

  {
    "data": {"objec:t"},
    "token": "string"
  }
  
  

Getting Started

To get started with Whisp, ensure you have Node.js 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

   npm install

3. Configure the Application

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

     PYTHON_PATH=
     ASSET_REGISTRY_BASE=https://api-ar.agstack.org
     USER_REGISTRY_BASE=https://user-registry.agstack.org
     API_KEY=
     CLIENT_SECRET=
     CEO_EMAIL=
     CEO_PASSWORD=
     

   • 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 the environment.