Skip to content

Commit

Permalink
updated README and CI workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
ThoreWietzke committed Dec 11, 2023
1 parent 97b4d14 commit c3e9a6e
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 1 deletion.
3 changes: 2 additions & 1 deletion .github/workflows/pip.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ jobs:
strategy:
fail-fast: false
matrix:
os: [windows-latest, ubuntu-latest]
os: [windows-latest, macos-latest, ubuntu-latest]
python-version: ["3.8", "3.9", "3.10", "3.11"]

steps:
Expand All @@ -22,6 +22,7 @@ jobs:
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}

- name: Install dependencies
run: |
python -m pip install --upgrade pip
Expand Down
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,3 +94,22 @@ pip install "path to interface" --config-settings=cmake.build-type="DEBUG"
```
Then compile your C++ problem description in debug mode and use a suitable debugger.
Using the `Python C++ Debugger` extensions for VS Code is a reliable way to debug Python and C++ code.

## Citing

If you are using GRAMPC in your work, please cite
```
@Article{,
author = {Englert, Tobias and Völz, Andreas and Mesmer, Felix and Rhein, Sönke and Graichen, Knut},
title = {A software framework for embedded nonlinear model predictive control using a gradient-based augmented Lagrangian approach (GRAMPC)},
doi = {10.1007/s11081-018-9417-2},
issn = {1573-2924},
number = {3},
pages = {769--809},
url = {https://doi.org/10.1007/s11081-018-9417-2},
volume = {20},
journal = {Optimization and Engineering},
refid = {Englert2019},
year = {2019},
}
```

0 comments on commit c3e9a6e

Please sign in to comment.