Skip to content

Documentation Status Tests PyPI - Python Version PyPI

Duqtools

Duqtools is a tool for Dynamic Undertainty Quantification for Tokamak reactor simulations modelling.

Features:

  • Set up 100s of simulation runs from a single template
  • Launch stardard sets of sensitivy tests with minimal programming
  • Batch job submission and status tracking
  • Supports the Standardized Interface Data Structures (IDSs) data directory
  • Compare and visualize 100s of simulations in one overview
  • Display simulation results as confidence ranges and distributions

Duqtools is currently under active development. It runs on linux only and requires the ITER Integrated Modeling and Analysis Suite (IMAS).

To install:

pip install duqtools

The source code is available from Github.

Suggestions, improvements, and edits are most welcome.

Development

Duqtools targets Python 3.7, which is the version available on eufus.

Clone the repository into the duqtools directory:

git clone https://github.com/CarbonCollective/fusion-dUQtools.git duqtools

Install using virtualenv:

cd duqtools
python3 -m venv env
source env/bin/activate
python3 -m pip install -e .[develop]

Alternatively, install using Conda:

cd duqtools
conda create -n duqtools python=3.7
conda activate duqtools
pip install -e .[develop]

Tests

Duqtools uses pytest to run the tests. You can run the tests for yourself using:

pytest

Documentation

The documentation uses the mkdocs. To build the docs for yourself:

mkdocs serve

Making a release

  1. Bump the version (major/minor/patch as needed)
bumpversion minor
  1. Make a new release. The upload to pypi is triggered when a release is published.