Skip to main content

Library to facilitate simple Verification, Validation and Uncertainty Quantification of simulation codes

Project description

EasyVVUQ icon

EasyVVUQ

Build Status Language grade: Python Documentation Status Coverage Status CII Best Practices Binder

The aim of EasyVVUQ is to facilitate verification, validation and uncertainty quantification (VVUQ) for a wide variety of simulations. While very convenient for simple cases, EasyVVUQ is particularly well suited in situations where the simulations are computationally expensive, heterogeneous computing resources are necessary, the sampling space is very large or book-keeping is prohibitively complex. It coordinates execution using an efficient database, it is fault tolerant and all progress can be saved.

Here are some examples of questions EasyVVUQ can answer about your code:

  • Given the uncertainties in input parameters, what is the distribution of the output?
  • What percentage of the output variance each input parameter contributes?

It also lets you construct surrogate models that are cheaper to evaluate than the complete simulation.

Basic concepts are introduced here and here. For an introduction for interfacing your simulation to EasyVVUQ see this notebook.

Available analysis and sampling methods:

  • Polynomial Chaos Expansion
  • Stochastic Collocation
  • Monte Carlo Sensitivity Analysis
  • Markov-Chain Monte Carlo

EasyVVUQ also supports building surrogate models using:

  • Polynomial Chaos Expansion
  • Stochastic Collocation
  • Gaussian Processes

Supported computing resources:

The easiest way to get started is to follow the tutorials in our Binder.

Development was funded by the EU Horizon 2020 project VECMA.

Requirements

To use the library you will need Python 3.6+.

Installation using pip

If you are unsure of the version of python your default pip works for type:

pip --version

If the output ends with (python 2.7) you should replace pip with pip3 in the following commands.

The following should fully install the library:

pip install easyvvuq

To upgrade the library use:

pip install easyvvuq --upgrade

Manual installation from repository

Alternatively, you can manually install EasyVVUQ. First clone the repository to your computer:

git clone https://github.com/UCL-CCS/EasyVVUQ.git

Note: As above, you need to be sure you are installing for Python 3 - if necessary replace pip with pip3 and python with python3 in the commands below.

We are trying to keep dependencies at a minimum but a few are inevitable, to install them use:

cd EasyVVUQ/

pip install --use-feature=2020-resolver -r requirements.txt

Then the library can be installed using:

python setup.py install

Getting Started

Documentation, including a basic tutorial, is avalable here.

Citing EasyVVUQ

Richardson, R A, Wright, D W, Edeling, W, Jancauskas, V, Lakhlili, J and Coveney, P V. 2020 EasyVVUQ: A Library for Verification, Validation and Uncertainty Quantification in High Performance Computing. Journal of Open Research Software, 8: 11. DOI: 10.5334/jors.303.

Wright, D.W., Richardson, R.A., Edeling, W., Lakhlili, J., Sinclair, R.C., Jancauskas, V., Suleimenova, D., Bosak, B., Kulczewski, M., Piontek, T., Kopta, P., Chirca, I., Arabnejad, H., Luk, O.O., Hoenen, O., Weglarz, J., Crommelin, D., Groen, D. and Coveney, P.V. (2020), Building Confidence in Simulation: Applications of EasyVVUQ. Adv. Theory Simul., 3: 1900246. DOI: 10.1002/adts.201900246.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

easyvvuq-0.9.2.tar.gz (123.8 kB view details)

Uploaded Source

Built Distribution

easyvvuq-0.9.2-py3-none-any.whl (190.0 kB view details)

Uploaded Python 3

File details

Details for the file easyvvuq-0.9.2.tar.gz.

File metadata

  • Download URL: easyvvuq-0.9.2.tar.gz
  • Upload date:
  • Size: 123.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4

File hashes

Hashes for easyvvuq-0.9.2.tar.gz
Algorithm Hash digest
SHA256 40dc60195795d0c07d205d8b0cee53e13ca80e9c51bae1d9103ac00d434e29a5
MD5 e56531578b8a1cd92d0afd2539fe5e7c
BLAKE2b-256 06930c7b25cb6f1d795a8611643f12cecc684136b7abb3983f4af703920595f3

See more details on using hashes here.

File details

Details for the file easyvvuq-0.9.2-py3-none-any.whl.

File metadata

  • Download URL: easyvvuq-0.9.2-py3-none-any.whl
  • Upload date:
  • Size: 190.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4

File hashes

Hashes for easyvvuq-0.9.2-py3-none-any.whl
Algorithm Hash digest
SHA256 acf17b854863e004aa7b30f4a803dd1b32c5e9a876acccf692e7ce3b900e3da1
MD5 1f6ab0b16207d272e41cb4923c6e7394
BLAKE2b-256 3189d0da25b650c24036044746f70f622568b0ba31f7915c1659f9cc469ebdd8

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page