Installing CueGUI

Install CueGUI to monitor, manage, and troubleshoot jobs

---

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

1. Before you start to work through this guide, complete the steps in Installing PyCue and PyOutline.

2. 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 CUEBOT_HOSTNAME_OR_IP environment variable:

   export CUEBOT_HOSTNAME_OR_IP=localhost
   

3. To follow the instructions in this guide, you’ll need the following software:

   • Python
   • pip Python package manager
   • virtualenv tool

Installing CueGUI

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:

1. To install the required Python packages, create an isolated Python environment:

   Note : Use 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.>

   virtualenv venv
   

2. Evaluate the commands in the activate file in your current shell:

   TIP: To review the contents of the activate file, run cat activate.

   source venv/bin/activate
   

Option 1: Installing from pypi

To install a published release:

To install from the published pypi release:

You need the pip and virtualenv tools. Use of a virtual environment is not strictly necessary but is recommended to avoid conflicts with other installed Python libraries.

pip install opencue-cuegui

Run CueGUI:

CUEBOT_HOSTS=$CUEBOT_HOSTNAME_OR_IP cuegui

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 cuegui/

You run the cuegui executable that gets created:

CUEBOT_HOSTS=$CUEBOT_HOSTNAME_OR_IP cuegui

The CueGUI executable launches and the Cuetopia window appears:

What’s next?

• Installing CueSubmit