Skip to main content

Robust and nonlinear Direct Data-Driven MPC controllers for LTI and nonlinear systems in Python

Project description

Direct Data-Driven Model Predictive Control (MPC)

PyPi CI Workflow status Docs status codecov Ruff Python License: MIT

Robust Data-Driven MPC Nonlinear Data-Driven MPC
Robust Data-Driven MPC Animation Nonlinear Data-Driven MPC Animation
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.

📖 View the full project documentation on our documentation page.


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
      
    Verify the installation by running this command:
    ffmpeg -version
    

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:

  1. 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
    
  2. Create and activate a virtual environment:
    • Unix/macOS:
      python3 -m venv .venv && source .venv/bin/activate
      
    • Windows:
      python -m venv venv && venv\Scripts\activate
      
  3. 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 seed of 18, a simulation length of 400 steps, a verbosity level of 1, 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 seed of 0, a simulation length of 3000 steps, a verbosity level of 1, 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_anim flag 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/.

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
Robust Data-Driven MPC Animation Nonlinear Data-Driven MPC Animation
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 core logic of the Data-Driven MPC controllers within the following modules:

The utility module direct_data_driven_mpc/utilities/hankel_matrix_utils.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:

Controller Creation

To modularize the creation of Data-Driven MPC controllers, the following utility modules are provided:

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 provided 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.

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.

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 these 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{9109670,
  author={Berberich, Julian and Köhler, Johannes and Müller, Matthias A. and Allgöwer, Frank},
  journal={IEEE Transactions on Automatic Control},
  title={Data-Driven Model Predictive Control With Stability and Robustness Guarantees},
  year={2021},
  volume={66},
  number={4},
  pages={1702-1717},
  doi={10.1109/TAC.2020.3000182}}

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{9756053,
  author={Berberich, Julian and Köhler, Johannes and Müller, Matthias A. and Allgöwer, Frank},
  journal={IEEE Transactions on Automatic Control},
  title={Linear Tracking MPC for Nonlinear Systems—Part II: The Data-Driven Case},
  year={2022},
  volume={67},
  number={9},
  pages={4406-4421},
  doi={10.1109/TAC.2022.3166851}}

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

direct_data_driven_mpc-1.3.0.tar.gz (69.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

direct_data_driven_mpc-1.3.0-py3-none-any.whl (76.0 kB view details)

Uploaded Python 3

File details

Details for the file direct_data_driven_mpc-1.3.0.tar.gz.

File metadata

  • Download URL: direct_data_driven_mpc-1.3.0.tar.gz
  • Upload date:
  • Size: 69.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for direct_data_driven_mpc-1.3.0.tar.gz
Algorithm Hash digest
SHA256 e707fc0dc81e57c3eb2c7660573c71fea8526d5a0f8586f2412847edacd83ae3
MD5 bdd13af7be7bb86c576644b688f94488
BLAKE2b-256 4cff2cac8178050c9a854ca3012cc67090ae2bce04bbd246379656333d490da0

See more details on using hashes here.

Provenance

The following attestation bundles were made for direct_data_driven_mpc-1.3.0.tar.gz:

Publisher: release.yml on pavelacamposp/direct-data-driven-mpc

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file direct_data_driven_mpc-1.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for direct_data_driven_mpc-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c95965de0b77e59b2f183b2b68685af22cdbedb6ec8bde17d0aea031c89c9ea9
MD5 f7b15f4e96ca004021bdcdfee4109cc6
BLAKE2b-256 9bb4c7c1c6aa11987be09b9a67d8e634f8dc03352b14f482fa540e8ffe1211a9

See more details on using hashes here.

Provenance

The following attestation bundles were made for direct_data_driven_mpc-1.3.0-py3-none-any.whl:

Publisher: release.yml on pavelacamposp/direct-data-driven-mpc

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page