Skip to main content

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

Project description

EasyVVUQ icon

EasyVVUQ

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

You can find the API Documentation on our GitHub Pages.

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.

Files for easyvvuq, version 1.1
Filename, size File type Python version Upload date Hashes
Filename, size easyvvuq-1.1.tar.gz (147.5 kB) File type Source Python version None Upload date Hashes View
Filename, size easyvvuq-1.1-py3-none-any.whl (200.5 kB) File type Wheel Python version py3 Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page