CLI Usage Examples

Installed Commands

sarpyx --help
sarpyx worldsar --help
sarpyx pipeline --help
sarpyx pipeline --list
sarpyx-worldsar --help
sarpyx-pipeline --help

WorldSAR Single Product

sarpyx worldsar \
  --input /data/product.SAFE \
  --output /data/out/worldsar \
  --cuts-outdir /data/out/worldsar/tiles \
  --grid-path /data/grid/grid_10km.geojson \
  --gpt-path /opt/esa-snap/bin/gpt \
  --snap-userdir /data/out/.snap \
  --gpt-memory 16G \
  --gpt-cache-size 8G \
  --gpt-parallelism 6

WorldSAR Sentinel-1 Options

sarpyx worldsar \
  --input /data/S1A_IW_SLC_1SDV_PRODUCT.SAFE \
  --output /data/out/iw2 \
  --grid-path /data/grid/grid_10km.geojson \
  --gpt-path "$GPT_PATH" \
  --sentinel-swath IW2 \
  --sentinel-first-burst 3 \
  --sentinel-last-burst 8 \
  --sentinel-subap-decompositions 2 4

Convert H5 Tiles to Zarr

sarpyx worldsar \
  --input /data/tiles/tile_001.h5 \
  --output /data/tiles/tile_001.zarr \
  --h5-to-zarr-only \
  --overwrite-zarr \
  --zarr-chunk-size 256 256

Explicit Single-Product Pipeline

sarpyx pipeline s1_tops \
  --input /data/product.SAFE \
  --output /data/out/s1_tops \
  --grid-path /data/grid/grid_10km.geojson \
  --cuts-outdir /data/out/s1_tops/tiles \
  --gpt-path "$GPT_PATH" \
  --param sentinel_swath=IW2 \
  --param selected_polarisations='["VV"]'

Sentinel-1 InSAR Pipeline

sarpyx pipeline s1_insar \
  --master /data/master.SAFE \
  --slave /data/slave.SAFE \
  --output /data/out/insar \
  --grid-path /data/grid/grid_10km.geojson \
  --cuts-outdir /data/out/insar/tiles \
  --gpt-path "$GPT_PATH" \
  --param subswath=IW2 \
  --param selected_polarisations='["VV"]' \
  --param use_esd=false

--param NAME=VALUE parses JSON values when possible. For example, false becomes a boolean, 2 becomes an integer, and ["VV"] becomes a list.

Output Checks

rg --files /data/out/worldsar /data/out/worldsar/tiles \
  | rg '\.(dim|h5|zarr|tif|tiff|npz|npy|pkl|txt|pdf|json)$'