CLI Docs

Below is a list of all CLI options as of version 1.0.13
You can find and search the options on FastFlood Global in the CLI Command Documentation.
Click on the CLI command option for a simulation, and press documentation to see this.

--version

Prints the version and compilation date

--help

Prints the command line options

--helpfull

Prints the command line options, and descriptions of all other parameters

--sim

Tasks the app to actually run a simulation using the FastFlood method

--designstorm

Auto-sets precipitaiton intensity from a design storm taken from FastFlood's global datasets

--designsnowmelt

Auto-sets snowmelt intensity from a design event taken from FastFlood's global datasets

--designstormscale

Auto-scales precipitaiton intensity based on the size of the region considered. Use basin-scale for fluvial flood triggers, or default (off) for flash flood

--climate

Auto-sets climate change factors from FastFlood's global datasets

--d_dem

Provide an area for which the elevation model is automatically obtained, will also determine the model domain (extent and resolution)

--d_demfillnational

For the current DEM, checks which national DEM's might supplement and be blended in, and does so automatically

--d_lu

Activates an automatic download of land use information, to be used in the flood simulation

--d_inf

Activates an automatic download of infiltration information, to be used in the flood simulation

--channel

Activate 1D-2D coupled channel flow simulation.

--key

API access token

--use_key_cache

Use cached API access token

--token

API data access token, usually automatically the same as the key

--climout

Downloads and writes to a csv table, climate change trends in extreme precipitation from FastFlood's global datasets

--idfout

Downloads and writes to a csv table, extrem precipitation IDF curves, from FastFlood's global datasets

--autohazard

Automatic setup of a model, with all best practices applied, if other options are specified, they overwrite the auto-settings

--autoforecast

Automatic setup of a model, with all best practices applied, if other options are specified, they overwrite the auto-settings

--autoriver

Automatic setup of river discharge boundary conditions

--flatcor

Flat terrain correction

--verbose

Print all debugging info

--noautorefine

Automated refinement not activated, the model does not run the core processes of hydrology and routing at lower resolution while maintains the full resolution output

--nochandxcor

The model should not correct automatically for the interplay between channel 1D-2D coupling and cellsize

--cog

Output all files in cloud optimized geotiff, despite extension used

--protectionlevels

Use global protectionleveldata for the urban drainage and flood protection estimation

--d_protectionlevels

Use global protectionleveldata for the urban drainage and flood protection estimation

--autodem

Automatic setup of an elevation model, with all best practices applied, if other options are specified, they overwrite the auto-settings

--rainregion

Specify a specific rainfall value for a certain rectangular subdomain

--autoprocessgridfeed

Automatically determin distance to major rivers/coast/dams in order to run lower resolution larger domain simulations to cover the sources for flood water in those processes

--noautobcond

Disable the automatic boundary conditions during the auto-hazard or auto-forecast process

--cal

Flag indicating a calibration should be run

--cal_method

Flag indicating calibration method, either 'brute' (default) 'simplex', 'bgfs' or 'gradient'

--cal_man

Calibration active for Mannings surface roughness (active by default)

--cal_inf

Calibration active for infiltration rates (active by default)

--cal_chan

Calibration active for channel depth (not active by default)

--cal_conc

Calibration active for concentration speeds (not active by default)

--obs_flood

Calibration data for flood extent, should be a binary flood map or shapefile

--obs_q

Calibration data for peak discharge

--obs_wh

Calibration data for peak water depth

--d_obs_flood

Auto-download calibration data for flood extent, a 10-year return period binary flood map only for larger streams, rivers and coastlines, not flash floods

--d_obs_q

Auto-download observation data for peak discharge

--obs_flood_wh

Minimum water height to be considered flooding, default is 0.25 meters

--customurl

Custom url template to use when fetching data

--d_sm

Auto-download soil moisture estimate

--d_cal

Get automated calibration for Mannings surface roughness (active by default)

--refine

Run the refinement model

--dynamic

Activates dynamic simulation, and allows the selection of timestep, duration and number of output moments.

--dyn_nocache

