Welcome to UQPyL documentation
UQPyL is a Python package for Uncertainty Quantification and Optimization of computational models and their associated problems (e.g., model calibration, resource scheduling, product design). It includes a wide range of methods and algorithms for Design of Experiments, Sensitivity Analysis, Optimization (Single- and Multi-objective). Additionally, Surrogate Models are built-in for solving computationally expensive problems.
🔗 Project Overview
- Website: Official Site (TODO: Needs update)
- Source Code: GitHub Repository
- PyPi Site: PyPi Site
- Documentation: ReadTheDocs
- Citation Infos: UQPyL 2.0(Future update), UQPyL 1.0
✨ Main Features
- Comprehensive Sensitivity Analysis and Optimization: Implements widely used sensitivity analysis methodologies and optimization algorithms.
- Running Display and Result Save: Enable users to timely track and save the history and results of their running.
- Advanced Surrogate Modeling: Integrates diverse surrogate models and auto-tunning tool to enhance these model performances.
- Rich Application Resources: Provides a comprehensive suite of benchmark problems and practical case studies, enabling users to get started quickly. (👉Recent Planing: For water science research, we plan to customize the interface to integrate water-related models with UQPyL, enhancing usability and functionality, like SWAT-UQ. So, if you have interest, please contact us to collaborate.).
- Modular and Extensible Architecture: Encourages and facilitates the development of novel methods or algorithms by users, aligning with our commitment to openness and collaboration. (We appreciate and welcome contributions)
⚙️ Installation
Recommended (PyPi or Conda):
pip install -U UQPyL
If you need plotting utilities:
pip install -U "UQPyL[viz]"
conda install UQPyL --upgrade
Alternatively:
git clone https://github.com/smasky/UQPyL.git
cd UQPyL
pip install .
For local installs with plotting support:
pip install ".[viz]"
🚀 Getting Started
⭐ UQ Project Series
- UQPyL, a Python package for Uncertainty Quantification and Parameter Optimization.
- SWAT-UQ, providing script-based (Develop) and GUI versions to integrate UQPyL and the Soil and Water Assessment Tool (SWAT) model.
