Collimator.ai core simulation engine and API client
Project description
Getting started
Prerequisites
Python 3.10 or later is required.
collimator
has been developed and tested on Linux (Ubuntu 22+) and macOS.
Native Windows support has not been tested at this time but may work. We recommend using the Windows Subsystem for Linux with an Ubuntu distribution instead.
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for pycollimator-2.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 395cdf609f2940722112d1bb7f9942c3a20413263bf10b7c021cbba67722b84c |
|
MD5 | 511c96314af4bc2a51c2a9832c00097d |
|
BLAKE2b-256 | be7c85fbb25838514c7e19428f41badc871a6f2ddac8b9af4ab3985bdf0d2b59 |