Skip to content

lsdviztools3

Welcome to lsdviztools3, the visualisation package for lsdtt3 (its documentation is at https://lsdtopotools.github.io/lsdtt3/). It is a ground-up rewrite of the lsdviztools plotting stack around PyGMT (maps) and matplotlib (x–y charts). lsdviztools3 only draws: every map and chart is a view of a file lsdtt3 wrote.

Install with pip (Python 3.12 or later) into an environment that has GMT (pip installs PyGMT and everything else, but not the GMT library PyGMT wraps):

conda create -n lsdviz -c conda-forge python=3.12 gmt pygmt
conda activate lsdviz
python -m pip install lsdviztools3

The README has the other routes (Google Colab, GMT from Homebrew or your system, a clone with pixi for development, a specific release's wheel) and a quick start. What's new lists the changes in each release. Each page below shows its plots both as command-line invocations (headless PNG output) and as Python / notebook code. The commands are written as run from a clone (pixi run lsdviz3-...); after a pip install, leave out pixi run.

Guide

Page What it covers
Getting started Coordinate modes, MapStyle, saving, target directories; downloading a DEM; running lsdtt3 from Python; the workflow helpers and example scripts
Basic plots Hillshades, raster drapes, colouring in classes, basins, points, locator maps and insets, decorations, 3D relief, vector overlays, swath profiles
Chi analysis k_sn maps, stacked chi plots and single-basin profiles (lsdviz3-chi)
Channel networks Channel maps, bearing roses and circular comparisons, junction angles (lsdviz3-channel-bearings), network geometry, divide migration, stream-burning QC, worked examples
Lithology Geologic unit maps, k_sn by lithologic unit, erodibility calibration
Valleys and cross sections Floodplains and terraces, method comparisons, the fluvial-surface ladder, valley widths, cross sections, hydraulic breaks, perimeter valley sources
Hillslopes and ridgelines Slope–area, gradient–curvature, E–R, hilltop–channel coupling, ridgeline profiles
Landscape evolution Animations of lsdtt-lem runs; hillslope solver comparisons
Cosmogenic nuclides Basin erosion-rate maps, chi with erosion rates, CRONUS and published-data comparisons, transient and landslide experiments
Spectral analysis 2D and radial spectra, significant frequencies, valley spacing
Command reference Every lsdviz3-* command and its flags, by topic
lsdtt3 outputs Which lsdtt3 switch writes each file, and which function plots it
What's new Changes in each release
Design For developers: the package's architecture and design decisions

Layout

docs/                   This guide
examples/               End-to-end scripts (channel bearings, faults, cosmo, ...)
lsdviztools3/           io (data) · render (PyGMT maps) · charts (matplotlib) · cli (headless) · workflows

Quick start from a clone

# one-time install of project env + editable package
pixi install
pixi run install

# render a keyless hillshade demo
pixi run demo-eigg