Streamkit

A set of tools for identifying and analyzing stream networks in digital elevation models.

Documentation: https://avkoehl.github.io/streamkit/

Installation

Core

pip install "streamkit @ git+https://github.com/avkoehl/streamkit"

With optional dependencies

# USGS data downloading
pip install "streamkit[datasets] @ git+https://github.com/avkoehl/streamkit"

# Reach segmentation
pip install "streamkit[segmentation] @ git+https://github.com/avkoehl/streamkit"

# Everything
pip install "streamkit[all] @ git+https://github.com/avkoehl/streamkit"

For development

git clone git@github.com:avkoehl/streamkit.git
cd streamkit
uv sync --all-extras

Tests

uv run pytest -v

Documentation

uv run quartodoc build
quarto preview

Jupyter kernel

Run the following command once:

uv run python -m ipykernel install --user --name=streamkit

Then select the streamkit kernel in Jupyter Lab.

Start Jupyter Lab:

uv run jupyter lab