Installing the Toolbox

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

Important

Windows PowerShell has parsing rules that can cause issues when using the Genvid Toolbox and Genvid MILE SDK Python scripts. Specifically, it interprets backslashes followed by quotation marks (/")in a way that can cause errors in commands that include a directory path.

To avoid this issue, either delete the final backslash or end the string with two backslashes (//"). This allows PowerShell to parse the string correctly.

For more information, see the documentation on the PowerShell *CommandLineToArgvW* function.

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 the folder where the Genvid Toolbox is installed.

At the command line in your shell window:

Navigate to your Toolbox install folder.
Run the install-toolbox.py script.
```
py install-toolbox.py
```

Once you’ve installed the Toolbox, you can install the SDK. See the Genvid MILE SDK documentation for more information.

Note

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.

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 sufficient 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 environment’s PATH.

py install-toolbox.py -p

See Using Python on Windows 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 MILE 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.

Removal of Support for AWS and Azure

By default, install-toolbox.py installed all the necessary dependencies for AWS and Azure. Since version 1.33.0, it is possible to not install them. For this, you can run the command with the option --no-extra. Note that this will not deinstall any package already present, it will solely avoid installing them.

Working with Multiple Installations of the Genvid MILE SDK

Beginning with version 1.39, the Genvid Python Toolbox and its scripts can support multiple versions of the Genvid MILE SDK. However, even if you’re using a virtual environment, you must specify which version you’re currently using.

See the Genvid MILE SDK documentation for more information.