A library to assemble OCPs from modules
Reason this release was yanked:
missing pre-release flag
Project description
ocp-modules
This library provides a set of modules to assemble optimal control problems (OCPs) by generating
symbolic expressions based on CasADi <https://web.casadi.org/>
. The documentation is generated
via Sphinx and can be found here <docs/build/html/index.html>
.
Installation
For Users
ocp-modules is (SOON) available via `pip`:
.. code-block:: bash
pip3 install --user ocp-modules
For Developers
-
Install :code:
setuptools
and :code:virtualenv
:.. code-block:: bash
pip3 install --user setuptools virtualenv
-
Create a new virtual environment in the folder
venv
and source it:.. code-block:: bash
git clone <this_repo> cd <this_repo> python3 -m virtualenv venc source ./venv/bin/activate
-
Install ocp-modules via symlink into the virtual environment
.. code-block:: bash
cd <this_repo> pip3 install -e .
A note regarding CasADi
Casadi can make use of proprietary solvers such as
`HSL MA57 <http://www.hsl.rl.ac.uk/catalogue/ma57.html>`_. Follow the instructions
`here <https://github.com/casadi/casadi/wiki/Obtaining-HSL>`_ to install them and modify the solver
options to use the built-in default.
Common issues with HSL solvers:
* Cannot find :code:`libhsl.so`. In this case, manually create a symlink :code:`libcoinhsl.so` ->
:code:`libhsl.so` in :code:`/usr/lib`
* Failed to load :code:`libmetis.so`: It is hard to get a working instance of metis (the version packaged
in Ubuntu 18.04 is not compatible). It seems to work without, but spams into stdout.
Running the examples
--------------------
Run examples via:
.. code-block:: bash
./examples/<folder>/<script>.py
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 Distribution
ocp-modules-0.1.0.tar.gz
(15.0 kB
view hashes)
Built Distribution
Close
Hashes for ocp_modules-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 895472c166e7188bec13694908fae0045b7ba387724b1727d852c1e71deaeff7 |
|
MD5 | 9900a3f396b63a8e295974f7cd1f0ea8 |
|
BLAKE2b-256 | 2c26abe29ef29d92f39c9323fe71e243be6258a5b2e4cb1c3219543afa85031a |