hydromt_fiat.fiat.FiatModel.setup_hazard#
- FiatModel.setup_hazard(map_fn: str | Path | list[str] | list[Path], map_type: str | list[str], rp: int | list[int] | None = None, crs: int | str | list[int] | list[str] | None = None, nodata: int | list[int] | None = None, var: str | list[str] | None = None, chunks: int | str | list[int] = 'auto', hazard_type: str = 'flooding', risk_output: bool = False, unit_conversion_factor: float = 1.0) None[source]#
Set up hazard maps. This component integrates multiple checks for the hazard maps.
- Parameters:
map_fn (Union[str, Path, list[str], list[Path]]) – The data catalog key or list of keys from where to retrieve the hazard maps. This can also be a path or list of paths to take files directly from a local database.
map_type (Union[str, list[str]]) – The data type of each map speficied in map_fn. In case a single map type applies for all the elements a single string can be provided.
rp (Union[int, list[int], None], optional.) – The return period (rp) type of each map speficied in map_fn in case a risk output is required. If the rp is not provided and risk output is required the workflow will try to retrieve the rp from the files’s name, by default None.
crs (Union[int, str, list[int], list[str], None], optional) – The projection (crs) required in EPSG code of each of the maps provided. In case a single crs applies for all the elements a single value can be provided as code or string (e.g. “EPSG:4326”). If not provided, then the crs will be taken from orginal maps metadata, by default None.
nodata (Union[int, list[int], None], optional) – The no data values in the rasters arrays. In case a single no data applies for all the elements a single value can be provided as integer, by default None.
var (Union[str, list[str], None], optional) – The name of the variable to be selected in case a netCDF file is provided as input, by default None.
chunks (Union[int, str, list[int]], optional) – The chuck region per map. In case a single no data applies for all the elements a single value can be provided as integer. If “auto”is provided the auto setting will be provided by default “auto”
hazard_type (str, optional) – Type of hazard to be studied, by default “flooding”
risk_output (bool, optional) – The parameter that defines if a risk analysis is required, by default False