Settings

The user must set the model settings in the settings.toml configuration file.

Besides the necessary/ required setttings one can set:

Basic input

This section pertains to all input that is vital for running a FIAT model.

These inputs/ entries are listed in the table down below with more detailed information per entry underneath the table.

Note

File paths in the settings can be relative to the settings.toml file or absolute.

Table 1: Most basic settings file input
Entry Type Required Default
[output]
path string Yes
[output.csv]
name string No output.csv
[output.geom]
name[n] string No spatial[n].gpkg
[output.grid]
name string No ead.nc
[hazard]
file string Yes
elevation_reference string Yes
risk boolean No false
[exposure.csv]
file string No -
[exposure.geom]
file[n] string Yes
[exposure.grid]
file string Yes
[vulnerability]
file string Yes

[output]

  • path: The path to the output folder in the working directory.

[output.csv]

  • name: The path to the output CSV file that will be created, that contains the information from the exposure.csv and the damages per asset.

[output.geom]

  • name[n]: This sets the name and location of the output vector file that contains the geometry, location and the damages per asset.
Warning

If provided, the suffix is mandatory. The suffix should match the suffix of the input geometry file for which it is set.

[output.grid]

  • name: This sets the name and location of the output raster file that contains damages per grid cell.

[hazard]

  • file: The file path to the hazard file.

  • elevation_reference: This indicates the elevation reference of the flood map. In case of a flood-depth map this should be “DEM” while in case of a flood-elevation map this should be “datum”.

  • risk: In case of a risk calculation this must be set to “true”, for a single events this must be set to “false”.

[exposure.csv]

  • file: The path to the exposure CSV file (recommended to be within the exposure folder) that contains the required information per asset. There can only be one exposure CSV file.

[exposure.geom]

  • file[n]: The path to the exposure vector file (recommended to be within the exposure folder) with the assets’ geometry and object_id. The user can provide multiple vector files. Therefore the ‘[n]’ suffix, as the user can create mulitple entries for vector files (e.g. file1, file2 etc.).
Warning

The suffix is mandatory. So if only one file is provided, name it file1.

Note

Only required when running the geometry based model.

[exposure.grid]

  • file: The path to the exposure raster file (recommended to be within the exposure folder).
Note

Only required when running the raster based model.

[vulnerability]

  • file: The path to the vulnerability curves CSV file within the vulnerability folder that contains the damage curves. Only one vulnerability curves file is allowed.

Example

An example of settings file for running a geometry model is given below:

[output]
path = "output"

[output.csv]
name = "output.csv"

[output.geom]
name1 = "spatial.gpkg"

[hazard]
file = "hazard/SL_10yr_reprojected.tif"
elevation_reference = "DEM"
risk = false

[exposure.geom]
file1 = "./exposure/buildings.gpkg"

[exposure.csv]
file = "./exposure/exposure.csv"

[vulnerability]
file = "./vulnerability/vulnerability_curves.csv"
Back to top