hydromt_fiat.FIATModel

class hydromt_fiat.FIATModel(root: str | None = None, config_fname: str = 'settings.toml', *, mode: str = 'r', data_libs: list[str] | str | None = None, **catalog_keys)

Build, read and/ or write a FIAT model.

Parameters:

• root (str, optional) – Model root, by default None.

• config_fname (str, optional) – Name of the configurations file, by default ‘settings.toml’.

• mode ({'r','r+','w'}, optional) – read/append/write mode, by default “w”.

• data_libs (list[str] | str, optional) – List of data catalog configuration files, by default None.

• **catalog_keys (dict) – Additional keyword arguments to be passed down to the DataCatalog.

Attributes

config	Access the config component.
crs	Returns coordinate reference system embedded in region.
exposure_geoms	Access the exposure geoms component.
exposure_grid	Access the exposure grid component.
hazard	Access the hazard component.
name
region	Return the model's region.
vulnerability	Access the vulnerability component.

Methods

add_component(name, component)	Add a component to the model.
build(*[, write])	Single method to build a model from scratch based on settings in steps.
clip(region)	Clip the model based on a new (smaller) region.
from_dict(model_dict)	Construct a model with the components and other init arguments in the yaml file located at path.
from_yml(path)	Construct a model with the components and other init arguments in the yaml file located at path.
get_component(name)	Get a component from the model.
read()	Read the FIAT model.
setup_config(**settings)	Set config file entries.
setup_region(region[, replace])	Set the region of the FIAT model.
test_equal(other)	Test if two models are equal, based on their components.
update(*[, model_out, write, steps, ...])	Single method to update a model based the settings in steps.
write()	Write the FIAT model.
write_data_catalog([root, data_lib_path, ...])	Write the data catalog to data_lib_path.