src.run_all
This script runs each module in the Digital Twin using a Sample Polygon.
Attributes
Functions
|
Runs each module in the Digital Twin using the selected polygon and the defined parameters for each module's |
Module Contents
- src.run_all.main(selected_polygon_gdf: geopandas.GeoDataFrame, modules_to_parameters: Dict[types.ModuleType, Dict[str, str | int | float | bool | None | enum.Enum]]) None
Runs each module in the Digital Twin using the selected polygon and the defined parameters for each module’s main function.
- Parameters:
selected_polygon_gdf (gpd.GeoDataFrame) – A GeoDataFrame representing the selected polygon, i.e., the catchment area.
modules_to_parameters (Dict[ModuleType, Dict[str, Union[str, int, float, bool, None, Enum]]]) – A dictionary that associates each module with the parameters necessary for its main function, including the option to set the log level for each module’s root logger. The available logging levels and their corresponding numeric values are: - LogLevel.CRITICAL (50) - LogLevel.ERROR (40) - LogLevel.WARNING (30) - LogLevel.INFO (20) - LogLevel.DEBUG (10) - LogLevel.NOTSET (0)
- Returns:
This function does not return any value.
- Return type:
None
- src.run_all.DEFAULT_MODULES_TO_PARAMETERS
- src.run_all.sample_polygon