Welcome to GeoCARET’s documentation

GeoCARET : Pronounced geokærət as in bʌkət or geokæreɪ as in bʊˈkeɪ.

Version: 1.0.0

GeoCARET is a command line Python tool for delineating and analysing catchments and reservoirs. It relies on Google Earth Engine (GEE) - Google’s cloud-based platform developed for planetary-scale environmental analysis. GeoCARET uses Google Earth Engine as a backend for performing geometry operations and data processing and as a database of global spatial data in the form of GIS layers. GeoCARET performs its computations on global spatial datasets available in GEE and additionally relies on several private assets. We have made these assets accessible for analysis by uploading them to a dedicated GEE asset folder.

Important

The users need to request permission from us to use the dedicated private assets before they can make successful runs with GeoCARET. Please refer to the Installation Guidelines for further instructions. To request access to those assets please send email to: Tomasz Janus - Email 1 or Tomasz Janus - Email 2 with your email address registered with the Google Earth Engine.

Contents:

• Introduction
  • Functionality
  • Architecture
  • Origins
  • Vision
• Installation
  • Installation as a Python Package - Option 1
  • Installation using Docker - Option 2
  • Additional Steps
• Algorithms
• Running GeoCARET
• GHG Model Input Calculations
  • Sections
    • Preparing Input Data
    • GIS Assets
    • Output Data
    • Exporting to Google Drive
    • Alternative Parameters and Definitions
    • Köppen-Geiger climate zone classification
    • Limitations
• Configuration Options
  • Jensen Search Radius
  • Upstream Basin Finding Method
  • Use of Digital Elevation Models (DEMs)
  • Use of dam location for reservoir delineation
  • Export Options
• Python API reference
• License
  • Software
  • Documentation
• Acknowledgments

Indices and tables

• Index

• Module Index

• Search Page