Skip to content

Latest commit

 

History

History
45 lines (32 loc) · 1.95 KB

README.md

File metadata and controls

45 lines (32 loc) · 1.95 KB

WATTS logo WATTS

License PyPI GitHub Actions build status (Linux) DOI

WATTS (Workflow and Template Toolkit for Simulation) consists of a set of Python classes that can manage simulation workflows for one or multiple codes. It provides the following capabilities:

  • An isolated execution environment when running a code;
  • The ability to use placeholder values in input files that are filled in programmatically;
  • Seamless unit conversions when working with multiple codes;
  • A managed database that simulation inputs and outputs are automatically saved to; and
  • Python classes that provide extra post-processing and analysis capabilities for each code.

Installation

To install watts, run:

python -m pip install watts

Documentation

Documentation for WATTS can be found here.

Citing

If you use WATTS in your research, please consider giving proper attribution by citing the following publication:

  • Paul K. Romano, Nicolas E. Stauff, Zhiee Jhia Ooi, Yinbin Miao, Amanda Lund, and Ling Zou, "WATTS: Workflow and template toolkit for simulation," Journal of Open Source Software, 7 (79), 4735 (2022). doi:10.21105/joss.04735

Sponsors

WATTS is being developed with support from Argonne National Laboratory. For any questions, please contact [email protected].