Install the Toolbox

The Genvid Toolbox is a set of scripts, applications, and APIs that help you configure, manage, and monitor your cluster.

Installation

Note

If you are planning to work with Azure, make sure you have Python 3.8 installed before proceeding with the following steps.

Since only a single package version can be installed at a time, you must install this package by running the install-toolbox.py command in your SDK installation folder.

Important

You must re-install the Genvid Toolbox every time you install a new version of the SDK.

At the command line in your shell window:

  1. Navigate to your SDK install folder.
  2. Run the following command.
py install-toolbox.py --user

If you are using virtual environment, execute

python install-toolbox.py

The --user option installs the Genvid Toolbox for only the currently logged-in user. You can also install it system-wide by removing the --user argument if you have high enough permissions.

After finishing, the installation script checks if the toolbox is installed correctly and is included in your PATH. If it isn’t included in your PATH, you can either have the script change it for you or you can do it manually.

See Using Python on Windows page and Installing Packages for more information.

Important

You must restart any open shell windows after the toolbox installation finishes for changes to take effect.

Note

Earlier versions of the Genvid SDK installed the Toolbox package automatically. Uninstalling those versions of the SDK also uninstalled the currently installed Genvid Toolbox even if it was a different version. If you uninstall one of these SDKs with a newer version also installed, you have to re-install the Genvid Toolbox afterwards.