Skip to content

Welcome to the duet-tools Documentation!

What is duet-tools?

duet-tools is a Python package that provides a convenient interface for programmatically working with the inputs and outputs of the DUET program developed by McDanold et al. (2023) at Los Alamos National Lab. Central to the package is the ability to calibrate the values in DUET outputs to match targets supplied by the user or national datasets.

The goals of duet-tools are to:

  1. Write a DUET input file.
  2. Read in DUET outputs for easy manipulation.
  3. Calibrate DUET outputs by scaling the magnitude of the parameter values while retaining the spatial distributions from DUET.
  4. Provide a platform for the future development of additional tools centered around DUET.

Installation

duet-tools can be installed using pip.

pip

pip install duet-tools

To use the landfire module, install using the landfire extra using pip.

pip install duet-tools[landfire]

NOTE: the landfire extra is not compatible with Python 3.12.

Issues

If you encounter any issues with the duet-tools package, please submit an issue on the duet-tools GitHub repository issues page.