WATTS

WATTS: Workflow and template toolkit for simulation - Published in JOSS (2022)

https://github.com/watts-dev/watts

Science Score: 95.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 7 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: joss.theoj.org
  • Committers with academic emails
    29 of 31 committers (93.5%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Keywords

mcnp nuclear-energy openmc python simulation templates workflow-automation
Last synced: 4 months ago · JSON representation

Repository

Workflow and Template Toolkit for Simulation (WATTS)

Basic Info
  • Host: GitHub
  • Owner: watts-dev
  • License: mit
  • Language: Python
  • Default Branch: development
  • Homepage: https://watts.readthedocs.io
  • Size: 20.5 MB
Statistics
  • Stars: 32
  • Watchers: 5
  • Forks: 21
  • Open Issues: 12
  • Releases: 7
Topics
mcnp nuclear-energy openmc python simulation templates workflow-automation
Created almost 4 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog License

README.md

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 watts@anl.gov.

Owner

  • Name: watts-dev
  • Login: watts-dev
  • Kind: organization

JOSS Publication

WATTS: Workflow and template toolkit for simulation
Published
November 10, 2022
Volume 7, Issue 79, Page 4735
Authors
Paul K. Romano ORCID
Argonne National Laboratory, USA
Nicolas E. Stauff ORCID
Argonne National Laboratory, USA
Zhiee Jhia Ooi ORCID
Argonne National Laboratory, USA
Yinbin Miao ORCID
Argonne National Laboratory, USA
Amanda Lund ORCID
Argonne National Laboratory, USA
Ling Zou ORCID
Argonne National Laboratory, USA
Editor
Daniel S. Katz ORCID
Tags
nuclear engineering simulation Jinja

GitHub Events

Total
  • Create event: 1
  • Release event: 1
  • Issues event: 1
  • Watch event: 7
  • Issue comment event: 7
  • Push event: 3
  • Pull request review comment event: 8
  • Pull request review event: 10
  • Pull request event: 7
  • Fork event: 3
Last Year
  • Create event: 1
  • Release event: 1
  • Issues event: 1
  • Watch event: 7
  • Issue comment event: 7
  • Push event: 3
  • Pull request review comment event: 8
  • Pull request review event: 10
  • Pull request event: 7
  • Fork event: 3

Committers

Last synced: 5 months ago

All Time
  • Total Commits: 612
  • Total Committers: 31
  • Avg Commits per committer: 19.742
  • Development Distribution Score (DDS): 0.593
Past Year
  • Commits: 31
  • Committers: 3
  • Avg Commits per committer: 10.333
  • Development Distribution Score (DDS): 0.355
Top Committers
Name Email Commits
Paul Romano p****o@a****v 249
Nicolas Stauff n****f@a****v 94
Zhiee Jhia Ooi z****i@a****v 79
jia.zhou 4****U 31
Stauff n****f@c****l 26
Yinbin Miao y****o@a****v 18
Stauff n****f@a****v 14
sdotson s****n@a****v 10
Sam Dotson s****n@g****m 10
Stauff n****f@a****v 9
alund a****d@a****v 8
Stauff n****f@a****v 7
Stauff n****f@a****v 7
Zhiee Ooi z****i@v****v 7
Zhiee Ooi z****i@a****v 6
Nicolas Stauff n****f@v****v 5
Stauff n****f@a****v 5
danieletimpano d****o@s****h 4
Stauff n****f@a****v 3
Stauff n****f@a****v 3
Stauff n****f@a****v 3
Stauff n****f@a****v 3
Stauff n****f@n****v 2
Ling Zou l****u@a****v 2
Nicolas Stauff n****f@v****v 1
Stauff n****f@a****v 1
Stauff n****f@a****v 1
Stauff n****f@a****v 1
Stauff n****f@a****v 1
Stauff n****f@a****v 1
and 1 more...

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 27
  • Total pull requests: 92
  • Average time to close issues: about 2 months
  • Average time to close pull requests: 5 days
  • Total issue authors: 10
  • Total pull request authors: 9
  • Average comments per issue: 0.59
  • Average comments per pull request: 1.73
  • Merged pull requests: 86
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 2
  • Pull requests: 5
  • Average time to close issues: N/A
  • Average time to close pull requests: 5 days
  • Issue authors: 2
  • Pull request authors: 2
  • Average comments per issue: 1.5
  • Average comments per pull request: 1.4
  • Merged pull requests: 5
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • paulromano (8)
  • zhieejhia93 (4)
  • nstauff (3)
  • samgdotson (3)
  • yadudoc (3)
  • munkm (2)
  • zaknatnt (1)
  • miaoyinb (1)
  • nplinden (1)
  • sskutnik (1)
Pull Request Authors
  • paulromano (55)
  • nstauff (13)
  • zhieejhia93 (13)
  • JiaZhou-PU (8)
  • miaoyinb (3)
  • danieletimpano (2)
  • samgdotson (2)
  • amandalund (1)
  • biegelk (1)
Top Labels
Issue Labels
enhancement (3) bug (1)
Pull Request Labels
documentation (2) bug (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 267 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 7
  • Total maintainers: 1
pypi.org: watts

Workflow and Template Toolkit for Simulation

  • Versions: 7
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 267 Last month
Rankings
Forks count: 9.3%
Dependent packages count: 10.0%
Stargazers count: 14.5%
Average: 16.4%
Dependent repos count: 21.7%
Downloads: 26.3%
Maintainers (1)
Last synced: 4 months ago

Dependencies

.github/workflows/ci.yml actions
  • actions/checkout v4 composite
.github/workflows/publish-pypi.yml actions
  • actions/checkout v4 composite
  • actions/download-artifact v4 composite
  • hynek/build-and-inspect-python-package v2 composite
  • pypa/gh-action-pypi-publish release/v1 composite
pyproject.toml pypi
  • Jinja2 *
  • astropy *
  • click *
  • dill *
  • numpy *
  • pandas *
  • platformdirs *
  • prettytable *
  • uncertainties *