Commit ebd30175 authored by Morales Hernandez, Mario's avatar Morales Hernandez, Mario
Browse files

training branch updated for CIROH workshop 

This commit updated training branch with dev-output branch, inclding
geotiff output nad removing the heavy test cases (case04 and case05)
from the branch.


Former-commit-id: 9626f933
parent f3f68b0b

README.md

+1 −37
Original line number Diff line number Diff line
@@ -16,11 +16,10 @@ Highest TRITON computational efficiency can be achieved by using GPU implementat 


*  TRITON utilizes topographical data (e.g., digital elevation model [DEM], light detection and ranging [LIDAR]), as its base input, in a uniform (Cartesian) grid structure. The model can be driven by streamflow hydrographs at specified locations or gridded runoff hydrographs, or both which serves as the model’s hydrological forcing. The primary TRITON output includes water depth and 2D velocity maps at user defined time intervals. Other variables such as unit discharge values can be outputted. TRITON can also output timeseries of simulated results as user-defined point locations.



*  TRITON is developed on Linux/Unix platform. The input/output files can be either in ascii or binary formats. A set of tools and instruction are provided for format conversion.

*  TRITON is developed on Linux/Unix platform. The input/output files can be either in ascii or binary formats (output also in GeoTIFF)



*  The model utilizes International System of Units (SI). Users who are more familiar with United States (US) customary units need to perform proper unit conversion themselves.





*  A set of Test Cases are provided :



1.  Case 01 : TaumSauk
@@ -29,42 +28,7 @@ Highest TRITON computational efficiency can be achieved by using GPU implementat 
4.  Case 02c: Paraboloid Case - Resolution 0.01m

5.  Case 02d: Paraboloid Case - Resolution 0.005m

6.  Case 03 : Runoff

7.  Case 04	: Harvey 30m 

8.  Case 05	: Harvey 10m





