Install on Windows
====================

The RDK C++ and Python libraries are packed into a unified modern CMake project named ``flexiv_rdk``, which can be configured and installed using CMake on all supported OS.

C++
-------

.. _prepare_cpp_build_tools_on_win:

Prepare build tools
~~~~~~~~~~~~~~~~~~~~

Compiler kit, CMake, and a bash emulator are needed and can be installed via:

1. Install compiler kit: Download and install Microsoft Visual Studio 2019 (MSVC v14.2) or above. Choose "Desktop development with C++" under the *Workloads* tab during installation. You only need to keep the following components for the selected workload:
    
    * MSVC ... C++ x64/x86 build tools (Latest)
    * C++ CMake tools for Windows
    * Windows 10 SDK or Windows 11 SDK, depending on your actual Windows version

2. Install CMake (with GUI): Download ``cmake-3.x.x-windows-x86_64.msi`` from `CMake download page <https://cmake.org/download/>`_ and install the msi file. The minimum required version is 3.16.3. **Add CMake to system PATH** when prompted, so that ``cmake`` and ``cmake-gui`` command can be used from Command Prompt or a bash emulator.
3. Install bash emulator: Download and install `Git for Windows <https://git-scm.com/download/win/>`_, which comes with a bash emulator Git Bash.


Install dependencies
~~~~~~~~~~~~~~~~~~~~~

Within the bash emulator, the steps are identical to :ref:`install_cpp_deps_on_linux` on Linux.


Install RDK library
~~~~~~~~~~~~~~~~~~~

Within the bash emulator, the steps are identical to :ref:`install_cpp_rdk_on_linux` on Linux.


Link to installed library from a user program
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Within the bash emulator, the steps are identical to :ref:`link_cpp_rdk_on_linux` on Linux.


Python
-------

Prepare build tools
~~~~~~~~~~~~~~~~~~~~

Besides tools in :ref:`prepare_cpp_build_tools_on_win`, Python interpreter and Python package manager are also needed and should be installed via Microsoft Store. Multiple versions of Python can be installed alongside each other.


Install dependencies
~~~~~~~~~~~~~~~~~~~~~

The steps are identical to :ref:`install_py_deps_on_linux` on Linux.


Install RDK library
~~~~~~~~~~~~~~~~~~~

The steps are identical to :ref:`install_py_rdk_on_linux` on Linux.


Link to installed library from a user program
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The steps are identical to :ref:`link_py_rdk_on_linux` on Linux.