Getting Started

This section will help you get up and running with the Hydro-Topo Features package.

• Installation
  • Requirements
  • Using pip
  • Using conda
  • Installing from Source
  • Platform-Specific Instructions
  • Docker
  • Verifying Installation
  • Troubleshooting
• Quick Start Guide
  • Basic Usage
  • Example with Custom Parameters
  • Command Line Interface
  • Complete Example Workflow
  • What’s Next?

Overview

Hydro-Topo Features is a Python package for extracting hydro-topographic variables from Digital Elevation Models (DEMs) and OpenStreetMap (OSM) water data. The package is designed to be:

• Easy to use: Simple API with sensible defaults

• Flexible: Numerous options for customization

• Efficient: Optimized for processing large areas

• Well-documented: Comprehensive documentation and examples

The package extracts three key variables:

1. Height Above Nearest Drainage (HAND): Vertical distance to the nearest drainage channel

2. Euclidean Distance to Waterbody (EDTW): Straight-line distance to the nearest water body

3. Terrain Slope: Maximum rate of elevation change

Key Features

• Automated DEM conditioning including stream burning, depression filling, and flat resolution

• Efficient computation of flow direction and accumulation

• Multiple algorithms for feature extraction

• Flexible visualization options including static and interactive maps

• Command-line interface for batch processing

• Integration with common GIS libraries and formats

Next Steps

1. Start by following the Installation instructions

2. Try the examples in the Quick Start Guide guide

3. Explore the detailed documentation in the Usage Guide section

4. Check out real-world examples in the Examples section