Tip
Need help? Please let us know in the SUEWS Community.
Please report issues with the manual on GitHub Issues (or use Report Issue for This Page for page-specific feedback).
Please cite SUEWS with proper information from our Zenodo page.
Warning
DEPRECATED: This table-based input format is deprecated as of 2025. Please use the modern YAML format instead. See our transition guide for migration help.
4.7.3.2.3. File related options#
- FileCode#
- Requirement:
Required
- Description:
Alphabetical site identification code (e.g. He, Sc, Kc).
- Configuration:
This must be consistent with names of meterological input file and initial condition files
- FileInputPath#
- Requirement:
Required
- Description:
Input directory.
- Configuration:
This can be set either as an absolute path or a relative path where the program is initiated.
- FileOutputPath#
- Requirement:
Required
- Description:
Output directory.
- Configuration:
This can be set either as an absolute path or a relative path where the program is initiated.
- MultipleMetFiles#
- Requirement:
Required
- Description:
Specifies whether one single meteorological forcing file is used for all grids or a separate met file is provided for each grid.
- Configuration:
Value
Comments
0
Single meteorological forcing file used for all grids. No grid number should appear in the file name.
1
Separate meteorological forcing files used for each grid. The grid number should appear in the file name.
- MultipleInitFiles#
- Requirement:
Required
- Description:
Specifies whether one single initial conditions file is used for all grids at the start of the run or a separate initial conditions file is provided for each grid.
- Configuration:
Value
Comments
0
Single initial conditions file used for all grids. No grid number should appear in the file name.
1
Separate initial conditions files used for each grid. The grid number should appear in the file name.
- MultipleESTMFiles#
- Requirement:
Optional
- Description:
Specifies whether one single ESTM forcing file is used for all grids or a separate file is provided for each grid.
- Configuration:
Value
Comments
0
Single ESTM forcing file used for all grids. No grid number should appear in the file name.
1
Separate ESTM forcing files used for each grid. The grid number should appear in the file name.
- KeepTstepFilesIn#
- Requirement:
Optional
- Description:
Specifies whether input meteorological forcing files at the resolution of the model time step should be saved.
- Configuration:
Value
Comments
0
Meteorological forcing files at model time step are not written out. This is the default option Recommended to reduce processing time and save disk space as (e.g. 5-min) files can be large.
1
Meteorological forcing files at model time step are written out.
- KeepTstepFilesOut#
- Requirement:
Optional
- Description:
Specifies whether output meteorological forcing files at the resolution of the model time step should be saved.
- Configuration:
Value
Comments
0
Output files at model time are not saved. This is the default option. Recommended to save disk space as (e.g. 5-min) files can be large.
1
Output files at model time step are written out.
- WriteOutOption#
- Requirement:
Optional
- Description:
Specifies which variables are written in the output files. For detailed information about output file formats and variables, see Output Files.
- Configuration:
Value
Comments
0
All (except snow-related) output variables written. This is the default option.
1
All (including snow-related) output variables written.
2
Writes out a minimal set of output variables (use this to save space or if information about the different surfaces is not required).
- SuppressWarnings#
- Requirement:
Optional
- Description:
Controls whether warning messages are emitted (e.g., to console / Python logger).
- Configuration:
Value
Comments
0
Warning messages are emitted.
1
Warning messages are suppressed. This is the default option.