Skip to content

Core (take 2)

King, Jonathan M requested to merge ghsc/users/jking/wildcat:core-2 into main

Summary

This MR extends and follows up on !3 (closed). In brief it introduces the 4 core wildcat commands:

  • initialize - Initializes a project folder with a default config file
  • preprocess - Cleans and preprocesses input datasets
  • assess - Implements a numerical hazard assessment
  • export - Exports saved assessment results to common GIS formats

The MR addresses any lingering issues from !3 (closed) and also migrates the package to pfdf 2.0.0. A key advantage of this migration is support for input datasets in mixes of geographic and projected coordinate systems.

Currently, the package is documented via the CLI help text (via the usual -h options), and via the function docstrings. Feedback on the help text and docstrings is welcome, but I'd suggest we leave other documentation sources for the next MR (which is planned to be entirely documentation). If it's useful, the forthcoming MR will include the README, user guide, API, links to common datasets, detailed guide for exporting properties, etc.

Changes

The overall structure of wildcat is the same as before, but there have been some smaller changes. Some of the more notable changes include:

Preprocessor:

  • Can disable a dataset by setting it equal to None (CLI) or False (Python)
  • Added a DEM resolution check,
  • Missing KF-factor fill options
  • Option to contain severity data values within the fire perimeter

Assessment:

  • Excluded / Included masks for network delineation and filtering, respectively
  • max_exterior_ratio: Helps determine whether a segment is considered "inside the perimeter"
  • remove_ids: Allows user to remove problem segments from the network by listing their IDs
  • Renamed some of the hazard modeling parameters
  • Now computes volume confidence intervals
  • No longer computes likelihoods for multiple rainfall durations. Only I15 is supported for likelihood
  • Parameters used as follows:
    • I15_mm_hr, volume_CI -> hazard (H), likelihood (P), volume (V, Vmin, Vmax)
    • durations, probabilities -> rainfall thresholds as accumulations (R) and intensities (I)

Export:

  • No longer attempts to export multiple formats. Should call the command twice if you need multiple formats
  • Filtering properties now available for export
  • Comprehensive property renaming options
  • Automatically attempts to simplify property names for modeled results
Edited by King, Jonathan M

Merge request reports