Skip to main content

A tool to facilitate uncertainity quantification and sensitivity methods.

Project description


IBIS

LLNL's Interactive Bayesian Inference and Sensitivity, or IBIS, provides tools to enable understanding how the output of a model is impacted by uncertainty in its inputs. With the sensitivity module we can rank and visualize the effect of inputs on the computational model output. The mcmc module enables us to incorporate experimental data into our understanding of input and output distributions with Bayesian inference.

Sensitivity studies A variety of methods are availble in IBIS to understand and compare the impacts of model inputs.

  • F-test: f_score
  • mutual information score: mutual_info_score
  • Lasso regression: lasso
  • sensitivity with "spaghetti plot": sensitivity
  • One-at-a-time study: including method of Morris
  • Variance based sensitivity analysis: Sobol indices
  • polynomial chaos expansion: pce_score

Associated modules - sensitivity - pce_model - plots

Bayesian Inference/Calibration A Bayesian posterior distribution can be estimated with IBIS's mcmc module. It can estimate input parameter uncertainty and model discrepancy. For more details refer to Bayesian Calibration of Computer Models.

  • default mcmc: Metropolis-Hastings algorithm and multivariate normal likelihood
  • discrepancy mcmc: We can additionally estimate "tau" model discrepancy parameters

Associated modules - mcmc - mcmc_diagnostics

Kosh operators If users have data in a Kosh store, it's convenient to use IBIS's Kosh operators to run the various sensitivity methods or create the mcmc object. The following operators are available:

  • KoshMCMC
  • KoshOneAtATimeEffects
  • KoshSensitivityPlots

Getting Started

To get the latest public version:

pip install llnl-ibis

To get the latest stable from a cloned repo, simply run:

pip install .

Alternatively, add the path to this repo to your PYTHONPATH environment variable or in your code with:

import sys
sys.path.append(path_to_ibis_repo)

Documentation

The documentation can be built from the docs directory using:

make html

Read the Docs coming soon.

Contact Info

IBIS maintainer can be reached at: olson59@llnl.gov

Contributing

Contributing to IBIS is relatively easy. Just send us a pull request. When you send your request, make develop the destination branch on the IBIS repository.

Your PR must pass IBIS's unit tests and documentation tests, and must be PEP 8 compliant. We enforce these guidelines with our CI process. To run these tests locally, and for helpful tips on git, see our Contribution Guide.

IBIS's develop branch has the latest contributions. Pull requests should target develop, and users who want the latest package versions, features, etc. can use develop.

Contributions should be submitted as a pull request pointing to the develop branch, and must pass IBIS's CI process; to run the same checks locally, use:

pytest tests/test_*.py

Releases

See our change log for more details.

Code of Conduct

Please note that IBIS has a Code of Conduct. By participating in the IBIS community, you agree to abide by its rules.

License

IBIS is distributed under the terms of the MIT license. All new contributions must be made under the MIT license. See LICENSE and NOTICE for details.

LLNL-CODE-838977

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

llnl_ibis-1.1.1.tar.gz (32.2 kB view details)

Uploaded Source

Built Distribution

llnl_ibis-1.1.1-py3-none-any.whl (34.7 kB view details)

Uploaded Python 3

File details

Details for the file llnl_ibis-1.1.1.tar.gz.

File metadata

  • Download URL: llnl_ibis-1.1.1.tar.gz
  • Upload date:
  • Size: 32.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.18

File hashes

Hashes for llnl_ibis-1.1.1.tar.gz
Algorithm Hash digest
SHA256 373d2b91bfaba8e077df1f7aeeec10002cbf901e43df0aad95c8fb4eca632368
MD5 d35e0d53c501689f3ef3a038c0c5adbb
BLAKE2b-256 a4ab646bbe585b7975516225eaaf7cfdc166df2f9360f3ec10fb3c811331d6ff

See more details on using hashes here.

File details

Details for the file llnl_ibis-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: llnl_ibis-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 34.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.18

File hashes

Hashes for llnl_ibis-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6152e8cbef6136428063d0ae08fe63f1d44a6b6fb40659809b4bbc1d6000ae07
MD5 8db073df5b1518bac53b2311554fed70
BLAKE2b-256 4ea837e4290abc2347f95a0ffdb4a71162553fc23b4e4c3c3bcaea7084c62949

See more details on using hashes here.

Supported by

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