Installation Guide

Python

Linux and macOS

The easiest way to install RCR into Python is with pip:

python3 -m pip3 install rcr

That’s it; you’re good to go from here!

Windows

Before installing, you’ll need to have Microsoft Visual C++ 14.0, found under the Microsoft Visual C++ Build Tools. If that doesn’t work, you may need the latest Windows SDK. (Both can be installed through the Visual Studio Installer.)

From here, install via pip from the terminal as usual:

python3 -m pip3 install rcr

(If you tried to install via pip without first installing the above requirements, pip would probably tell you to do so.)

C++

Because the RCR Python library uses pybind11 to wrap the original C++ source code seamlessly into Python, all of the speed of C++ is available through the Python library. However, if the C++ source code is desired, it can be found at the Github repository in the src directory (RCR_python.cpp is only used for wrapping the C++ code into the rcr Python library, so it can be ignored). Documentation specific to the C++ codebase can be found within the directory docs/cpp_docs of this repository.