Command Line Interface

This page summarizes all ursa command line functions. With the exception of ursa initialize, which expected to be invoked in the directory containing a project directory, all commands are to be invoked within a project directory.

Most commands depend on the output of other commands. The Snakefile documents the order in which commands are typically executed.

Command	Description
ursa analyze exposure	Conduct exposure analysis (experimental).
ursa analyze sensitivity --method <method>	Conduct sensitivity analysis (experimental). The only method currently supported is linear-regression.
ursa clean files	Clean up files after running simulations is done and quality control is complete.
ursa compile dclaw	Compile D-Claw and place D-Claw related files in <project>/assets/compile/dclaw.
ursa export plots	Compiles and compresses debris-flow simulation index plots into an archive.
ursa export shapefile	Export vector outputs to shapefile format and compress into a zip file including a readme.
ursa export sciencebase	Export results to the standard format for a ScienceBase Child item.
ursa initialize <name>	Initialize project <name>. Optionally include --clean to have ursa clean up the files at the end of the workflow.
ursa plot experiment	Generate all standard results plots.
ursa plot benchmark	Generate plots synthesizing runtime and other run benchmarks.
ursa plot sensitivity --method <method>	Generates plots of sensitivity analysis. Requires that ursa analyze sensitivity  --method <method> was already run.
ursa plot runs	Generates plots of depth, arrival time, and momentum flux for each run.
ursa postprocess run --run <run-number>	Postprocess run number <run-number>.
ursa postprocess experiment	Postprocess the entire experiment.
ursa preprocess evt	Preprocess vegetation data (default is EVT 230).
ursa preprocess topo	Preprocess topography data (default is 10-m National Elevation Dataset).
ursa preprocess region	Preprocess region data (default is HUC12s).
ursa preprocess streams	Preprocess stream data (default is National Hydrologic Dataset)
ursa preprocess buildings	Preprocess building data (default is from OpenStreetMap).
ursa preprocess roads	Preprocess road data (default is from OpenStreetMap).
ursa preprocess basemap	Preprocess basemap (default is USGS Topo tiles).
ursa preprocess soil	Preprocess soil data for kf factor (default is STATSGO hosted by USGS ScienceBase).
ursa preprocess retainmenst	Preprocess retainments (default is from USGS ScienceBase).
ursa preprocess recurrences	Preprocess Atlas 14 rainfall information into rainfall recurrence intervals.
ursa qc all	Run all quality control commands.
ursa qc courant	Quality control all D-Claw simulations based on the maximum observed courant number.
ursa qc passfail	Quality control the number of D-Claw simulations that completed successfully.
ursa qc timing	Generate synthesis commas separated value files describing runtime.
ursa qc version	Identify the version of ursa used and print it to a time-stamped file.
ursa reset snakefile	Resetting the project snakefile to the most up-to-date snakefile in the ursa library.
ursa run all	Run the entire ursa workflow.
ursa run dclaw --run <run-number> --sim <simulation-number>	Run a specific D-Claw simulation.
ursa run wildcat	Run wildcat.
ursa run until-wildcat	Run ursa workflow until (inclusive) the wildcat stage.
ursa setup extent	Identify the considered extent and generate key files documenting the location of the project.
ursa setup source	Use the output of wildcat, or other hazard assessment method to determine the locations within delineated basins above which debris-flow material will be placed by ursa setup dclaw.
ursa setup experiment	Generate the file structure containing a directory for each run.
ursa setup dclaw --run <run-number>	Set up an individual D-Claw run, including breaking it up into simulations by region and generating input files.
ursa upload sciencebase	Upload exported child item to ScienceBase (requires authentication). Alternatively, add ursa upload sciencebase --update_parent_only to only update parent metadata.