Skip to main content

An open-source, object-oriented Python package for surrogate-assisted Bayesain Validation of computational models.

Project description

BayesValidRox

bayesvalidrox logo

An open-source, object-oriented Python package for surrogate-assisted Bayesain Validation of computational models. This framework provides an automated workflow for surrogate-based sensitivity analysis, Bayesian calibration, and validation of computational models with a modular structure.

Project Status: Active – The project has reached a stable, usable state and is being actively developed.

Features

  • Surrogate modeling with Polynomial Chaos Expansion, Gaussian Process Emulator, mixed surrogate types
  • Global sensitivity analysis using Sobol Indices
  • Bayesian calibration and validation with Rejection sampling or MCMC using emcee package
  • Bayesian model comparison with model weights or confusion matrix for multi-model setting

Resources

The following resources are useful to get started on working with BayesValidRox:

Important links:

Authors

Best to contact: @RKohlhaas, @mariafer.morales

Full list of authors:

Installation

The best practive is to create a virtual environment and install the package inside it.

To create and activate the virtual environment run the following command in the terminal:

  python3 -m venv bayes_env
  cd bayes_env
  source bin/activate

You can replace bayes_env with your preferred name. For more information on virtual environments see this link.

Now, you can install the latest release of the package on PyPI inside the venv with:

  pip install bayesvalidrox

and installing the version on the master branch can be done by cloning this repo and installing:

  git clone https://git.iws.uni-stuttgart.de/inversemodeling/bayesvalidrox.git
  cd bayesvalidrox
  pip install .

Requirements

Core packages (same for all Python >=3.9)

  • numpy>=1.26.4
  • pandas>=2.2.3
  • joblib>=1.5.3
  • seaborn>=0.13.2
  • tqdm>=4.64.0
  • chaospy==4.3.21
  • h5py>=3.9.0
  • statsmodels>=0.14.2
  • multiprocess>=0.70.16
  • corner==2.2.3

Python 3.9

  • matplotlib>=3.7,<3.10
  • scipy>=1.9,<1.11
  • emcee>=3.0.2,<3.1.6
  • scikit-learn>=1.0,<1.2
  • datasets>=2.20.0,<4.0.0

Python >= 3.10

  • matplotlib>=3.10.0
  • scipy>=1.15.2
  • emcee>=3.1.6
  • scikit-learn>=1.7.2,<1.8.0
  • datasets>=4.6.1

TexLive for Plotting with matplotlib

Here you need super user rights

sudo apt-get install dvipng texlive-latex-extra texlive-fonts-recommended cm-super

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

bayesvalidrox-2.2.0.tar.gz (174.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bayesvalidrox-2.2.0-py3-none-any.whl (155.0 kB view details)

Uploaded Python 3

File details

Details for the file bayesvalidrox-2.2.0.tar.gz.

File metadata

  • Download URL: bayesvalidrox-2.2.0.tar.gz
  • Upload date:
  • Size: 174.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.5

File hashes

Hashes for bayesvalidrox-2.2.0.tar.gz
Algorithm Hash digest
SHA256 85b5c0720c938a2b46e035c8d62c34e603f687e6a54a3bb6f132b687d22ff0fa
MD5 e75c95890f6de68b377b5b47954ef1af
BLAKE2b-256 47f8d78edf450fbe97fe30b0d73e009a40449058214de7ee673a00e39bf58962

See more details on using hashes here.

File details

Details for the file bayesvalidrox-2.2.0-py3-none-any.whl.

File metadata

  • Download URL: bayesvalidrox-2.2.0-py3-none-any.whl
  • Upload date:
  • Size: 155.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.5

File hashes

Hashes for bayesvalidrox-2.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f1d0adce9a68d77c6c130a397508736e059066ae74b37b9560a7db9adb99570b
MD5 f729a486cef976936303a63fead59526
BLAKE2b-256 502153494ada3966b0141ed23d614e1862ad43221ec056110af0c31e8a426293

See more details on using hashes here.

Supported by

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