--- title: "Install the Vicon Evoke API" canonical: "https://help.vicon.com/space/Evoke18/397970205/Install%20the%20Vicon%20Evoke%20API" format: markdown --- To use the Evoke API with Python, make sure that you have both installed. The Evoke API provides support for Python 2.7 and Python 3. Vicon recommends that you use the latest full release of Python 3, unless your project requires you to use a specific version of Python. The following procedures guide you through the installation process: > Macro (toc) > Macro (scroll-pagebreak) ### > Macro (anchor) Check Python version If you are not sure if you have Python installed or which version of Python you are using, you can open a command prompt and run the *py* command. For example: ```plaintext c:\>py Python 3.11.3 (tags/v3.11.3:f3909b8, Apr 4 2023, 23:49:59) [MSC v.1934 64 bit (AMD64)] on win32 Type "help", "copyright", "credits" or "license" for more information. >>> ``` If you do not have Python installed, see [Install Python](#InstallPython). ### > Macro (anchor) Install Python **To install Python 2 or 3:** 1. Go to [https://www.python.org/downloads/](https://www.python.org/downloads/) 2. Locate the required version and install Python, ensuring that **Add python.exe to PATH** is selected: ### > Macro (anchor) Install the Evoke Python module The following steps assume you are using Python version 3 and the latest release of Evoke. **To install the Evoke Python module:** 1. Locate the installation files. If you installed Evoke in the default location, they are found in this folder: *C:\Program Files\Vicon\Evoke1.#\SDK\Python* (where *#* is the point number of the latest release) These folders and files are displayed: - *evoke_api* - *sample_scripts* - *vicon_core_api* - *install_evoke_api.bat* - *readme.txt* - *uninstall_evoke_api.bat* 2. Install the Evoke Python module in either of the following ways, depending on your particular installation: - The simplest way is to run the batch file (*install_evoke_api.bat*) that is included in the Evoke installation (as shown in the previous image). This usually works well if: - Python was installed to the PATH variable; or - Multiple versions of Python are installed, but you want to install the API to the latest version that you installed; or - Only a single version of Python is installed. If any of these conditions apply, see [Install the Python module by running the batch file](#BatchFile). - In all other cases, install the Python module by using pip. This usually applies if: - Multiple versions of Python are installed, but you want to install to a specific version; or - Multiple different versions of Python are installed and you want to install to all of them (in this case, you must install the module for each version); or - Only a single version of Python is installed, but you didn't install to PATH. If any of these conditions apply, see [Install the Python module by running pip](#InstallPIP). #### > Macro (anchor) Install the Python module by running the batch file To do this: 1. Navigate to the Python install folder: *C:\Program Files\Vicon\Evoke1.#\SDK\Python* (where *#* is the point number of the latest release) 2. Double-click *install_evoke_api.bat*. This opens the Command Prompt that runs the installation process. #### > Macro (anchor) Install the Python module by running pip > ❌ **Caution** > ❌ > ❌ If you are using Python 3, you must copy the *SDK* folder from the *Program Files* directory to a new folder that doesn't require Administrator permission. This is due to a permissions issue with pip versions 21.3 or later. > ❌ > ❌ By default, you can find the *SDK* folder at *C:\Program Files\Vicon\Evoke1.#\SDK* (if you installed Evoke in another location, use this path to find the SDK folder). > ❌ > ❌ We recommend copying the *SDK* folder into a new folder with an easy-to-access location, for example, *C:\EvokeAPI*. You can delete this folder after the pip installation is complete. > ❌ > ❌ **The steps in this guide assume you have copied the *****SDK*****folder to *****C:\EvokeAPI*** **.** 1. Navigate to the *Scripts* folder for the Python that you want to use: - For Python 3, the default installation folder is: *C:\Users\\AppData\Local\Programs\Python\Python311\Scripts* - For Python 2.7, the default installation folder is: *C:\Python27\Scripts* 2. Open a command window or powershell in that folder. 3. Run the following command to install the Vicon Core API: `.\pip.exe install "C:\EvokeAPI\SDK\Python\vicon_core_api"` 4. Run the following command to install the Evoke API: `.\pip.exe install "C:\EvokeAPI\SDK\Python\evoke_api"` > ℹ️ **Note** > ℹ️ The above examples use a Python 3.11 installation with the latest release of Evoke. Your path and commands may differ slightly. > Macro (scroll-pagebreak) ### > Macro (anchor) Check that the Python module installed correctly Check that the following modules have been installed: - **vicon_core_api**: This is the core remote control API and includes a client for communication with the terminal server. - **evoke_api**: Services API for accessing evoke specific application functionality. To test that the Evoke Python module installed correctly, try importing one of the modules in Python: ```plaintext >>> import vicon_core_api ``` If the above process fails to recognize the module, try the following: - Check the *site-packages* folder in the Python installation for the *evoke_api* or *vicon_core_api* folder. For Python 3.11, the location of the default installation folder is: *C:\Users\**\AppData\Local\Programs\Python\Python311\Lib\site-packages* - Check your system environment variables and ensure that the scripts folder for the Python installation you want to use is the highest in the list. For Python 3.11, the default location of the installation folder is: *C:\Users\**\AppData\Local\Programs\Python\Python311\Scripts* If either of the modules folders is missing, and you have verified the path, re-run through the installation process described in [Install the Evoke Python module](#InstallEvokeModule).