iwfm.read_sim_hyd

iwfm.read_sim_hyd(gwhyd_file, head_divisor=1.0)

Read simulated values from one IWFM output hydrograph file into a numpy array.

Parameters:

• gwhyd_file (str) – input file name

• head_divisor (float, default 1.0) – Divisor applied to each value, to undo the FACTLTOU head-output scale factor when the model was run with FACTLTOU != 1 (see iwfm.read_factltou). Default 1.0 leaves values unchanged.

Returns:

gwhyd_sim – 2D array of shape (num_timesteps, num_columns) where column 0 is datetime and columns 1..N are hydrograph values

Return type:

numpy.ndarray