Skip to main content

Python Toolkit for Uncertainty Quantification (PyTUQ)

Khachik Sargsyan, Bert Debusschere, Emilie Grace Baillo

Deploy to GitHub Pages Run Tests Coverage Status

Overview

The Python Toolkit for Uncertainty Quantification (PyTUQ) is a Python-only collection of libraries and tools designed for quantifying uncertainty in computational models. PyTUQ offers a range of UQ functionalities, including Bayesian inference and linear regression methods, polynomial chaos expansions, and global sensitivity analysis methods. PyTUQ features advanced techniques for dimensionality reduction, such as SVD and Karhunen-Loeve expansions, along with various MCMC methods for calibration and inference. The toolkit also includes robust classes for multivariate random variables and integration techniques, making it a versatile resource for researchers and practitioners seeking to quantify uncertainty in their numerical predictions. To explore the PyTUQ documentation and learn more, visit our website here.

Dependencies

PyTUQ requires:

  • numpy
  • scipy
  • matplotlib

Optional dependencies include:

  • pytorch (NN surrogates)
  • QUiNN (Quantification of Uncertainties in Neural Networks)
  • pyswarms (Particle Swarm Optimization)

Installation

Basic Installation

Install PyTUQ with core dependencies:

$ pip install pytuq

Optional Features

Install additional features as needed:

  • Neural network surrogates
$ pip install pytuq[nn]
  • Particle swarm optimization
$ pip install pytuq[optim]
  • All optional features
pip install pytuq[all]
  • Development tools
pip install pytuq[dev]

Installation from Source

  1. To install PyTUQ from source, start up a Python virtual environment and clone the repository:
    $ source <PYTHON_VENV_DIR>/bin/activate
    $ git clone git@github.com:sandialabs/pytuq.git
    $ cd pytuq
  1. (Optional) To take advantage of the neural network surrogate model capabilites in PyTUQ, use the following command to install PyTUQ's optional dependencies:
    $ pip install -r requirements.txt
  1. Install primary PyTUQ dependencies and PyTUQ:
    $ pip install .

License

Distributed under BSD 3-Clause License. See LICENSE.txt for more information.

Acknowledgements

This work is supported by the Scientific Discovery through Advanced Computing (SciDAC) Program under the Office of Science at the U.S. Department of Energy.

Sandia National Laboratories is a multimission laboratory managed and operated by National Technology & Engineering Solutions of Sandia, LLC, a wholly owned subsidiary of Honeywell International Inc., for the U.S. Department of Energy’s National Nuclear Security Administration under contract DE-NA0003525.

Metadata

Release files for pytuq 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pytuq 1.0.0
File Size Uploaded
pytuq-1.0.0.tar.gz 101.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pytuq 1.0.0
File Interpreter ABI Platform
pytuq-1.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 223.7 kB

Release files / pytuq-1.0.0.tar.gz

Download URL pytuq-1.0.0.tar.gz
Size 101.8 kB
Tags Source
SHA-256 checksum
How to use checksums
1fc9fabf7bf183d38e104564e99d1950f7e2103baac5a13960c356173b9997ff
BLAKE2b-256 checksum
How to use checksums
687e3584efe33c463478fce32375aa12d954a5d953d3e8b4bbe3dff7f38ef545
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.3

Release files / pytuq-1.0.0-py3-none-any.whl

Download URL pytuq-1.0.0-py3-none-any.whl
Size 121.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0469ed663d5fd5b08cf86b56c9622df0e6b4b0fedf21345e7ad6ea04da11b87d
BLAKE2b-256 checksum
How to use checksums
92b567087dee99b16af9c135afb9cc20494376775d232c9a528eab87f2a8119c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.3

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page