Skip to content

Core

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

Summary

This merge request provides the core functionality for wildcat. Specifically, the

  • initialize
  • preprocess
  • assess, and
  • export

commands.

Documentation

The most comprehensive documentation can be found in the docstrings of the main function for each command. For example, the docstrings of wildcat.commands.initialize.initialize, wildcat.commands.preprocess.preprocess, etc. The CLI interface provides a few variations on the inputs, and help for these parameters can be obtained using the standard -h command line argument.

Also, the pfdf tutorials walk through the wildcat use-case in detail. Specifically, the preprocessing and hazard assessment tutorials - these provide detailed explanations of wildcat's parameters, and may be helpful for visualizing wildcat operations. They also provide a demo dataset to play around with. You can find the pfdf tutorials here: https://ghsc.code-pages.usgs.gov/users/jking/pfdf/tutorials/index.html

Installation

You can install wildcat using:

pip install git+https://code.usgs.gov/ghsc/users/jking/wildcat@core

(This may prompt you to sign in to Gitlab first). If that doesn't work, cloning the repository should let you do a local pip install.

Merge request reports