API Reference

Find below a table of all do-mpc modules. Classes and functions of each module are shown on their respective page.

Core modules

The core modules are used to create the do-mpc control loop (click on elements to open documentation page):

digraph G { graph [fontname = "Monaco"]; node [fontname = "Monaco", fontcolor="#404040", color="#bdbdbd"]; edge [fontname = "Monaco", color="#707070"]; Model [label="Model", href="../api/do_mpc.model.Model.html#model", target="_top", shape=box, style=filled] MPC [href="../api/do_mpc.controller.MPC.html#mpc", target="_top", shape=box, style=filled] Simulator [href="../api/do_mpc.simulator.Simulator.html#simulator", target="_top", shape=box, style=filled] MHE [href="../api/do_mpc.estimator.MHE.html#mhe", target="_top", shape=box, style=filled] Data_MPC [label="MPCData", href="../api/do_mpc.data.MPCData.html#mpcdata", target="_top", shape=box, style=filled] Data_Sim [label="Data", href="../api/do_mpc.data.Data.html#data", target="_top", shape=box, style=filled] Data_MHE [label="Data", href="../api/do_mpc.data.Data.html#data", target="_top", shape=box, style=filled] Graphics [label="Graphics", href="../api/do_mpc.graphics.Graphics.html#graphics", target="_top", shape=box, style=filled] Model -> MPC; Model -> Simulator; Model -> MHE; Model [shape=box, style=filled] subgraph cluster_loop {{ rankdir=TB; rank=same; MPC -> Simulator [label="inputs"]; Simulator -> MHE [label="meas."]; MHE -> MPC [label="states"]; }} MPC -> Data_MPC; Simulator -> Data_Sim; MHE -> Data_MHE; Data_MPC -> Graphics; Data_Sim -> Graphics; Data_MHE -> Graphics; }

do-mpc control loop and interconnection of classes.

model
simulator
optimizer
controller
estimator
data
graphics

Sampling tools

samplingplanner
sampler
datahandler

For a quick introduction of the do-mpc sampling tools we are providing this video tutorial: