Conan.io recipe for casadi. Most CMake options are exposed as conan options and several of the plugin interface dependencies are managed with the help of conan packages. The exception is most of the non-free libraries, see Known recipe issues below.

The package is usually consumed using the conan install command or a conanfile.txt.

1. Add remote to conan's package remotes:

   $ conan remote add sintef https://artifactory.smd.sintef.no/artifactory/api/conan/conan-local

2. Using conanfile.txt in your project with cmake

   Add a conanfile.txt to your project. This file describes dependencies and your configuration of choice, e.g.:

   [requires]
   casadi/[>=3.5.5]@sintef/stable
   
   [options]
   casadi:shared=True
   casadi:lapack=True
   casadi:swig_python=True
   
   [imports]
   licenses, * -> ./licenses @ folder=True
   
   [generators]
   virtualenv
   virtualrunenv
   cmake_paths
   cmake_find_package
   

   Insert into your CMakeLists.txt something like the following lines:

   cmake_minimum_required(VERSION 3.13)
   project(TheProject CXX)
   
   include(${CMAKE_BINARY_DIR}/conan_paths.cmake)
   find_package(casadi CONFIG REQUIRED) # Note: do not use the incomplete MODULE variant
   
   add_executable(the_executor code.cpp)
   target_link_libraries(the_executor casadi::casadi)

   Then, do

   $ mkdir build && cd build
   $ conan install .. -s build_type=<build_type> --build missing

   where <build_type> is e.g. Debug or Release. You can now continue with the usual dance with cmake commands for configuration and compilation. For details on how to use conan, please consult Conan.io docs

3. Using casadi's python interface

   This recipe enables you to install casadi with desired plugins and use casadi's python interface from a virtual environment. Use the same conanfile.txt as described above and run for instance the following commands:

   $ mkdir casadi_env && cd casadi_env
   $ conan install .. --build missing -o casadi:swig_python=True -o casadi:clp=True
   $ source activate.sh # or on windows: activate.bat
   $ # on windows you may also need: activate_run.bat
   $ python

   You need to install python dependencies yourself, e.g. numpy.

   import casadi
   # you can now use casadi's clp interface

Most options in the casadi CMakeLists.txt are exposed as conan options. Many options have skipped the with_ prefix and it should be clear from the context what the option implies.

The with_common option enables lapack, qpoases, blocksqp, superscs, and ipopt, except on Windows with Visual Studio, where ipopt is not currently activated.

• Several managed dependencies only provide static libraries on Windows (MSVC). This does not work well with the dynamic plugin loading system of Casadi. As such, some options will not be available on Windows with this recipe.
• The recipe developer has not managed to compile some dependencies with dynamic libraries on windows.
• You may want to add the following option casadi:copysign_undef=True on windows.
• To build python interface on Windows, you need debug libraries of python installed.
• The options have not extensively been tested, and the recipe developer was unable to compile several of the optional interfaces on Windows using the Visual Studio compiler, including blasfeo and hpmpc.
• When a third-party plugin interface is enabled, we assume that its dependency is handled by conan, with the exception of slicot and those listed below. This may not be the desired behaviour, e.g. instead use system-provided packages. In the future we might add support for this behavior.
• Building octave/matlab interfaces requires special effort with respect to swig sources, which will not be handled by this recipe.

Plugin libraries that are not handled by this recipe are

• ampl
• cplex
• gurobi
• knitro
• ooqp
• snopt
• sqic
• worhp
• octave and matlab interfaces
• bonmin, but there are plans to add support