Skip to content

parameters configuration file

Joe Hamman edited this page Apr 14, 2014 · 5 revisions

Note: configuration file is parsed by the python ConfigParser module. %(Interploation) is supported inside [sections] only.

OPTIONS

  1. LOG_LEVEL
  • Description: Level to log output at
  • Type: char
  • valid values: DEBUG, INFO, WARNING, ERROR, CRITICAL
  1. VERBOSE
  • Description: Print output to console in addition to the log file
  • Type: bool
  • valid values: True, False
  1. CLEAN
  • Description: Delete temporary files, only used if REMAP=True
  • Type: bool
  • valid values: True, False
  1. CASEID
  • Description: Case ID
  • Type: char
  1. GRIDID
  • Description: routing domain grid shortname
  • Type: char
  1. CASE_DIR
  • Description: case run directory
  • Type: char
  1. TEMP_DIR
  • Description: Directory to use for temporary read/write operations, only used if REMAP=True.
  • Type: char
  1. REMAP
  • Description: Remap Unit Hydrographs from [ROUTING] grid to [DOMAIN] grid
  • Type: bool
  • Valid values: True, False
  1. AGGREGATE

Note: This should only be used when routing to coastal grid cells for CESM

  • Description: Aggregate all [POUR_POINTS] inside each [DOMAIN] grid cell
  • Type: bool
  • Valid values: True, False
  1. AGG_PAD
  • Description: Size of pad to add to aggregated files prior to remapping
  • Type: int
  1. NETCDF_FORMAT

Note: For use with CESM, NETCDF3_CLASSIC is recommended.

  • Description: Output parameter file format
  • Type: char
  • Valid values: NETCDF3_CLASSIC, NETCDF3_64BIT, NETCDF4_CLASSIC, and NETCDF4
  1. SUBSET_DAYS
  • Description: Length of unit hydrograph subset in days
  • Type: int
  1. CONSTRAIN_FRACTIONS

Note: True when routing to coastal grid cells, else False

  • Description: Constrain the final unit hydrographs sum to be less than or equal to the domain fractions
  • Type: bool
  • Valid values: True, False

###POUR_POINTS

  1. FILE_NAME
  • Description: Path to Pour Points File, A comma separated file of outlets to route to [lons, lats] - one coordinate pair per line (order not important). May optionally include a column [names] - which will (if not aggregating) be included in param file.
  • Type: char

###UH_BOX

  1. FILE_NAME
  • Description: Path to UH Box File. This defines the unit hydrograph to rout flow to the edge of each grid cell. A comma separated file of [time in seconds, unit hydrograph ordinate] - one timestep per line. The timestep should be 1hr (3600 sec) or less.
  • Type: char
  1. HEADER_LINES
  • Description: Number of Header lines to ignore in [UH_BOX]FILE_NAME
  • Type: int

###ROUTING

  1. FILE_NAME
  • Description: Path to routing inputs netCDF.
  • Type: char
  1. LONGITUDE_VAR
  • Description: Longitude variable name
  • Type: char
  1. LATITUDE_VAR
  • Description: Latitude variable name
  • Type: char
  1. FLOW_DISTANCE_VAR
  • Description: Flow Distance variable name
  • Type: char
  1. FLOW_DIRECTION_VAR
  • Description: Flow Direction variable name
  • Type: char
  1. BASIN_ID_VAR
  • Description: Basin ID variable name
  • Type: char
  1. VELOCITY
  • Description: Velocity variable name or value
  • Type: char, float
  1. DIFFUSION
  • Description: Diffusion variable name or value
  • Type: char, float
  1. OUTPUT_INTERVAL
  • Description: Timestep of output unit hydrographs. Must be a multiple of the timestep in the UH_BOX
  • Type: int
  1. BASIN_FLOWDAYS
  • Description: Maximum time for runoff to reach outlet in days
  • Type: int
  1. CELL_FLOWDAYS
  • Description: Maximum time for runoff to pass through a grid cell in days
  • Type: int

###DOMAIN

  1. FILE_NAME
  • Description: Path to CESM complaint domain file
  • Type: char
  1. LONGITUDE_VAR
  • Description: Longitude variable name
  • Type: char
  1. LATITUDE_VAR
  • Description: Latitude variable name
  • Type: char
  1. LAND_MASK_VAR
  • Description: Land Mask variable name
  • Type: char
  1. FRACTION_VAR
  • Description: Latitude variable name
  • Type: char
  1. AREA_VAR
  • Description: Longitude variable name
  • Type: char
Clone this wiki locally