Export Configuration¶

These fields specify settings used to export assessment results.

Output file¶

These settings affect the format and names of the exported files.

format¶

Type:: str
Default:: "Shapefile"

The GIS file format of the exported files. The Vector Format Guide lists the supported format options in the first column. Format names are case-insensitive.

Example:

# Export results to Shapefile
format = "Shapefile"

CLI option: --format

Python kwarg: format

prefix¶

Type:: str
Default:: ""

A string that should be prepended to the beginning of exported file names. May only include ASCII letters, numbers, hyphens (-), and/or underscores (_).

Example:

# Add "fire-id" to the beginning of exported file names
prefix = "fire-id"

CLI option: --prefix

Python kwarg: prefix

suffix¶

Type:: str
Default:: ""

A string that should be appended to the end of exported file names (but before the file extension). May only include ASCII letters, numbers, hyphens (-), and/or underscores (_).

Example:

# Add "YYYY-MM-DD" to the end of exported file names
suffix = "YYYY-MM-DD"

CLI option: --suffix

Python kwarg: suffix

Properties¶

Settings that select exported properties.

properties¶

Type:: [str, ...]
Default:: ["default"]

The list set of exported properties. May include property names, result prefixes, and property groups.

Example:

# Export catchment area, hazard results, and model inputs
properties = ["Area_km2", "H", "model inputs"]

CLI option: --properties

Python kwarg: properties

exclude_properties¶

Type:: [str, ...]
Default:: []

Properties that should be removed from the base property list. May include property names, result prefixes, and property groups.

Example:

# Export watershed variables, except for Segment_ID
properties = ["watershed"]
exclude_properties = ["Segment_ID"]

CLI option: --exclude-properties

Python kwarg: exclude_properties

include_properties¶

Type:: [str, ...]
Default:: []

Properties that should be added to the property list, after excluded properties have been removed. May include property names, result prefixes, and property groups.

Example:

# Export default fields, but exclude watershed variables (except for Segment_ID)
properties = ["default"]
exclude_properties = ["watershed"]
include_properties = ["Segment_ID"]

CLI option: --include-properties

Python kwarg: include_properties

Property Order¶

order_properties¶

Type:: bool
Default:: True

Whether to reorder the exported properties, such that related properties are grouped together. If False, does not reorder the properties. In this case, properties will be ordered in the order they are listed.

Example:

# Do not reorder the properties
order_properties = False

CLI option: --no-order-properties

Python kwarg: order_properties

Rename¶

Settings used to rename the exported properties.

clean_names¶

Type:: bool
Default:: True

Whether to rename result properties, such that hazard parameter indices are replaced with simplified parameter values. If False, exported result properties will retain the index naming scheme.

Example:

# Do not rename result indices to values
clean_names = False

CLI option: --no-clean-names

Python kwarg: clean_names

rename¶

Type:: dict
Default:: {}

A dict with custom renaming settings. The keys may include property names, hazard prefixes, or hazard parameter names. Please see the Renaming Guide for more details.

Example:

# Implement a custom renaming scheme
rename = {
    "Segment_ID": "SID",
    "H": "Hazard",
    "probabilities": ["P50", "P75"],
}

CLI options: --rename, --rename-parameter

Python kwarg: rename