PUQ: Python package for generating experimental designs tailored for uncertainty quantification and featuring parallel implementations
PUQ is a Python package that employs novel experimental design techniques with intelligent selection criteria, refining data collection to enhance the efficiency and effectiveness of uncertainty quantification.
This code is tested with Python 3.9, 3.10, 3.11, and 3.12 and requires pip.
Python 3.12 users need to install setuptools manually via:
python -m ensurepip --upgrade python -m pip install --upgrade setuptools
We recommend creating a Python virtual environment within the working directory of PUQ. If a virtual environment is created, PUQ's required packages are installed and isolated from those installed a priori. Creating a virtual environment will also prevent having conflicting packages on a user's machine. You may need to install the virtual environment on your system (if a user's system does not have it), for example, with 'apt install python3.9-venv'
Extract the zipped file.
From the command line, go to the directory of the source code.
Use the following command to create a virtual environment:
python -m venv venv/ source venv/bin/activate
We note that creating a virtual environment is not a required step. However, we tested this procedure to prevent any conflict, and the code runs smoothly.
To install the PUQ package:
Go to the directory of the source code (if a user has not done so yet).
Use the following command to install the required packages:
pip install -r requirements.txt
From the command line, use the following command to install PUQ:
pip install -e .
Once installed, a user should see build/ directory created.
The test suite requires the pytest and pytest-cov packages, which can be installed via pip install pytest pytest-cov.
The test suite can be run from the tests/ directory of the source distribution by running:
./run-tests.sh
The documentation is stored in docs/ and is compiled with the Sphinx Python
documentation generator. It is written in the reStructuredText format. These
files are hosted at Read the Docs.
To compile the documentation, from the directory of the source code, run the following command
sphinx-build -M html docs docs
The HTML files are then stored in docs/html
Citation:
- Please use the following to cite PUQ in a publication:
@techreport{PUQ2022,
author = {Özge Sürer, Matthew Plumlee, Stefan M. Wild},
title = {PUQ Users Manual},
institution = {},
number = {Version 0.1.0},
year = {2022},
url = {https://github.com/parallelUQ/PUQ}
}We provide examples in the examples directory to illustrate the basic usage of PUQ.
These examples replicate some results presented in our papers. README file within the directory provides further instructions.
Type deactivate from the command line to deactivate the virtual environment if created.
Type pip uninstall PUQ from the command line to uninstall the package.