Morales-Hernández, M., Sharif, M.B., Kalyanapu, A., Ghafoor, S.K., Dullo, T.T., Gangrade, S., Kao, S.C., Norman, M.R. and Evans, K.J., 2021. TRITON: A Multi-GPU Open Source 2D Hydrodynamic Flood Model. Environmental Modelling & Software, p.105034 [https://doi.org/10.1016/j.envsoft.2021.105034](https://doi.org/10.1016/j.envsoft.2021.105034)



**Instructions to run a case with parallel input**



1.  Open the script "scriptSplitASCII" and configure the following parameters (in caps):



*  TRITON_DIR: triton directory

*  NFILES: The number of files to split the ASCII file(s) into. It should match the number of ranks in the TRITON simulation

*  INPUT_DEM: DEM input file (in ASCII format)

*  IS_MANN: flag for the mann file (YES or NO)

*  INPUT_MANN: in case IS_MANN=YES, this parameter contains the mann input file (in ASCII format)

*  IS_RMAP: flag for the rmap file (YES or NO)

*  INPUT_RMAP: in case IS_RMAP=YES, this parameter contains the rmap input file (in ASCII format)

*  OUTPUT_FORMAT: ASC or BIN, depending on the desired output format for the sequence of files

*  ASCII2BIN_FOLDER: in case OUTPUT_FORMAT=BIN, it points to the ascii2bin directory (not the ascii2bin_dem)

*  ASCII2BIN_RMAP_FOLDER: in case OUTPUT_FORMAT=BIN and IS_RMAP=YES, it points to the ascii2bin_rmap directory







2.  Run the script.  





3.  Configure the cfg file as follows for the following parameters:



*  dem_filename: include the path of the split files plus the basename (without underscores or numbers). Example: "input/dem/bin/par/case03"

*  Add header_filename and point it to the exact name of the header that the script has generated. Example: "input/dem/bin/par/case03.header" 

*  n_infile: include the path of the split files plus the basename (without underscores or numbers). Example: "input/mann/bin/par/case03"

*  runoff_map: include the path of the split files plus the basename (without underscores or numbers). Example: ""input/runoff/bin/par/case03_runoff"

*  input_format: BIN

*  Add input_option: PAR



4.  Run TRITON with the same MPI ranks as stated in NFILES.

input/cfg/case01.cfg

+6 −2
Original line number Diff line number Diff line
@@ -8,14 +8,18 @@ 
dem_filename="input/dem/asc/case01.dem"



#---------------------------------------------------------------------------

# Format=BIN or ASC

# Format=BIN or ASC or GTIFF

# Option=PAR or SEQ

#---------------------------------------------------------------------------

input_format=ASC

outfile_pattern="%s/%s/%s_%02d_%02d"

output_format=ASC

output_format=GTIFF

output_option=SEQ



#---------------------------------------------------------------------------

# Projection (for geotiff output format). If not specified, WGS84 by default

projection=WGS84



#---------------------------------------------------------------------------

# Hydrograph and flow locations information

#---------------------------------------------------------------------------

input/cfg/case03.cfg

+10 −4
Original line number Diff line number Diff line
@@ -28,18 +28,19 @@ runoff_map="input/runoff/case03_runoff.rmap" 
print_option=h



# Print interval in seconds of simulation time

print_interval=1800

print_interval=180



# time_series_flag=1 to activate, 0 to deactivate

observation_loc_file="input/obs/case5.obs"

time_series_flag=0

observation_loc_file="input/obs/case3.obs"





#---------------------------------------------------------------------------

# Simulation Control

#---------------------------------------------------------------------------

# Start and duration of simulation time in seconds

sim_start_time=0

sim_duration=432000

sim_duration=3600



# If checkpoint_id is 0 that means a clean start

checkpoint_id=0
@@ -60,9 +61,14 @@ qy_infile="" 
# File Output Option=PAR or SEQ



input_format=ASC

output_format=ASC

output_format=GTIFF

outfile_pattern="%s/%s/%s_%02d_%02d"

output_option=SEQ



#---------------------------------------------------------------------------

# Projection (for geotiff output format). If not specified, WGS84 by default

projection=EPSG:32616



#---------------------------------------------------------------------------

# External boundaries

#---------------------------------------------------------------------------

input/cfg/case04.cfg

deleted100644 → 0
+0 −93
Original line number Diff line number Diff line 
#---------------------------------------------------------------------------

# Triton config file

#---------------------------------------------------------------------------



#---------------------------------------------------------------------------

# Mandatory input files

#---------------------------------------------------------------------------

dem_filename="input/dem/bin/case04.dem"



#---------------------------------------------------------------------------

# Format=BIN or ASC

# Option=PAR or SEQ

#---------------------------------------------------------------------------

input_format=BIN

outfile_pattern="%s/%s/%s_%02d_%02d"

output_format=BIN

output_option=SEQ



#---------------------------------------------------------------------------

# Hydrograph and flow locations information

#---------------------------------------------------------------------------

num_sources=69

hydrograph_filename="input/strmflow/case04.hyg"

src_loc_file="input/strmflow/case04.txt"

#---------------------------------------------------------------------------

# Manning input files

#---------------------------------------------------------------------------

n_infile=""

const_mann=0.035



#---------------------------------------------------------------------------

# Runoff related information

#---------------------------------------------------------------------------

num_runoffs=0

#runoff_filename=""

#runoff_file=""



#---------------------------------------------------------------------------

# External boundaries

#---------------------------------------------------------------------------

num_extbc=0

extbc_dir="input/extbc"

extbc_file="input/extbc/case04.extbc"



#---------------------------------------------------------------------------

# time_series_flag=1 to activate, 0 to deactivate

#---------------------------------------------------------------------------

observation_loc_file="input/obs/case04.obs"

time_series_flag=0



#---------------------------------------------------------------------------

# print_option=h to output just the h, huv to output all h,u and v

#---------------------------------------------------------------------------

print_option=huv



#---------------------------------------------------------------------------

# Start and duration of simulation time in seconds

#---------------------------------------------------------------------------

sim_start_time=0

sim_duration=864000



#---------------------------------------------------------------------------

# If checkpoint_id is 0 that means a clean start

#---------------------------------------------------------------------------

checkpoint_id=0



#---------------------------------------------------------------------------

# time_increment_fixed=0 is for variable dt, 1 for constant dt

#---------------------------------------------------------------------------

time_step=0.01

time_increment_fixed=0



#---------------------------------------------------------------------------

# Print interval in seconds of simulation time

#---------------------------------------------------------------------------

print_interval=1800



#---------------------------------------------------------------------------

# Initial input files

#---------------------------------------------------------------------------

#h_infile="input/inith/asc/case04.inith"

#qx_infile="input/initqx/asc/case04.initqx"

#qy_infile="input/initqy/asc/case04.initqy"



#---------------------------------------------------------------------------

# Other variables

#---------------------------------------------------------------------------

it_count=0

courant=0.5

hextra=0.001

gpu_direct_flag=0

domain_decomposition=static

open_boundaries=0

input/cfg/case05.cfg

deleted100644 → 0
+0 −94
Original line number Diff line number Diff line 
#---------------------------------------------------------------------------

# Triton config file - Case 05 Harvey 10 m

#---------------------------------------------------------------------------



#---------------------------------------------------------------------------

# Mandatory input files

#---------------------------------------------------------------------------

dem_filename="input/dem/asc/case05.dem"



#---------------------------------------------------------------------------

# Format=BIN or ASC

# Option=PAR or SEQ

#---------------------------------------------------------------------------

input_format=ASC

outfile_pattern="%s/%s/%s_%02d_%02d"

output_format=BIN

output_option=SEQ



#---------------------------------------------------------------------------

# Hydrograph and flow locations information

#---------------------------------------------------------------------------

num_sources=69

hydrograph_filename="input/strmflow/case05.hyg"

src_loc_file="input/strmflow/case05.txt"



#---------------------------------------------------------------------------

# Manning input files

#---------------------------------------------------------------------------

n_infile="input/mann/asc/case05.mann"

const_mann=0.035



#---------------------------------------------------------------------------

# Runoff related information

#---------------------------------------------------------------------------

num_runoffs=0

#runoff_filename=""

#runoff_file=""



#---------------------------------------------------------------------------

# External boundaries

#---------------------------------------------------------------------------

num_extbc=0

extbc_dir="input/extbc"

extbc_file="input/extbc/case05.extbc"



#---------------------------------------------------------------------------

# time_series_flag=1 to activate, 0 to deactivate

#---------------------------------------------------------------------------

observation_loc_file="input/obs/case05.obs"

time_series_flag=0



#---------------------------------------------------------------------------

# print_option=h to output just the h, huv to output all h,u and v

#---------------------------------------------------------------------------

print_option=huv



#---------------------------------------------------------------------------

# Start and duration of simulation time in seconds

#---------------------------------------------------------------------------

sim_start_time=0

sim_duration=864000



#---------------------------------------------------------------------------

# If checkpoint_id is 0 that means a clean start

#---------------------------------------------------------------------------

checkpoint_id=0



#---------------------------------------------------------------------------

# time_increment_fixed=0 is for variable dt, 1 for constant dt

#---------------------------------------------------------------------------

time_step=0.01

time_increment_fixed=0



#---------------------------------------------------------------------------

# Print interval in seconds of simulation time

#---------------------------------------------------------------------------

print_interval=1800



#---------------------------------------------------------------------------

# Initial input files

#---------------------------------------------------------------------------

#h_infile="input/inith/asc/case05.inith"

#qx_infile="input/initqx/asc/case05.initqx"

#qy_infile="input/initqy/asc/case05.initqy"



#---------------------------------------------------------------------------

# Other variables

#---------------------------------------------------------------------------

it_count=0

courant=0.5

hextra=0.001

gpu_direct_flag=0

domain_decomposition=static

open_boundaries=0