Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

Note

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

For information on installation, see:

Scroll only
scroll-viewporttrue
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-htmltrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
22

...

  1. Go to https://www.python.org/downloads/
  2. Locate the required version and install Python, ensuring that Add Python #.# to PATH is selected:

    Scroll pagebreak

Install the Python module

To install the Python module:

  1. Locate the installation files, which, if you installed Shogun Live in the default location, are found in this folder:

    C:\Program Files\Vicon\ShogunLive#.#\SDK\Python
    These files are displayed:

  2. You can install the Shogun Live Python module in either of the following ways, depending on your particular installation:

    • The simplest way is to run the batch file (install_shogun_live_api.bat) that is included in the Shogun Live installation (as shown in the above 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, install the Python module by running the batch file.

    • 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, install the Python module by running pip.

...