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 Documentation

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.

text
Problem / ModelProblem -> Method -> Result

Start Here

GoalRead
Run the shortest complete workflowQuick Start
Understand the shared modeling protocolProblem
Find complete workflow examplesExamples
Look up classes, parameters, and result objectsAPI Reference

Choose a Workflow

TaskModule GuideAPI
Define input spaces, objectives, constraints, simulations, and evaluation outputsProblemProblem API
Generate design samples for experiments, analysis, initialization, or modelingDesign of ExperimentDOE API
Analyze how inputs affect model or objective outputsAnalysisAnalysis API
Search for single-objective, multi-objective, or expensive-model optimaOptimizationOptimization API
Run MCMC-style parameter inferenceInferenceInference API
Calibrate simulation models against observationsCalibrationCalibration API
Train predictive surrogate modelsSurrogate ModelingSurrogate API
  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

ConceptWhere
ProblemStatic objective and constraint problems. See Problem.
ModelProblemSimulation models with observations, masks, and simulation context. See Problem.
EvalStandard output object from problem.evaluate(). See Problem API.
Result objectsModule-specific outputs such as AnaResult, OptResult, InfResult, and CalResult. See API Reference.
Saved runsRuntime sqlite readers such as AnaReader, OptReader, InfReader, and CalReader. See each API page.

API Reference

The API reference is split by module.

ModuleAPI Page
UQPyL.problemProblem API
UQPyL.doeDOE API
UQPyL.analysisAnalysis API
UQPyL.optimizationOptimization API
UQPyL.inferenceInference API
UQPyL.calibrationCalibration API
UQPyL.surrogateSurrogate API

Project Notes

PagePurpose
ChangelogUser-facing changes across releases.