hydromt_fiat.components.VulnerabilityComponent.setup#

VulnerabilityComponent.setup(vulnerability_fname: Path | str, vulnerability_linking_fname: Path | str | None = None, *, unit: str = 'm', index_name: str = 'water depth', column_oriented: bool = True, **select) → None[source]#

Set up the vulnerability from a data source.

Warning

The datasets (vulnerability_fname and vulnerability_linking_fname) need to have a ‘type’ column.

Parameters:

  • vulnerability_fname (Path | str) – Path to vulnerability dataset file or an entry in the data catalog that points to the vulnerability dataset file.

  • vulnerability_linking_fname (Path | str, optional) – Path or data catalog entry of the vulnerability linking table. If not provided, it is assumed that the ‘type’ in the vulnerability dataset is correct, by default None.

  • unit (str, optional) – The unit which the vulnerability index is in, by default “m”.

  • index_name (str, optional) – The output name of the index column, by default “water depth”.

  • column_oriented (bool, optional) – Whether the vulnerability data is column oriented, i.e. the values of a curve are in the same column spanning multiple rows. If False, the values are ought to be in the same row spanning multiple columns. By default True.

  • **select (dict, optional) – Keyword arguments to select data from the ‘vulnerability_fname’ data source.