/
Install the Shogun Post Python module

Install the Shogun Post Python module

Owned by Adaptavist ScriptRunner for Confluence Cloud (Unlicensed)
Jul 11, 2024

To use Python and the Shogun Post Python modules, you must first install them.

Both Python 2 and Python 3 are supported. Vicon recommends that you use the latest full release of Python 3, unless your project requires you to use a specific version of Python.

With Shogun 1.4 and later, Python 3.0 and later is fully supported. Legacy support only is provided for Python 2.7.

Install Python

To install Python 2 or 3:

  1. Go to Python.org/Downloads/

  2. Locate the required version and install Python, ensuring that Add Python #.# to PATH is selected:

To use a Python interpreter within Shogun Post, you must specify it in the Shogun Post Preferences dialog box, at the bottom of the Directories tab.

Install the Shogun Post Python modules

Important
This workflow hasn't been tested for Windows 11. For help installing Shogun Post Python modules with Windows 11 or later, contact Vicon Support.

You need to install the Shogun Post SDK into any instance of Python you wish to use with Shogun. Find the Shogun Post Python modules in the following locations and use the installation utility provided:

  • For 64-bit installations of the Python interpreter:
    C:\Program Files\Vicon\ShogunPost#.#\SDK\Win64\install_vicon_shogun_post_sdk.bat

  • For 32-bit installations of the Python interpreter:
    C:\Program Files\Vicon\ShogunPost#.#\SDK\Win32\install_vicon_shogun_post_sdk.bat

These scripts install the modules using the default pip tool.

Note
The same module supports Python 2 and Python 3.

Shogun Post Python modules installed

Shogun Post installs two Python modules:

  • ShogunPostSDK. This folder contains the main Shogun PostSDK, and is the module that is most commonly used.
  • ViconShogunPost. This module contains the Shogun Post implementation of a common Python SDK, shared by several Vicon products. 

Check that the Python modules installed correctly

To test that the Shogun Post Python modules installed correctly, run Python and try the following import statement:

  • import ViconShogunPost

  • import ViconShogunPostSDK

    If this imports without any errors then the installation has been successful.