Disables super-cell caching, whereby regions with only minimal temporal changes in flow state are approximated in time linearly temporarily.

--dyn_nosdt

Disables spatially dynamic (varying) timesteps.

--dt

Timestep to use (sub-step iterations are automatic)

--dtmin

Timestep to use at least (sub-step iterations can not go lower)

--baseflow

Baseflow, an initial state of river flow is calculated based on the input that this baseflow value is observed at the outlet of the region

--forecast

Loads a weather forecast as rainfall input data, or a discharge forecast in case of automated river discharge boundary condition

--forecast_q

Loads a discharge forecast for the automated river setup

--maxlrres

Maximum grid size (width or height) to be used in the low resolution map for automatic refinement, default is 1300

--cores

The number of CPU cores to use when running the model, note that the fastflood method scales well up to 4 cores

--difc

Diffusivity Coefficient, determines the diffusion of discharge waves in a long river system, uses exponential decay to mimic the height-spread relationship in the physics, default value of 0.1

--delta

Small value increment used in terrain hydrocorrection and flow network calculation

--ddepr

Account for depression (do not hydrocorrect, combine with the dfhydro command to pre-correct the data)

--quality

Quality level of the simulation

--dfhydro

Carry out a hydrocorrection filter on the input elevation data

--dfhydrocut

Carry out a hydrocorrection filter on the input elevation data

--dfnoise

Noise correction filter (bilateral filter)

--dfdtm

Terrain model filter, attempts removal of vegetation and buildings

--dfriver

Terrain filter to remove bridges in large rivers from dsm data

--timeslice

For the time-implicit model, the flood map normally represents the peak during the event. Use this option to get a map for a certain moment relative to the start of the event

--dem

Provide an elevation model as a geotiff file, will also determine the model domain (extent and resolution)

--rain

Provide rainfall as a value or as a geotiff file/cvs file

--rain_dt

If a rainfall timeseries is provided, overwrite (if any) time interval between the rainfall datasets

--man

Provide manning as a value or as a geotiff file

--man_chan

Provide channel manning coefficient

--inf

Provide infiltration as a value or as a geotiff file

--sm

Provide soil moisture as a value or as a geotiff file

--raf

Rainfall analysis fraction, between 0 and 1, default 0.85

--mult_man

Provide manning multiplier as a value

--mult_inf

Provide infiltration multiplier as a value

--mult_rain

Provide rainfall multiplier as a value

--mult_chan

Provide channel dimension multiplier as a value or as a geotiff file

--mult_qbcond

Provide discharge boundary condition multiplier as a value

--mult_runoff

Provide runoff multiplier as a value

--mult_fpl

Provide flood protection level multiplier as a value

--qout_dyn

Provide an output filename for Discharge timeseries (cubic meter per second)

--nochanwh

Indicate the channel water height should not be part of the output map (default = false, so channel water is included)

--nowcheck

Indicate insignificant rainfall should not be simulated, simulations with all rainfall/q sources below 1-e6, and no refinement are skipped (default = true)

--whout

Provide an output filename for Maximum Water Height (meter)

--dout

Provide an output filename for Elevation (meter)

--dlrout

Provide an output filename for low resolution internal Elevation (meter)

--dchout

Provide an output filename for channelized Elevation (meter)

--manout

Provide an output filename for Mannings coefficient

--luout

Write the lu class file to a geotiff file

--soilclayout

Write the soil clay (fraction of fine earth) to a geotiff file

--soilsiltout

Write the soil silt (fraction of fine earth) to a geotiff file

--soilsandout

Write the soil sand (fraction of fine earth) to a geotiff file

--soilorganicout

Write the soil organic (mass fraction) to a geotiff file

--soilgravelout

Write the gravel sand (volumetric fraction) to a geotiff file

--ksatout

Write the infiltration map (saturated hydraulic conducitivty, mm/hour) to a geotiff file

--thetasout

Write the porosity map (relative, 0-1)to a geotiff file

--qout

Provide an output filename for Peak Discharge (cubic meter per second)

--chwout

Provide an output filename for the channel width (meter)

--chhout

