Skip to content

Commit e28e76b

Browse files
Fix typos and update venv installation instructions (#32)
* Fix typos in `README.md` and controller docstrings * Use `.venv` as virtual env for Unix/macOS in `README.md` Update the virtual environment creation command for Unix/macOS to use `.venv`, as it is the standard name for virtual environments on those operating systems.
1 parent e757d8b commit e28e76b

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ Follow these steps to create a virtual environment and install this package:
8484
3. Create a virtual environment in the project directory:
8585
- Unix/macOS:
8686
```bash
87-
python3 -m venv venv
87+
python3 -m venv .venv
8888
```
8989
- Windows:
9090
```cmd
@@ -115,7 +115,7 @@ Follow these steps to create a virtual environment and install this package:
115115
> ```
116116
117117
## Usage
118-
The example scripts [`lti_dd_mpc_example.py`](examples/lti_control/lti_dd_mpc_example.py) and [`nonlinear_dd_mpc_example.py`](examples/nonlinear_control/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.
118+
The example scripts [`lti_dd_mpc_example.py`](examples/lti_control/lti_dd_mpc_example.py) and [`nonlinear_dd_mpc_example.py`](examples/nonlinear_control/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.
119119
120120
To run the example scripts, use the following commands:
121121

direct_data_driven_mpc/lti_data_driven_mpc_controller.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -556,7 +556,7 @@ def define_mpc_constraints(self) -> None:
556556
input-output pair (`u_s`, `y_s`) in any minimal realization (last
557557
`n` input-output predictions, as considered in [1]). Defined by
558558
Equations (3d) (Nominal) and (6c) (Robust).
559-
- **Input**: Constraints the predicted input (`ubar`). Defined by
559+
- **Input**: Constrains the predicted input (`ubar`). Defined by
560560
Equation (6c).
561561
- **Slack Variable**: Bounds a slack variable that accounts
562562
for noisy online measurements and for noisy data used for

direct_data_driven_mpc/nonlinear_data_driven_mpc_controller.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -823,7 +823,7 @@ def define_mpc_constraints(self) -> None:
823823
input-output equilibrium pair (predicted equilibrium setpoints
824824
`u_s`, `y_s`) in any minimal realization (last `n` input-output
825825
predictions, as considered in [2]). Defined by Equation (22d).
826-
- **Input**: Constraints both the equilibrium input (predicted input
826+
- **Input**: Constrains both the equilibrium input (predicted input
827827
setpoint `u_s`) and the input trajectory (`ubar`). Defined by
828828
Equation (22e).
829829
@@ -946,8 +946,8 @@ def define_terminal_state_constraints(self) -> list[cp.Constraint]:
946946
References:
947947
[2]: See class-level docstring for full reference details.
948948
"""
949-
# Define terminal state constraints for Nominal and Robust MPC
950-
# based on Equation (3d) and Equation (6c) of [2], respectively.
949+
# Define terminal state constraints for the
950+
# Nonlinear MPC based on Equation (22d) of [2]
951951
terminal_constraints = [
952952
cp.vstack([self.ubar_terminal, self.ybar_terminal])
953953
== cp.vstack(

0 commit comments

Comments
 (0)