configuration.py API¶

The configuration.py file lives in the assessment folder and records settings used to implement and export the assessment.

Key Fields¶

Key fields used by ocelote to implement an assessment.

buffer_km¶

Type:: float
Default:: 3

The number of kilometers to buffer the fire perimeter. The extent of the buffered perimeter defines the domain of the analysis, and the bounding box of this domain is used to help download datasets from the internet.

severity_thresholds¶

Type:: [float, float, float]

This field is only used when estimating burn severity from the dNBR. In this case, the field should list the three dNBR thresholds used to classify severity levels. The first value is the breakpoint between unburned and low severity. The second value is the breakpoint between low and moderate severity, and the third value is the breakpoint between moderate and high severity. A dNBR value that exactly equals a breakpoint will be classified at the lower severity level.

I15_mm_hr¶

Type:: [int, ...]

Peak 15-minute rainfall intensities in millimeters per hour. These values are the design storms used to implement the likelihood, volume, and combined hazard models.

I15_legend¶

Type:: int

Indicates the design storm that should be displayed on the web map. Must be one of the rainfall intensities listed in I15_mm_hr.

Rainfall threshold legends¶

legend_min¶

Type:: int
Default:: 12

The lower bound used when building legend entries for rainfall threshold results. Rainfall thresholds below this value will be given a legend entry with format <legend_min mm/h.

legend_max¶

Type:: int
Default:: 40

The upper bound used when building legend entries for rainfall threshold results. Rainfall thresholds above this value will be given a legend entry with format >legend_max mm/h.

legend_step¶

Type:: int
Default:: 4

The step size used to build bins for legend entires for rainfall threshold results. For example, using the default values, legend entries will use the bins 12-16 mm/h, 16-20 mm/h, 20-24 mm/h, etc.

Wildcat Fields¶

The remaining fields in configuration.py are passed directly to the wildcat package to implement the assessment. Please consult the wildcat API for details on these fields.

By default, configuration.py will only list the most commonly altered wildcat settings. However, you may use other wildcat settings by adding their fields to configuration.py. Note that wildcat’s file path fields are ignored, as ocelote extracts paths from datasets.py instead. Also, any wildcat export settings are ignored, as ocelote is designed to export results that conform to the PWFDF data specification.