Demo functions

To do:

  • Create the demo

IO.demo_functions.demo_input(num_of_sections=1, set_example_inputs=True, figname=None, dpi=200, **kwargs)

A demonstration to generate a hipims input object

Parameters

  • set_example_inputs – (True|False) if True, initial condition, boundary condition, rainfall source, and gauge postion will be set to the input object according to sample data.

  • figname – (string) if given, a domain map will saved

IO.demo_functions.demo_output(case_folder, num_of_sections=1)

A demonstration to generate a hipims output object

Parameters

  • case_folder – (string) path to case folder

  • num_of_sections – (int) number of domains

Note

a input folder and files must be created before using this function

IO.demo_functions.demo_raster(figname=None)

A demonstration to read and show raster files

Parameters

figname – (string) the file name to save the figure

IO.demo_functions.get_sample_data()

Get sample data for demonstartion

Returns

string for DEM file name demo_data: a dictionary with boundary_condition, rain_source, and

gauges_pos data

data_path: string the path of sample data

Return type

dem_file