Getting started
Prerequisites
Python 3.10 or later is required.
Installation steps
pip install pycollimator
Optional dependencies
Nonlinear MPC blocks require IPOPT
to be preinstalled.
- On Ubuntu:
sudo apt install coinor-libipopt-dev
. - On macOS:
brew install ipopt
.
On macOS with Apple Silicon (M series), cmake
is also required to build and
install qdldl
and osqp
dependencies. Install it with brew install cmake
.
Install all optional dependencies with:
pip install pycollimator[all]
Tutorials
Read the Getting Started Tutorial
for a more complete example.
Documentation
Head over to https://py.collimator.ai for
the API reference documentation as well as examples and tutorials.
Licensed under AGPLv3
This package is released and licensed under the
AGPLv3 license.
Collimator, Inc reserves all rights to release
under a different license under a different license at any time, as well as all
rights to use the code in any way in their own commercial offerings.