Return the path of the topobathy tiles in order to create flood maps with water level maps.
get_aggregation
api.output.get_aggregation(name)
Return a dictionary with the aggregated impacts as geodataframes.
Parameters
Name
Type
Description
Default
name
str
The name of the scenario.
required
Returns
Name
Type
Description
dict[str, gpd.GeoDataFrame]
The aggregated impacts for the scenario.
get_depth_conversion
api.output.get_depth_conversion()
Return the flood depth conversion that is need in the gui to plot the flood map.
Returns
Name
Type
Description
float
The flood depth conversion.
get_fiat_footprints
api.output.get_fiat_footprints(name)
Return a geodataframe of the impacts at the footprint level.
Parameters
Name
Type
Description
Default
name
str
The name of the scenario.
required
Returns
Name
Type
Description
gpd.GeoDataFrame
The impact footprints for the scenario.
get_index_path
api.output.get_index_path()
Return the path of the index tiles which are used to connect each water level cell with the topobathy tiles.
Returns
Name
Type
Description
str
The path to the index file.
get_infographic
api.output.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
Returns
Name
Type
Description
str
The HTML string of the infographic.
get_infometrics
api.output.get_infometrics(name)
Return the metrics for the given scenario.
Parameters
Name
Type
Description
Default
name
str
The name of the scenario.
required
Returns
Name
Type
Description
pd.DataFrame
Raises
Name
Type
Description
FileNotFoundError
If the metrics file does not exist.
get_max_water_level
api.output.get_max_water_level(name, rp=None)
Return the maximum water level for the given scenario.
Parameters
Name
Type
Description
Default
name
str
The name of the scenario.
required
rp
int
The return period of the water level, by default None
None
Returns
Name
Type
Description
np.ndarray
2D gridded map with the maximum waterlevels for each cell.
get_obs_point_timeseries
api.output.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
Returns
Name
Type
Description
str
The HTML strings of the water level timeseries
get_outputs
api.output.get_outputs()
Get all completed scenarios from the database.
Returns
Name
Type
Description
dict[str, Any]
A dictionary containing all scenarios. Includes keys: ‘name’, ‘description’, ‘path’, ‘last_modification_date’, ‘objects’ Each value is a list of the corresponding attribute for each output.
get_roads
api.output.get_roads(name)
Return a geodataframe of the impacts at roads.
Parameters
Name
Type
Description
Default
name
str
The name of the scenario.
required
Returns
Name
Type
Description
gpd.GeoDataFrame
The impacted roads for the scenario.
get_topobathy_path
api.output.get_topobathy_path()
Return the path of the topobathy tiles in order to create flood maps with water level maps.