User Guide

UQPyL Documentation

UQPyL provides a shared problem protocol and a set of uncertainty quantification workflows for sampling, sensitivity analysis, optimization, inference, calibration, and surrogate modeling.

UQPyL Team · May 10, 2026 · 5 min read

UQPyL provides a shared problem protocol and a set of uncertainty quantification workflows for sampling, sensitivity analysis, optimization, inference, calibration, and surrogate modeling.

Most workflows start with a Problem or ModelProblem, then pass that object into one or more functional modules.

Problem / ModelProblem -> Method -> Result

Start Here

Goal	Read
Run the shortest complete workflow	Quick Start
Understand the shared modeling protocol	Problem
Find complete workflow examples	Examples
Look up classes, parameters, and result objects	API Reference

Choose a Workflow

Task	Module Guide	API
Define input spaces, objectives, constraints, simulations, and evaluation outputs	Problem	Problem API
Generate design samples for experiments, analysis, initialization, or modeling	Design of Experiment	DOE API
Analyze how inputs affect model or objective outputs	Analysis	Analysis API
Search for single-objective, multi-objective, or expensive-model optima	Optimization	Optimization API
Run MCMC-style parameter inference	Inference	Inference API
Calibrate simulation models against observations	Calibration	Calibration API
Train predictive surrogate models	Surrogate Modeling	Surrogate API

Recommended Learning Path

1. Read Quick Start to see the main workflow shape. 2. Read Problem before using any functional module. 3. Pick one task guide from the workflow table. 4. Use API Reference when you need constructor parameters, return fields, or reader classes. 5. Use Examples for end-to-end patterns.

Core Concepts

Concept	Where
`Problem`	Static objective and constraint problems. See Problem.
`ModelProblem`	Simulation models with observations, masks, and simulation context. See Problem.
`Eval`	Standard output object from `problem.evaluate()`. See Problem API.
Result objects	Module-specific outputs such as `AnaResult`, `OptResult`, `InfResult`, and `CalResult`. See API Reference.
Saved runs	Runtime sqlite readers such as `AnaReader`, `OptReader`, `InfReader`, and `CalReader`. See each API page.

API Reference

The API reference is split by module.

Module	API Page
`UQPyL.problem`	Problem API
`UQPyL.doe`	DOE API
`UQPyL.analysis`	Analysis API
`UQPyL.optimization`	Optimization API
`UQPyL.inference`	Inference API
`UQPyL.calibration`	Calibration API
`UQPyL.surrogate`	Surrogate API

Project Notes

Page	Purpose
Changelog	User-facing changes across releases.