Welcome to the Umami documentation!¶
Introduction and Purpose¶
Umami is a package for calculating objective functions or objective function
components for landscape evolution modeling. It was designed to work well with
terrainbento and other models built with the Landlab Toolkit. Examples
can be found in the notebooks on Binder (or in the
Umami offers two primary classes: a
which represents the difference between model and data, and a
which is a calculated value on either model or data. The set of currently
supported calculations can be found in the
Umami was designed to provide an input-file based interface for calculating
single-value landscape metrics for use in model analysis. This supports
reproducible analysis and systematic variation in metric construction. When
terrainbento, one input file can describe the model run, and
another input file can describe the model assessment or model-data comparison.
This streamlines model analysis applications. Umami also provides multiple
output formats (YAML and Dakota), the latter of which is designed to interface
with Sandia National Laboratory’s Dakota package.
The source code is housed on GitHub.
Check out the example notebooks housed on Binder to get a sense of how umami can be used.
All contributions are welcome. Make an issue on GitHub to file a bug report.
If you are planning to contribute to the source code, please read the following page for more information.