LSDtopotools / LSDTopoTools2

LSDTopoTools version 2.x. This is the brand spanking new version of LSDTopoTools.

LSDTopoTools 0.9

Overview

This is the LSDTopoTools2 software package. It is part of the LSDTopoTools family of topographic analysis tools. These include:

• LSDTopoTools2: A series of command line tools that are used for topographic analysis. Installation instructions below.

• lsdviztools: A python package for visualising LSDTopoTools2 outputs. See https://github.com/LSDtopotools/lsdviztools

• lsdtopytools: The python bindings for LSDTopoTools. Still under construction. https://github.com/LSDtopotools/lsdtopytools

The LSDTopoTools2 repository contains the source code for 6 command line tools:

• lsdtt-basic-metrics: Basic topographic analysis. Surface metrics, basic channel and basin extraction, raster preprocessing and other simple routines.

• lsdtt-channel-extraction: Extracts channels. This uses a variety of algorthims suited for topographic data that is better than 10m grid resolution and ideally from lidar data (3m resolution or better).

• lsdtt-chi-mapping: Routines for so-called chi analysis: this is used in tectonic geomorphology.

• lsdtt-cosmo-tool: Tools for calculating erosion rates based on 10Be and 26Al concentrations measured in stream sediments and soils.

• lsdtt-hillslope-channel-coupling: Routines for hilltop flow routing and linking ridgetop pixels to channels.

• lsdtt-valley-metrics: Routines for valley and terrace extraction

Documentation

• You can see all the options by using a -h flag after the command line tool.

• You can see the version using the -v flag

• The main documentation for LSDTopoTools can be found here: https://lsdtopotools.github.io/LSDTT_documentation/

• Full installation instructions: https://lsdtopotools.github.io/LSDTT_documentation/LSDTT_installation.html

  • The shortcut is to install miniconda and then run conda install lsdtopotools

• Simple usage is explained in https://lsdtopotools.github.io/LSDTT_documentation/LSDTT_basic_usage.html

Update history

• 0.9 More testing of terrace and floodplain extraction. A few new routines in basic metrics. See history.asc file.

• 0.8 Improved cosmogenics. Shapefile from channel extraction. Generation of steady state landscapes. See history.asc file.

• 0.7 improved valley extraction. Large changes to the cosmogenic tools including forward modelling component. This version removes the dependency on the point cloud library and replaces it with dependency on the OpenCV library.

• 0.6 Added valley extraction. This had limited functionality since it did not have the valley width tools.

• 0.5 Now includes help files.

Basic Installation

Below are several methods for installing LSDTopoTools2.

Conda installation

1. Install miniconda

2. Set up an environment (if you don’t know how to do that use google)

3. $ conda install -c conda-forge lsdtopotools

4. As of 23/06/2023 we are updating feedstocks so version 0.9 should be ready soon. All previous versions are available. WARNING: Currently doesn’t work on Windows.

Use the docker container

1. Install docker for windows io MacOS, or docker engine on linux

2. Pull our full lsdtopotools container:

   $ docker pull lsdtopotools/lsdtt_pytools_docker

3. Run the container

   $ docker run -it -v C:\LSDTopoTools:/LSDTopoTools lsdtopotools/lsdtt_pytools_docker

4. LSDTopoTools2 is already installed!

5. You can alternatively use *LSDTopoTools through an interactive environment using this container. See the readme here: https://hub.docker.com/r/lsdtopotools/lsdtt_pytools_docker

Build locally

1. Clone the repository.

2. Go into the src directory.

3. Run

   $ sh build.sh

4. This compiles the source code. The programs will be moved into the bin directory. To make these accessible from anywhere in your current terminal session, you need to:

   1. Go into the main repository directory (if you are in src, then use cd ..).

   2. Run:

      $ sh lsdtt2_terminal.sh