This guide shows you how to install CueGUI.
Users use CueGUI to monitor and manage OpenCue jobs.
Admins use CueGUI to:
- Troubleshoot jobs.
- Assign render processors to jobs.
- Manage cue priorities.
CueGUI is a standalone PySide application. It runs locally on the user’s workstation; all users within your OpenCue deployment who want to use it will need it available on their workstations.
Before you begin
Before you start to work through this guide, complete the steps in Installing PyCue and PyOutline.
You need the same Cuebot hostname that you used to configure PyCue in this guide as well. If you don’t know the Cuebot hostname, check with your OpenCue admin. After you know this, set the
To follow the instructions in this guide, you’ll need the following software:
CueGUI is written in Python. To run CueGUI, you install a series of dependencies and configure a virtual environment for the Python code to run inside.
To install CueGUI:
To install the required Python packages, create an isolated Python environment:
NoteUse of a virtual environment isn’t strictly necessary but is recommended to avoid conflicts with other locally installed Python libraries. If you already created a virtual environment in which to install PyCue, skip this step and use PyCue’s environment for the following steps.
Evaluate the commands in the
activatefile in your current shell:
TIP: To review the contents of the
Option 1: Install a published release
To install a published release:
Visit the OpenCue releases page.
Download the cuegui tarball from the latest release’s Assets.
Run the following commands in a terminal to install a
cueguiexecutable in the
PATHof your environment:
export CUEGUI_TAR="<path to cuegui tar.gz>" export CUEGUI_DIR=$(basename "$CUEGUI_TAR" .tar.gz) tar xvzf "$CUEGUI_TAR" cd "$CUEGUI_DIR" pip install -r requirements.txt python setup.py install cd .. rm -rf "$CUEGUI_DIR"
Option 2: Install from source
Make sure you’ve checked out the source code and your current directory is the root of the checked out source.
pip install -r requirements.txt cd cuegui
You can either install CueGUI from here, and run the
cuegui executable that
python setup.py install cd .. CUEBOT_HOSTS=$CUEBOT_HOSTNAME_OR_IP cuegui
OR you can run the software directly, without installing:
CUEBOT_HOSTS=$CUEBOT_HOSTNAME_OR_IP python -m cuegui
The CueGUI executable launches and the Cuetopia window appears: