Robust and nonlinear Direct Data-Driven MPC controllers for LTI and nonlinear systems in Python
Project description
Direct Data-Driven Model Predictive Control (MPC)
| Robust Data-Driven MPC | Nonlinear Data-Driven MPC |
|---|---|
| Robust controller applied to an LTI system. | Nonlinear controller applied to a Nonlinear system. |
This repository provides a Python implementation of Direct Data-Driven Model Predictive Control (MPC) controllers for Linear Time-Invariant (LTI) and Nonlinear systems using CVXPY. It includes robust and nonlinear controllers implemented based on the Data-Driven MPC schemes presented in the papers "Data-Driven Model Predictive Control With Stability and Robustness Guarantees" and "Linear Tracking MPC for Nonlinear Systems—Part II: The Data-Driven Case" by J. Berberich et al.
A direct data-driven controller maps measured input-output data from an unknown system directly onto the controller without requiring an explicit system identification step. This approach is particularly useful in applications where the system dynamics are too complex to be modeled accurately or where traditional system identification methods are impractical or difficult to apply.
Disclaimer: This is an independent project based on the referenced papers and does not contain the official implementations from the authors.
Table of Contents
Requirements
This package requires the following:
- Python (>=3.10, <3.13). Python 3.13 is not fully supported, as some dependencies have not been compiled for this version yet. We recommend using Python 3.10 to 3.12.
- FFmpeg: Required for saving animations (e.g., GIF or MP4).
- On Windows: You can download FFmpeg from the official FFmpeg website. Ensure it's correctly added to your system's
PATH. - On Unix: You can install it using your package manager. For Debian/Ubuntu:
sudo apt install ffmpeg
ffmpeg -version - On Windows: You can download FFmpeg from the official FFmpeg website. Ensure it's correctly added to your system's
Installation
Install direct-data-driven-mpc via PyPI:
pip install direct-data-driven-mpc
Note: We recommend using a virtual environment to install this package, although it is not required.
For Contributors:
If you plan to contribute to or develop the project, follow these steps to set up a local development environment:
- Clone the repository and navigate to the project directory:
git clone https://github.com/pavelacamposp/direct-data-driven-mpc.git && cd direct-data-driven-mpc
- Create and activate a virtual environment:
- Unix/macOS:
python3 -m venv .venv && source .venv/bin/activate
- Windows:
python -m venv venv && venv\Scripts\activate
- Unix/macOS:
- Install the package with development dependencies:
pip install -e ".[dev]"
This will install tools like pre-commit and mypy. To enable automatic checks before each commit using pre-commit hooks, run:
pre-commit install
Usage
The example scripts lti_dd_mpc_example.py and nonlinear_dd_mpc_example.py demonstrate the setup, simulation, and data visualization of the Data-Driven MPC controllers applied to LTI and Nonlinear systems, respectively.
To run the example scripts, use the following commands:
-
Data-Driven MPC for LTI systems:
Run the example script with a
seedof18, a simulation length of400steps, a verbosity level of1, and save the generated animation to a file:python examples/lti_control/lti_dd_mpc_example.py --seed 18 --t_sim 400 --verbose 1 --save_anim
-
Data-Driven MPC for Nonlinear systems:
Run the example script with a
seedof0, a simulation length of3000steps, a verbosity level of1, and save the generated animation to a file:python examples/nonlinear_control/nonlinear_dd_mpc_example.py --seed 0 --t_sim 3000 --verbose 1 --save_anim
[!NOTE] The
--save_animflag requires FFmpeg to be installed. See the Requirements section for more details.
Customizing Controller Parameters
To use different controller parameters, modify the configuration files in examples/config/controllers/ for each controller, or specify a custom configuration file using the --controller_config_path argument.
Customizing System Models
Example system parameters are defined in examples/config/models/.
- LTI system: Parameters can be modified directly in
four_tank_system_params.yaml. - Nonlinear system: The system dynamics are defined in
nonlinear_cstr_model.pyand its parameters innonlinear_cstr_system_params.yaml.
Customizing Plots
Matplotlib properties for input-output plots can be customized by modifying plot_params.yaml.
Additional Information
Some key arguments used in the scripts are listed below:
| Argument | Type | Description |
|---|---|---|
--controller_config_path |
str |
Path to the YAML file containing Data-Driven MPC controller parameters. |
--t_sim |
int |
Simulation length in time steps. |
--save_anim |
flag |
If passed, saves the generated animation to a file using FFmpeg. |
--anim_path |
str |
Path where the generated animation file will be saved. Includes the file name and its extension (e.g., data-driven_mpc_sim.gif). |
--verbose |
int |
Verbosity level: 0 = no output, 1 = minimal output, 2 = detailed output. |
To get the full list of arguments, run each script with the --help flag.
For a deeper understanding of the project and how the controllers operate, we recommend reading through the scripts and the docstrings of the implemented utility functions and classes. The documentation includes detailed descriptions of how the implementations follow the Data-Driven MPC controller schemes and algorithms described in the referenced papers.
Paper Reproduction
Reproduction scripts are provided to validate our implementations by comparing them with the results presented in the referenced papers.
-
Data-Driven MPC for LTI systems:
The reproduction is implemented in
robust_lti_dd_mpc_reproduction.py. This script closely follows the example presented in Section V of [1], which demonstrates various Robust Data-Driven MPC controller schemes applied to a four-tank system model.To run the script, execute the following command:
python examples/lti_control/robust_lti_dd_mpc_reproduction.py -
Data-Driven MPC for Nonlinear systems:
The reproduction is included in the example script
nonlinear_dd_mpc_example.py, which closely follows the example presented in Section V of [2] for the control of a nonlinear continuous stirred tank reactor (CSTR) system.To run the script, execute the following command:
python examples/nonlinear_control/nonlinear_dd_mpc_example.py --seed 0
The figures below show the expected output from executing these scripts. The graphs from our results closely resemble those shown in Fig. 2 of [1] and Fig. 2 of [2], with minor differences due to randomization.
| LTI Data-Driven MPC | Nonlinear Data-Driven MPC |
|---|---|
| Reproduction of results from [1] | Reproduction of results from [2] |
Code Structure
Direct Data-Driven MPC Controller
The project is structured as a Python package, encapsulating the main Data-Driven MPC controllers logic within the following modules:
direct_data_driven_mpc/lti_data_driven_mpc_controller.py: Implements a Data-Driven MPC controller for LTI systems in theLTIDataDrivenMPCControllerclass. This implementation is based on the Nominal and Robust Data-Driven MPC schemes described in [1].direct_data_driven_mpc/nonlinear_data_driven_mpc_controller.py: Implements a Data-Driven MPC controller for Nonlinear systems in theNonlinearDataDrivenMPCControllerclass. This implementation is based on the Nonlinear Data-Driven MPC scheme described in [2].
The utility module direct_data_driven_mpc/utilities/hankel_matrix.py is used for constructing Hankel matrices and evaluating whether data sequences are persistently exciting of a given order.
Model Simulation
The following utility modules have been implemented to simulate LTI and Nonlinear systems:
direct_data_driven_mpc/utilities/models/lti_model.py: Implements theLTIModelandLTISystemModelclasses for simulating LTI systems.direct_data_driven_mpc/utilities/models/nonlinear_model.py: Implements theNonlinearSystemclass for simulating Nonlinear systems.
Controller Creation
To modularize the creation of Data-Driven MPC controllers, the following utility modules are provided:
direct_data_driven_mpc/utilities/controller/controller_params.py: Provides functions for loading Data-Driven MPC controller parameters from YAML configuration files for both LTI and Nonlinear controllers.direct_data_driven_mpc/utilities/controller/controller_creation.py: Provides functions for creating Data-Driven MPC controller instances from specified configuration parameters for both LTI and Nonlinear controllers.
Data-Driven Controller Simulation
The direct_data_driven_mpc/utilities/controller/data_driven_mpc_sim.py module implements the main control loops for both Data-Driven MPC controllers, following Algorithms 1 and 2 of [1] for LTI systems and Algorithm 1 of [2] for Nonlinear systems.
Visualization (Static and Animated Plots)
Custom functions are implemented in direct_data_driven_mpc/utilities/visualization/ to display input-output data in static and animated plots. These functions use Matplotlib for visualization and FFmpeg for saving animations in various formats (e.g., GIF, MP4).
Examples
The examples directory contains scripts that demonstrate the operation of the Data-Driven MPC controller and reproduce the results presented in the referenced papers.
examples/lti_control/lti_dd_mpc_example.py: Demonstrates the setup, simulation, and data visualization of a Data-Driven MPC controller applied to an LTI system.examples/lti_control/robust_lti_dd_mpc_reproduction.py: Implements a reproduction of the example presented in [1], showing various Robust Data-Driven MPC schemes applied to an LTI system.examples/nonlinear_control/nonlinear_dd_mpc_example.py: Demonstrates the setup, simulation, and data visualization of a Data-Driven MPC controller applied to a Nonlinear system while closely following the example presented in [2].
Configuration Files
The system and controller parameters used in the example scripts are defined in YAML configuration files in examples/config/. These parameters are based on the examples from Section V of [1] for LTI systems, and from Section V of [2] for Nonlinear systems.
- Data-Driven MPC controllers:
examples/config/controllers/lti_dd_mpc_example_params.yaml: Defines parameters for a Data-Driven MPC controller designed for LTI systems.examples/config/controllers/nonlinear_dd_mpc_example_params.yaml: Defines parameters for a Data-Driven MPC controller designed for Nonlinear systems.
- Models:
examples/config/models/four_tank_system_params.yaml: Defines system model parameters for a linearized version of a four-tank system.examples/config/models/nonlinear_cstr_system_params.yaml: Defines system model parameters for a nonlinear continuous stirred tank reactor (CSTR) system.
- Plots:
examples/config/plots/plot_params.yaml: Defines Matplotlib properties of lines, legends, and figures for input-output plots.
A YAML loading function is provided in direct_data_driven_mpc/utilities/yaml_config_loading.py.
License
This project is licensed under the MIT License. See the LICENSE file for details.
Citation
If you use the controller implementations in your research, please cite the original papers:
Data-Driven MPC Control for Linear Time-Invariant (LTI) systems
[1] J. Berberich, J. Köhler, M. A. Müller and F. Allgöwer, "Data-Driven Model Predictive Control With Stability and Robustness Guarantees," in IEEE Transactions on Automatic Control, vol. 66, no. 4, pp. 1702-1717, April 2021, doi: 10.1109/TAC.2020.3000182.
BibTex entry:
@article{Berberich_2021,
title={Data-Driven Model Predictive Control With Stability and Robustness Guarantees},
volume={66},
ISSN={2334-3303},
url={http://dx.doi.org/10.1109/TAC.2020.3000182},
DOI={10.1109/tac.2020.3000182},
number={4},
journal={IEEE Transactions on Automatic Control},
publisher={Institute of Electrical and Electronics Engineers (IEEE)},
author={Berberich, Julian and Kohler, Johannes and Muller, Matthias A. and Allgower, Frank},
year={2021},
month=apr, pages={1702–1717}}
Data-Driven MPC Control for Nonlinear systems
[2] J. Berberich, J. Köhler, M. A. Müller and F. Allgöwer, "Linear Tracking MPC for Nonlinear Systems—Part II: The Data-Driven Case," in IEEE Transactions on Automatic Control, vol. 67, no. 9, pp. 4406-4421, Sept. 2022, doi: 10.1109/TAC.2022.3166851.
BibTex entry:
@article{Berberich_2022,
title={Linear Tracking MPC for Nonlinear Systems—Part II: The Data-Driven Case},
volume={67},
ISSN={2334-3303},
url={http://dx.doi.org/10.1109/TAC.2022.3166851},
DOI={10.1109/tac.2022.3166851},
number={9},
journal={IEEE Transactions on Automatic Control},
publisher={Institute of Electrical and Electronics Engineers (IEEE)},
author={Berberich, Julian and Kohler, Johannes and Muller, Matthias A. and Allgower, Frank},
year={2022},
month=sep, pages={4406–4421} }
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file direct_data_driven_mpc-1.2.1.tar.gz.
File metadata
- Download URL: direct_data_driven_mpc-1.2.1.tar.gz
- Upload date:
- Size: 66.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
eb0f92253db600c8ba6db491d25c4542bf05e76b87cc110dca7f2d41510c80e4
|
|
| MD5 |
0bf354fdd109ced8a30d01c928416b7f
|
|
| BLAKE2b-256 |
99820cd7c2091ce88c3748deb9b3bd56f660cd0fa51c5b1d8741d66a882ff05a
|
Provenance
The following attestation bundles were made for direct_data_driven_mpc-1.2.1.tar.gz:
Publisher:
release.yml on pavelacamposp/direct-data-driven-mpc
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
direct_data_driven_mpc-1.2.1.tar.gz -
Subject digest:
eb0f92253db600c8ba6db491d25c4542bf05e76b87cc110dca7f2d41510c80e4 - Sigstore transparency entry: 264880070
- Sigstore integration time:
-
Permalink:
pavelacamposp/direct-data-driven-mpc@a30f915038cc0d2fbe8f1a4c82553241971f7302 -
Branch / Tag:
refs/tags/1.2.1 - Owner: https://github.com/pavelacamposp
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@a30f915038cc0d2fbe8f1a4c82553241971f7302 -
Trigger Event:
push
-
Statement type:
File details
Details for the file direct_data_driven_mpc-1.2.1-py3-none-any.whl.
File metadata
- Download URL: direct_data_driven_mpc-1.2.1-py3-none-any.whl
- Upload date:
- Size: 72.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4eefafca7776ccd6ee12703c6eb8e22836b0a9cbfc393dcde7aef8bdc8f6a2d5
|
|
| MD5 |
ed0ff3946f6c10f12b8ffe4c6c483fb5
|
|
| BLAKE2b-256 |
da3f683df94302c2e21cee981b69f9d5d1ab776781c05c29ed4ff408f971426f
|
Provenance
The following attestation bundles were made for direct_data_driven_mpc-1.2.1-py3-none-any.whl:
Publisher:
release.yml on pavelacamposp/direct-data-driven-mpc
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
direct_data_driven_mpc-1.2.1-py3-none-any.whl -
Subject digest:
4eefafca7776ccd6ee12703c6eb8e22836b0a9cbfc393dcde7aef8bdc8f6a2d5 - Sigstore transparency entry: 264880073
- Sigstore integration time:
-
Permalink:
pavelacamposp/direct-data-driven-mpc@a30f915038cc0d2fbe8f1a4c82553241971f7302 -
Branch / Tag:
refs/tags/1.2.1 - Owner: https://github.com/pavelacamposp
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@a30f915038cc0d2fbe8f1a4c82553241971f7302 -
Trigger Event:
push
-
Statement type: