File tree Expand file tree Collapse file tree 1 file changed +15
-11
lines changed
Expand file tree Collapse file tree 1 file changed +15
-11
lines changed Original file line number Diff line number Diff 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
1312cd tinympc-python
1413pip 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/ ) .
You can’t perform that action at this time.
0 commit comments