File Structure¶
Ursa generates a standardized file structure. This page describes most of the generated files within the directory structure. It is ordered chronologically, separating files into those generated in the initialization, run, and quality control phase of usage.
Initialization¶
config¶
The config directory stores the config file that contains important information about the experiment being run, such as locations of important files, parameters to set up simulations for, values needed for the post-processing, and other generally useful information.
user-input¶
The user-input directory exists as a standardized location for users to place any important files in, so that all experiment related files are in one place. While ursa does not require any files placed within user-input, keeping all files within user-input helps with keeping all use-provided and ursa-generated files within the same top-level project directory.
workflow¶
The workflow directory contains the Snakefile.
source¶
The source directory contains the source code for Clawpack and D-Claw, which ursa relies on for its simulations.
Run¶
assets¶
The assets directory contains the files that ursa uses as input for setting up and running of simulations, as well as resources for plotting. Many of the files within assets are created in the preprocess steps, and contain everything from the compiled D-Claw executable to building and road data for extent of damages.
More information about the assets directory can be found here.
results¶
The results directory stores all of the files that result from the running of D-Claw. These files include directories for each simulation as well as directories containing files that sythesize results.
More information about the results directory can be found here.
benchmarks¶
The benchmarks directory is populated by Snakemake. It contains files that hold information about each individual job in the Snakemake queue. Some of the data included in each benchmark file is the runtime of the task, any wildcard parameters used when calling the task, and how much system resources were dedicated to running the task.
plots¶
The plots directory contains all of the plots that are related to the runout simulated by ursa. Plots are broken up by regions for the purpose of plotting, with each region being stored within an individual folder. In addition to the region folders, there is also a folder for plots that show all regions in one figure, as well as an overview plot that labels each region with the label corresponding to its folder. If the user provided any custom regions, a folder for those regions will be present as well.
More information about what each plot represents can be found here.
Quality control and benchmark¶
qc¶
The qc directory contains many different diagnostic plots and figures to ensure that ursa ran properly, as well as other parts of its performance. qc has two subdirectories, benchmark and passfail, which contain figures about runtimes/important parameters for tasks, and simulation success rates respectively. More information about the quality assurance of ursa can be found here.