offshore-dist-to-ports

Distance to Ports Command Line Interface

offshore-dist-to-ports [OPTIONS] COMMAND [ARGS]...

Options

--version

Show the version and exit.

-n, --name <name>

Job name.

Default:

'DistToPorts'

-v, --verbose

Flag to turn on debug logging. Default is not verbose.

from-config

Compute distance to ports from a config.

offshore-dist-to-ports from-config [OPTIONS]

Options

-c, --config <config>

Required Filepath to DistToPorts config json file.

-v, --verbose

Flag to turn on debug logging. Default is not verbose.

local

Compute distance to ports on local hardware

offshore-dist-to-ports local [OPTIONS]

Options

-ports, --ports_fpath <ports_fpath>

Required Path to shape, csv, or json file containing ports to compute least cost distance to

-excl, --excl_fpath <excl_fpath>

Required Filepath to exclusions h5 with techmap dataset.

-o, --out_dir <out_dir>

Required Directory to save distance to port geotiffs too.

-idl, --input_dist_layer <input_dist_layer>

Exclusions layer with distance to coast values

Default:

'dist_to_coast'

-mw, --max_workers <max_workers>

Number of workers to use for setback computation, if 1 run in serial, if > 1 run in parallel with that many workers, if None run in parallel on all available cores

Default:

1

-rm, --replace

Flag to replace existing ports geotiffs

-log, --log_dir <log_dir>

Directory to dump log files.

-v, --verbose

Flag to turn on debug logging. Default is not verbose.

valid-config-keys

Echo the valid Distance to Port config keys

offshore-dist-to-ports valid-config-keys [OPTIONS]