Install the Toolbox¶
The Genvid Toolbox is a set of scripts, applications, and APIs that help you configure, manage, and monitor your cluster.
The Genvid SDK uses Python scripts extensively for many of its tools. There is a known issue in Windows PowerShell, where a command including a directory with a trailing slash will incorrectly parse the command. If you are using Windows PowerShell with the Genvid SDK, you generally can get around this issue by deleting the final slash.
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.
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:
Navigate to your SDK install folder.
Run the install-toolbox.py script.
If you are using a Python virtual environment (venv), use python rather than py. This ensures you’re executing the script within your venv and not from your machine’s Python installation.
--user option installs the Genvid Toolbox for only the currently
logged-in user. You can also install it system-wide by removing the
argument if you have high enough permissions.
After finishing, the installation script verifies the Toolbox is installed
correctly and is included in your environment’s
PATH variable. If you
find anything from the Toolbox installation isn’t available, run the
install-toolbox.py script with the
-p option to manually add it to your
py install-toolbox.py -p
You must restart any open shell windows after the toolbox installation finishes for changes to take effect.
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.