Reference

nldi-xstool

nldi-xstool is a command line tool to for elevation-based services to the NLDI.

Usage

nldi-xstool [OPTIONS] COMMAND [ARGS]...

Options

--outcrs <outcrs>

Projection CRS to return cross-section geometry: default is epsg:4326

--version

Show the version and exit.

xsatendpts

Topographic cross-section at user-defined end points.

This function relies on the U.S. Geological Survey’s 3DEP program elevation services to return a topographic cross-section based on user-defined end-points, number of points, and 3DEP spatial resolution.

NOTE: 3DEP does not specifically include bathymetry.

Usage

nldi-xstool xsatendpts [OPTIONS]

Options

-s, --startpt <startpt>

Required format x y pair as floats for example: -103.801134 40.267335

-e, --endpt <endpt>

Required format x y pair as floats for example: -103.800787 40.272798

-c, --crs <crs>

Required spatial reference of input data

-f, --file <file>

enter path and filename for json ouput: path/to/file.json

-n, --numpoints <numpoints>

number of points in cross-section

-r, --resolution <resolution>

Resolution of DEM used. Note: 3DEP provides server side interpolatin given best available data

Options:

1m | 3m | 5m | 10m | 30m | 60m

-v, --verbose

verbose ouput

xsatpathpts

Topographic cross-section at user-defined end points.

This function relies on the U.S. Geological Survey’s 3DEP program elevation services to return a topographic cross-section based on user-defined end-points, number of points, and 3DEP spatial resolution.

NOTE: 3DEP does not specifically include bathymetry.

Usage

nldi-xstool xsatpathpts [OPTIONS] PATH

Options

-c, --crs <crs>

Required spatial reference of input data

-f, --file <file>

enter path and filename for json ouput: path/to/file.json

-n, --numpoints <numpoints>

number of points in cross-section

-r, --resolution <resolution>

Resolution of DEM used. Note: 3DEP provides server side interpolatin given best available data

Options:

1m | 3m | 5m | 10m | 30m | 60m

-v, --verbose

verbose ouput

Arguments

PATH

Required argument

xsatpoint

Topographic cross-section at user-defined point.

This function relies on the U.S. Geological Survey’s NLDI and 3DEP program elevation services to return a topographic cross-section, at nearest NHD stream-segment based on user-defined point, width, number of points, and 3DEP spatial resolution.

NOTE: 3DEP does not specifically include bathymetry.

Usage

nldi-xstool xsatpoint [OPTIONS]

Options

-ll, --lonlat <lonlat>

Required format lon,lat (x,y) as floats for example: -103.8011 40.2684

-w, --width <width>

width of cross-section

-f, --file <file>

enter path and filename for json ouput: path/to/file.json

-n, --numpoints <numpoints>

number of points in cross-section

-r, --resolution <resolution>

Resolution of DEM used. Note: 3DEP provides server side interpolatin given best available data

Options:

1m | 3m | 5m | 10m | 30m | 60m

-v, --verbose

verbose ouput