https://github.com/control-toolbox/bocop
Bocop 3
https://github.com/control-toolbox/bocop
Last synced: 21 days ago
JSON representation
Bocop 3
- Host: GitHub
- URL: https://github.com/control-toolbox/bocop
- Owner: control-toolbox
- Created: 2023-03-15T14:17:00.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-06T13:57:45.000Z (over 2 years ago)
- Last Synced: 2025-12-26T05:05:32.602Z (5 months ago)
- Language: C++
- Size: 1.23 MB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Bocop3 - optimal control toolbox (direct transcription approach)
[gh-ci-img]: https://github.com/control-toolbox/bocop.jl/actions/workflows/ci_linux.yml/badge.svg?branch=main
[gh-ci-url]: https://github.com/control-toolbox/bocop.jl/actions/workflows/ci_linux.yml?query=branch%3Amain
## Panel application
Try the code online with the provided demos or your own problem with the [Bocop wep app](http://control-toolbox.inria.fr/bocop-panel) (no installation required)
## User install
### [Windows Installation Guide](./bocop/README_WINDOWS.md)
### [macOS Installation Guide](./bocop/README_MACOS.md)
### [Linux and WSL Installation Guide](./bocop/README_LINUX.md)
## Developper install
Before developing, you should try to install bocop as user, so that you have our usual tools to run bocop. Refer to the abovementioned installation guides.
Regarding conda, the miniconda install is enough, although we recommend to use the much faster mamba instead, for instance with the mambaforge install.
In short, you should have:
- on Windows: Microsoft Build Tools, conda/mamba, git (go to [the Git Website](https://git-scm.com) to get you started)
- on macOS: *maybe XCode*, conda/mamba, git (it should be installed with XCode anyway)
- on Linux: conda/mamba, git
Alternatively you can install git on any OS using conda with `conda install git` (but in this case, remember it will be tied to the conda environment where you install it.)
You should then clone the environment, create the conda environment for development and check if the tests are running correctly:
```bash
git clone https://github.com/control-toolbox/bocop
cd bocop
mamba env create -f pkg/env/bocop-linux.yaml ## or bocop-windows.yaml or bocop-macos.yaml
mamba activate bocop-dev
python test_bocop.py 1 ## check that the tests are running
```
Then you can use:
- **jupyter** `jupyter notebook bocop/notebook_test.ipynb`
- **jupyter lab**
```
jupyter labextension install @jupyter-widgets/jupyterlab-manager
jupyter-lab bocop/notebook_test.ipynb
```
## Documentation
Into folder doc/, run Doxygen
```
doxygen
```
which will generate the doxygen files in `html/` and `xml/` (used for sphinx import).
Then run Sphinx with Breathe extension to import the `xml/ files from doxygen
```
make html
```
which will put the `sphinx-rtd` files in `_build/html`.