using_roadrunner_from_cxx.rst

Using RoadRunner from C++

Despite RoadRunner's user interface being primarily in Python, RoadRunner is first and foremost a C++ library. It is therefore is possible to link roadrunner into an executable or library.

Note

You will need to have already installed RoadRunner into a directory on your system. See Installing RoadRunner section.

Note

You will also need to install cmake and add its "bin" directory to the PATH environment variable. You will know this is done if the command cmake --help works on the terminal/powershell.

The following is a very simple example of how to link roadrunner into an executable and run a simulation from C++. Create a new folder with whatever name seems appropriate and create the following files:

.
├── CMakeLists.txt
└── main.cpp

The CMakeLists.txt file should contain the following:

CMakeLists.txt

Now you can use RoadRunner from C++.

main.cpp