Provide an output filename for the channel depth (meter)

--vout

Provide an output filename for peak velocity (meter per second)

--drainageareaout

Provide an output filename for drainage area (km2)

--fillgaps

--rainout

Provid an output filename for the time-averaged precipitation map (mm/h)

--clout

Provid an output filename for catchment length map (meters), only valid in fastflood rapid simulation

--cbout

Provide an output filename for catchment shape parameter map b (-), only valid in fastflood rapid simulation

--ssout

Provide an output filename for fractional steady state factor (-), only valid in fastflood rapid simulation

--vupout

Provide an output filename for average upstream velocity (meter per second), only valid in fastflood rapid simulation

--floodobsout

Provide an output filename for the observational flood map, 1 for flood and 0 for no flood

--calrepout

Provide an output filename for the calibration report output file, a csv table

--vxout

Provide an output filename for peak velocity components (meter per second)

--vyout

Provide an output filename for peak velocity components (meter per second)

--vxyout

Provide an output filename for peak velocity components (meter per second)

--hydrograph

Provide an output filename for the hydrograph timeseries (cubic meter per second)

--hydrograph_p

Provide an point location and output filename for the hydrograph timeseries (cubic meter per second)

--atout

Provide an output filename for flood arrival time (hour)

--whinitial

Initial water height to be added for every location (Only in combination with dynamic)

--ocean

Use an ocean boundary condition

--d_ocean

Auto download an ocean boundary condition

--dur

Event duration in hours

--shape

Event shape (0 = flat, 1 = triangular, 2 = quadratic, etc..)

--qin

Input discharge boundary condition

--dain

Input drainage area condition

--dyn_noopenmp

Avoid the usage of OpenMP and use a custom threadpool/multithreading implementation

--dyn_noflow

Indicates no flow should be calculated, and the dynamic model only does hydrology and 1D flow

--channelout

Output channel shapes

--bcondout

Outputs the boundary conditions (normally present or automated boundary conditions) used in the simulation

--globalrivertestout

Global river data used for automated river boundary conditions, in addition to our search-and-match algorithms based on elevation data and stream orders.

--exposure

output exposure calculation file

--d_culverts

Input stormwater drainage to be added

--d_stormwaterdrain

Input stormwater drainage to be added

--d_reservoir

Input reservoirs to be added

--culverts

Input stormwater drainage to be added

--stormwaterdrain

Input stormwater drainage to be added

--swd

Input stormwater drainage to be added

--reservoir

Input reservoirs to be added

--lakes

Input lakes to be added

--culvertsout

Output stormwater drainage to be added

--swdout

Output stormwater drainage to be added

--stormwaterdrainout

Output stormwater drainage to be added

--reservoirout

Output reservoirs to be added

--lakesout

Output lakes to be added

--swdcaprasterout

Output stormwater drainage rasterized capacity to be added

--osmout

Output osm data

--osmwaterburn

Burn osm water polygons into the elevation data

--osmbathfilter

Smoother bathymetry elevation data in the elevation data

--barriers

Input barriers to be added

--channels

Channel shapes used as strongly imposed hints (with condition that no infinite loops are created). Guide the channels to lower areas using the shapes, may optionally contain attribute "width" in meters, "depth" in meters, "manning" and "angle" the angle of the side wall between 0 and 90 degree (default 90). For all, negative value means ignore.

--adaptations

Polygons or polylines that alter values of input data

--bcond

Points with boundary condition data

--swd_eff

Set a global effectivity ratio for the storm water drainage systems

--swd_set

Override all storm water drainage system capacity

--ruout

Provide an output filename for runoff production, in avg mm/hour during event (mm/h)

--channelmv

Set channels with a certain number of square kilometers of drainage area as infiinite drains

--noarf

Do not apply area reduction factor to precipitation for auto-hazard

--catchout

Carry out a catchment analysis and output catchment shapefile at file location

--noautoblock

Disable the automatic domain edge blocking placed because of boundary conditions

--bn

Block Northern boundary

--bs

Block Southern boundary

--be

Block Eastern boundary

--bw

Block Western boundary