Skip to content
Sam Vente edited this page Aug 6, 2024 · 1 revision

output

``

Functions

Name Description
get_aggregation
get_depth_conversion
get_fiat_footprints
get_index_path
get_infographic Return the HTML string of the infographic for the given scenario.
get_infometrics Return the metrics for the given scenario.
get_max_water_level
get_obs_point_timeseries Return the HTML strings of the water level timeseries for the given scenario.
get_outputs
get_roads
get_topobathy_path

get_aggregation

get_aggregation(name)

get_depth_conversion

get_depth_conversion()

get_fiat_footprints

get_fiat_footprints(name)

get_index_path

get_index_path()

get_infographic

get_infographic(name)

Return the HTML string of the infographic for the given scenario.

Parameters

Name Type Description Default
name str The name of the scenario. required
database IDatabase The database object. required

Returns

Type Description
str The HTML string of the infographic.

get_infometrics

get_infometrics(name)

Return the metrics for the given scenario.

Parameters

Name Type Description Default
name str The name of the scenario. required
database IDatabase The database object. required

Returns

Type Description
pd.DataFrame

Raises

Type Description
FileNotFoundError If the metrics file does not exist.

get_max_water_level

get_max_water_level(name, rp=None)

get_obs_point_timeseries

get_obs_point_timeseries(name)

Return the HTML strings of the water level timeseries for the given scenario.

Parameters

Name Type Description Default
name str The name of the scenario. required
database IDatabase The database object. required

Returns

Type Description
str The HTML strings of the water level timeseries

get_outputs

get_outputs()

get_roads

get_roads(name)

get_topobathy_path

get_topobathy_path()