Configuration File Reference¶
The SWIFlow configuration file is described in detail below. This information is all based on the CoreConfig file stored under the top level of the package.
For configuration file syntax information please visit http://inicheck.readthedocs.io/en/latest/
setup¶
basin_name
Name of the basin to better tag data
Default: None
Type: string
end
Datetime for where to end modeling runoff
Default: None
Type: datetimeorderedpair
start
Datetime for where to start modeling runoff
Default: None
Type: datetimeorderedpair
stream_network_shp
ShapeFile describing the stream reach and their association to the subbasin. File is produced by basin_setup during delineation.
Default: None
Type: criticalfilename
swi_data
Time series of swi data
Default: None
Type: criticalfilename
watersheds_shp
ShapeFile defining the subbasins. File is produced by basin_setup during delineation.
Default: None
Type: criticalfilename
model¶
catchment_model_type
Theoretical streamflow model
Default: comola
Type: string
Options:
comola
estimated_efficiency
Ratio of SWI allowed into the system. Mostly implemented for use with the direct routing
Default: 1.0
Type: float
lower_residence_time
Time in days a unit of water will stay in a subbasins lower layer
Default: 100
Type: float
mannings_coefficient
Mannings coefficient to be used when routing_model_type is MuskingumCunge (n_m in docs)
Default: 0.03
Type: float
max_infiltration
Max infiltration in mm/day rate to the the lower layer in the Comola model
Default: 5
Type: float
routing_model_type
Model to use for routing available water from subcatchments to the basin outlet
Default: direct
Type: string
Options:
direct muskingumcunge
stream_width
An assumed stream width for when the routing_model_type is MuskingumCunge in meters (w in docs)
Default: 1
Type: float
timestep_hours
Timestep to march through time in integer hours
Default: 24
Type: float
upper_residence_time
Time in days a unit of water will stay in a subbasins upper layer
Default: 10
Type: float
output¶
output_location
directory location to output the variables
Default: output
Type: directory
system¶
log_level
logging level to use when running a model
Default: debug
Type: string
Options:
info debug
log_to_file
Output the log info to log.txt
Default: false
Type: bool
analysis¶
observed_name
Name of the columnb containin the actual values of the measured streamflow
Default: qcms
Type: string
observed_streamflow
filename containing a CSV of observed streamflow
Default: None
Type: criticalfilename
show_comparison
Show the plot of the observed and modeled timeseries overlaid
Default: False
Type: bool