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
.

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

...

Note

Important
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\ShogunLive1.10\SDK (if you installed Shogun 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:\ShogunLiveAPI". 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:\ShogunLiveAPI.

  1. Navigate to the Scripts folder for the version of Python that you want to use for pip installation.

    • The default installation folder for Python 3 is:

      C:\Users\<user>\AppData\Local\Programs\Python\Python<version>\Scripts

    • The default installation folder for Python 2.7 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 (assuming you have copied the SDK folder to the suggested location):

    .\pip.exe install "C:\ShogunLiveAPI\SDK\Python\vicon_core_api"

    Scroll pagebreak
  4. Run the following command to install the Shogun Live API (assuming you have copied the SDK folder to the suggested location):

    .\pip.exe install "C:\ShogunLiveAPI\SDK\Python\shogun_live_api"

    Scroll pagebreak

Check that the Python module installed correctly

...