Uncertainty API (1.0.0)

The Uncertainty API exposes the ensembles, realizations, and per-realization results that FDPlan produces when a scenario or virtual scenario is evaluated.

A study's uncertainty method controls how realizations are produced for each ensemble. With MonteCarlo, realizations are created automatically by Monte Carlo sampling of the input data sources, and the study's number of realizations controls how many are generated per scenario. With Deterministic, you provide the outcomes directly in the input data sources and choose which realizations to evaluate, for example a curated set of P10, P50, and P90 cases from an external domain study. Evaluation results are then presented as a range of outcomes that you can use to interpret uncertainty in the key performance indicators (KPIs) of decision alternatives.

An ensemble is a collection of realizations produced for a single scenario or virtual scenario, scoped to a version of a workflow specification. Each realization pins one container reference per workflow-specification node so that downstream computations and visualizations read deterministic inputs and outputs.

Use this API to retrieve an ensemble and its realizations, update an ensemble, read the per-realization indicator values produced by an evaluation, and read the computation-event log of a single realization.