Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
maxschaller committed Oct 13, 2023
1 parent b1d7280 commit 7125087
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ under the [GNU General Public License v3.0](https://github.com/embotech/ecos/blo
pip install ipykernel jupyter matplotlib
ipython kernel install --user --name=cvxpygen
```

If you wish to use the `Clarabel` solver, you need to install [`Rust`](https://www.rust-lang.org/tools/install) and [`Eigen`](https://github.com/oxfordcontrol/Clarabel.cpp#installation).

## Example

Expand Down Expand Up @@ -98,6 +100,7 @@ Next to the positional argument `problem`, all keyword arguments for the `genera
| ------------- | ------------- | ------------- | ------------- |
| `code_dir` | directory for code to be stored in | String | `'CPG_code'` |
| `solver` | canonical solver to generate code with | String | CVXPY default |
| `solver_opts` | options passed to canonical solver | Dict | `None` |
| `enable_settings`| enabled settings that are otherwise locked by embedded solver | List of Strings | `[]` |
| `unroll` | unroll loops in canonicalization code | Bool | `False` |
| `prefix` | prefix for unique code symbols when dealing with multiple problems | String | `''` |
Expand Down

0 comments on commit 7125087

Please sign in to comment.