Skip to content

Commit 32d3861

Browse files
clean up README.md
1 parent df7f781 commit 32d3861

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

README.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,32 @@ Python wrapper for [TinyMPC](https://tinympc.org/).
33
## Installation
44

55
```bash
6-
pip install tinympc
6+
pip install tinympc
77
```
88

9-
10-
For development installation:
9+
For development installation (optional):
1110
```bash
12-
git clone --recursive https://github.com/TinyMPC/tinympc-python.git
11+
git clone https://github.com/TinyMPC/tinympc-python.git
1312
cd tinympc-python
1413
pip install -e .
1514
```
1615

1716
## Examples
1817

19-
The `examples/` directory contains:
20-
- `cartpole_example_one_solve.py`
21-
- `cartpole_example_mpc_constrained.py`
22-
- `cartpole_example_mpc.py`
23-
- `cartpole_example_code_generation.py`
24-
- `quadrotor_hover_code_generation.py` - For online hyperparameter tuning of rho set ```ENABLE_ADAPTIVE_RHO``` to ```True```
18+
The `examples/` directory contains several demonstration files:
19+
20+
### Basic Examples
21+
- `cartpole_example_one_solve.py` - Single solve for cartpole problem
22+
- `cartpole_example_mpc.py` - MPC implementation for cartpole
23+
- `cartpole_example_mpc_constrained.py` - MPC with constraints
2524

25+
### Code Generation Examples
26+
*Note: Quadrotor Code generation examples require autograd: `pip install autograd`*
2627

28+
- `cartpole_example_code_generation.py` - Code generation for cartpole
29+
- `quadrotor_hover_code_generation.py` - Code generation for quadrotor hover
30+
- For online hyperparameter tuning, set `ENABLE_ADAPTIVE_RHO = True` in the file
2731

2832
## Documentation
2933

30-
Documentation and examples can be found [here](https://tinympc.org/get-started/installation/).
34+
Documentation and examples can be found [here](https://tinympc.org/get-started/installation/).

0 commit comments

Comments
 (0)