Output

T-Route Output Configuration

The T-Route hydraulic model generates output data related to streamflow routing across a river network. The output typically includes time series data for various hydrological metrics at different nodes (e.g., stream segments or nexus points) in the network. These metrics include:

• Streamflow (Q): The volume of water passing through a river segment per unit time (e.g., cubic meters per second).
• Water Depth (d): The depth of water in the channel, which can influence flood risk and channel stability.
• Velocity (v): The speed at which water flows through the channel.

These outputs are time-stepped and can vary across spatial points (river reaches or nodes) within the modeled river network. The data is provided in tabular formats, making it suitable for post-processing and visualization in GIS platforms or hydrological analysis tools.

---

Saving Output in T-Route

In T-Route, the output configuration is controlled via the output_parameters section of the YAML file. This section must be uncommented or edited to specify how and where the output should be saved.

Here are some important configuration parameters:

test_output

The line:

test_output: output/lcr_flowveldepth.pkl

This saves the results in a single Pickle file (.pkl), storing streamflow, water depth, and velocity data in a serialized format.

lite_restart

lite_restart: 
  lite_restart_output_directory: restart/

This section allows the model to save restart files, enabling a continuation from where the simulation last stopped, avoiding the need for a cold start.

stream_output

This section allows you to customize the behavior and structure of the output files. Here are the key fields:

• stream_output_directory: Specifies the directory where the stream output files will be saved.

  stream_output_directory: output/

• mask_output: If user doesn't need all segment and prefer to mask some segments can put those segments in this yaml file, either wb or nex can be masked and by putting 9999 it record all segments or nexus points.

  mask_output: domain/mask_output.yaml

• stream_output_time: Controls how often the output is saved (e.g., every hour). A value of -1 means all output will be saved into a single file.

  stream_output_time: 1 # [hr]

• stream_output_type: Allows you to select the format of the output files. Supported formats include:

  • .nc: NetCDF format

  • .csv: CSV format

  • .pkl: Pickle format

    stream_output_type: .nc # choose between .nc, .csv, or .pkl

• stream_output_internal_frequency: Sets the internal frequency for output in minutes. For example, a value of 60 means the output will be saved every 60 minutes (or every hour).

  stream_output_internal_frequency: 60 # [min]

---

Example Configuration

output_parameters:
  test_output: output/lcr_flowveldepth.pkl
  lite_restart:
    lite_restart_output_directory: restart/
  lakeout_output: lakeout/
  lastobs_output: lastobs/
  stream_output:
    stream_output_directory: output/
    mask_output: domain/mask_output.yaml
    stream_output_time: 1 # [hr]
    stream_output_type: .nc # choose between .nc, .csv, or .pkl
    stream_output_internal_frequency: 60 # [min]

---

This setup provides flexibility in controlling how frequently the data is saved, in what format, and where the files are stored, making it adaptable to different use cases or analysis workflows.