hydromt_fiat.components.HazardComponent.setup#

HazardComponent.setup(hazard_fnames: list[Path | str] | Path | str, hazard_type: str = 'water_depth', *, return_periods: list[int] | None = None, risk: bool = False, unit: str = 'm', **settings: dict[str, Any]) → None[source]#

Set up hazard maps.

Parameters:

  • hazard_fnames (list[Path | str] | Path | str) – Path(s) to the hazard file(s) or name(s) of the data catalog entries.

  • hazard_type (str, optional) – Type of hazard, by default “water_depth”.

  • return_periods (list[int] | None, optional) – List of return periods. Length of list should match the number hazard files, by default None.

  • risk (bool, optional) – Whether the hazard files are part of a risk analysis, by default False.

  • unit (str, optional) – The unit which the hazard data is in, by default ‘m’ (meters).

  • **settings (dict) – Extra settings to be added under the hazard header. For flood maps (water depth), elevation_reference set to either ‘datum’ or ‘dem’ is recommeneded.

Return type:

None