API reference

Initialize

fiat.FiatModel([root, mode, config_fn, ...])

General and basic API for the FIAT model in hydroMT.

Build components

fiat.FiatModel.setup_basemaps(*args, **kwargs)
fiat.FiatModel.setup_vulnerability(...[, ...])	Setup the vulnerability curves from various possible inputs.
fiat.FiatModel.setup_vulnerability_from_csv(...)	Setup the vulnerability curves from one or multiple csv files.
fiat.FiatModel.setup_exposure_buildings(...)	Setup building exposure (vector) data for Delft-FIAT.
fiat.FiatModel.setup_hazard(map_fn, map_type)	Set up hazard maps.
fiat.FiatModel.setup_social_vulnerability_index(...)	Setup the social vulnerability index for the vector exposure data for Delft-FIAT.

Delft-FIAT settings

fiat.FiatModel.setup_config(**cfdict)	Update config with a dictionary.
fiat.FiatModel.setup_global_settings([crs, ...])	Setup Delft-FIAT global settings.
fiat.FiatModel.setup_output([output_dir, ...])	Setup Delft-FIAT output folder and files.

Attributes

fiat.FiatModel.region	Returns the geometry of the model area of interest.
fiat.FiatModel.crs	Returns coordinate reference system embedded in the model grid.
fiat.FiatModel.res	Returns the resolution of the model grid.
fiat.FiatModel.root	Path to model folder.
fiat.FiatModel.config	Model configuration.
fiat.FiatModel.maps	Model maps.
fiat.FiatModel.geoms	Model geometries.

High level methods

fiat.FiatModel.read()	Method to read the complete model schematization and configuration from file.
fiat.FiatModel.write()	Method to write the complete model schematization and configuration to file.
fiat.FiatModel.build([region, write, opt])	Single method to build a model from scratch based on settings in opt.
fiat.FiatModel.set_root(root[, mode])	Initialize the model root.

General methods

fiat.FiatModel.setup_config(**cfdict)	Update config with a dictionary.
fiat.FiatModel.get_config(*args[, fallback, ...])	Get a config value at key(s).
fiat.FiatModel.set_config(*args)	Update the config dictionary at key(s) with values.
fiat.FiatModel.read_config([config_fn])	Parse config from file.
fiat.FiatModel.write_config([config_name, ...])	Write config to <root/config_fn>.
fiat.FiatModel.set_maps(data[, name, ...])	Add raster data to the maps component.
fiat.FiatModel.read_maps([fn])	Read model map at <root>/<fn> and add to maps component.
fiat.FiatModel.write_maps([fn])	Write maps to netcdf file at <root>/<fn>.
fiat.FiatModel.set_geoms(geom, name)	Add data to the geoms attribute.
fiat.FiatModel.read_geoms()	Read the geometries for the exposure data.
fiat.FiatModel.write_geoms()	_summary_.