Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Installation

Prebuilt binary

The quickest option: every release attaches prebuilt archives for Linux and macOS (x86_64 and arm64) to its GitHub release. They bundle HDF5 and netCDF, so they need no system libraries at all: download the archive for your platform, unpack it, and run the seastamp binary inside. The helper scripts ship in the archive alongside it.

The Linux binaries are linked against glibc 2.17, so they run on any distribution with glibc 2.17 or newer: RHEL / CentOS 7, Rocky Linux 8, Ubuntu 18.04, Debian 9, and everything more recent.

From crates.io

cargo install seastamp

This compiles from source, so the depth command needs the HDF5 / NetCDF development headers (see System dependencies).

Build from source

seastamp is a Rust project, so a recent stable toolchain is all you need:

git clone https://github.com/AIQC-Hub/seastamp
cd seastamp
cargo build --release
# binary at target/release/seastamp

To build a self-contained binary that vendors HDF5 and netCDF (as the release archives do, needing no system libraries), add --features static-netcdf. This compiles the C libraries from source, so it needs cmake and takes longer.

System dependencies

Only the depth command needs anything beyond the Rust toolchain: it reads GEBCO NetCDF and links the HDF5 / NetCDF C libraries, so a source or cargo install build needs their development headers (the same system dependency as ctddump):

# Ubuntu / Debian
sudo apt-get install libhdf5-dev libnetcdf-dev

# macOS
brew install hdf5

The other four commands (coast, sea, place, nearest) use only pure-Rust geometry and have no system dependencies. The prebuilt binary and a --features static-netcdf build vendor the C libraries, so neither needs these.

Shell completion

Optional, and worth the minute it takes: seastamp completions <shell> prints a completion script, after which Tab fills in commands, flags, their enumerated values, and all 109 names --region accepts.

# bash
mkdir -p ~/.local/share/bash-completion/completions
seastamp completions bash > ~/.local/share/bash-completion/completions/seastamp

# zsh (with ~/.zfunc on $fpath)
mkdir -p ~/.zfunc
seastamp completions zsh > ~/.zfunc/_seastamp

# fish
seastamp completions fish > ~/.config/fish/completions/seastamp.fish

Start a new shell afterwards, and regenerate the script when you upgrade seastamp: it is a snapshot of one version’s CLI. elvish and powershell are supported too. See completions for the details, including how to make bash list candidates on the first Tab.

Reference data

The datasets each command stamps from (shorelines, bathymetry, sea polygons, country and municipality boundaries) are large and are not bundled. Download the ones you need with the helper script, described under Reference datasets.

Check it works

seastamp --help
seastamp coast --help

Every command is self-documenting through --help at each level.