Skip to content

API reference

Complete reference for all public classes and functions in idmtools_calibra.

Package map

Module Description
Core CalibManager, CalibSite, RMSESiteSingleChannel, IterationState, ResumeManager
Algorithms Sampling algorithms: OptimTool, IMIS, GPC, SPSA, PSPO, PBNB
Analyzers Simulation output analyzers: BaseCalibrationAnalyzer, RMSEAnalyzer
Plotters Diagnostic visualization: BasePlotter and algorithm-specific subclasses
Output Spatial output utilities

Typical import pattern

1
2
3
4
5
6
from idmtools_calibra.calib_manager import CalibManager
from idmtools_calibra.calib_site import CalibSite
from idmtools_calibra.rmse_site import RMSESiteSingleChannel
from idmtools_calibra.algorithms.optim_tool import OptimTool
from idmtools_calibra.analyzers.rmse_analyzer import RMSEAnalyzer
from idmtools_calibra.plotters.likelihood_plotter import LikelihoodPlotter

Calibration flow

1
2
3
4
5
6
7
CalibManager.run_calibration()
  ├── NextPointAlgorithm.get_samples_for_iteration()   # sample parameter space
  ├── map_sample_to_model_input_fn()                   # configure simulation task
  ├── ExperimentManager (idmtools)                     # run simulations on platform
  ├── BaseCalibrationAnalyzer                          # score each simulation
  ├── NextPointAlgorithm.set_results_for_iteration()   # algorithm updates state
  └── BasePlotter.visualize()                          # diagnostic plots

Each iteration's state is saved to Calibration.json for resume support.