ConfigModel
database_builder.ConfigModel()Main configuration model for FloodAdapt database builder.
Parameters
name : str-
Name of the site (must be valid for folder names).
description : Optional[str]-
Description of the site.
database_path : Optional[str]-
Path to the database root directory.
unit_system : UnitSystems-
Unit system for all calculations (imperial or metric).
gui : GuiConfigModel-
GUI visualization scaling configuration.
infographics : bool-
Enable/disable infographics.
event_infographics : Optional[EventInfographicModel]-
Configuration for event infographics.
risk_infographics : Optional[RiskInfographicModel]-
Configuration for risk infographics.
event_additional_infometrics : Optional[list[MetricModel]]-
Additional event infometrics.
risk_additional_infometrics : Optional[list[MetricModel]]-
Additional risk infometrics.
fiat : str-
Path to the FIAT model directory.
aggregation_areas : Optional[list[SpatialJoinModel]]-
List of aggregation area spatial join models.
building_footprints : Optional[SpatialJoinModel | FootprintsOptions]-
Building footprints source or spatial join model.
fiat_buildings_name : str | list[str]-
Name(s) of buildings geometry in FIAT model.
fiat_roads_name : Optional[str]-
Name of roads geometry in FIAT model.
bfe : Optional[SpatialJoinModel]-
Base Flood Elevation spatial join model.
svi : Optional[SviConfigModel]-
Social Vulnerability Index spatial join model.
road_width :us.UnitfulLength-
Road width (default 5 meters).
return_periods : Optional[list[int]]-
List of return periods for risk calculations.
floodmap_type : Optional[FloodmapType]-
Type of floodmap to use.
references : Optional[WaterlevelReferenceModel]-
Water level reference model.
sfincs_overland :FloodModel-
Overland SFINCS model configuration.
sfincs_offshore : Optional[FloodModel]-
Offshore SFINCS model configuration.
dem : Optional[DemModel]-
Digital Elevation Model configuration.
river_names : Optional[list[str]]-
List of river names (optional).
excluded_datums : list[str]-
List of datums to exclude from plotting.
slr_scenarios : Optional[SlrScenariosModel]-
Sea level rise scenarios configuration.
scs : Optional[SCSModel]-
SCS model configuration.
tide_gauge : Optional[TideGaugeConfigModel]-
Tide gauge configuration.
cyclones : Optional[bool]-
Enable/disable cyclones.
cyclone_basin : Optional[Basins]-
Cyclone basin selection.
obs_point : Optional[list[ObsPointModel]]-
List of observation point models.
probabilistic_set : Optional[str]-
Path to probabilistic event set.
Methods
| Name | Description |
|---|---|
| read | Read a configuration file and returns the validated attributes. |
read
database_builder.ConfigModel.read(toml_path: Union[str, Path])Read a configuration file and returns the validated attributes.
Args: toml_path (str | Path): The path to the configuration file.
Returns
: ConfigModel: The validated attributes from the configuration file.