Get Started with Intel® SceneScape#

  • Time to Complete: 30-45 minutes

Get Started#

Prerequisites#

Check System Requirements before proceeding with rest of the steps in this documentation.

Step 1: Install Prerequisites#

The prerequisite software can be installed via the following commands on the Ubuntu host OS:

sudo apt update
sudo apt install -y \
  curl \
  git \
  make \
  openssl \
  unzip \
  rsync

Installing Docker on your system:

  1. Install Docker using the official installation guide for Ubuntu: Docker Installation Guide for Ubuntu

  2. Configure Docker to start on boot and add your user to the Docker group:

    sudo systemctl enable docker
sudo usermod -aG docker $USER

  3. Log out and log back in for group membership changes to take effect.

  4. Verify Docker is working properly:

    docker --version
docker run hello-world

Step 2: Download and extract code of a Intel® SceneScape release#

Note: These operations must be executed when logged in as a standard (non-root) user. Do NOT use root or sudo.

  1. Download the Intel® SceneScape software archive from open-edge-platform/scenescape.

  2. Extract the Intel® SceneScape archive on the target Ubuntu system. Change directories to the extracted Intel® SceneScape folder.

    cd scenescape-<version>/

  3. When downloading older Intel® SceneScape releases, follow instructions in Getting-Started-Guide specific to that version.

Alternatively, get the Intel® SceneScape source code#

  1. Clone the repository:

    git clone https://github.com/open-edge-platform/scenescape.git

  2. Change directories to the cloned repository:

    cd scenescape/

    Note: The default branch is main. To work with a stable release version, list the available tags and checkout specific version tag:

    git tag
git checkout <tag-version>

Step 3: Build Intel® SceneScape container images#

Build container images:

make

The build may take around 15 minutes depending on target machine. This step generates common base docker image and docker images for all microservices.

By default, a parallel build is being run with the number of jobs equal to the number of processors in the system. Optionally, the number of jobs can be adjusted by setting the JOBS variable, e.g. to achieve sequential building:

make JOBS=1

Step 4 (Optional): Build dependency list of Intel® SceneScape container images#

make list-dependencies

This step generates dependency lists. Two separate files are created for system packages and Python packages per each microservice image.

Step 5: Deploy Intel® SceneScape demo to the target system#

Before deploying the demo of Intel® SceneScape for the first time, please set the environment variable SUPASS with the super user password for logging into Intel® SceneScape. Important: This should be different than the password for your system user.

export SUPASS=<password>

make demo

Step 6: Verify a successful deployment#

If you are running remotely, connect using "https://<ip_address>" or "https://<hostname>", using the correct IP address or hostname of the remote Intel® SceneScape system. If accessing on a local system use "https://localhost". If you see a certificate warning, click the prompts to continue to the site. For example, in Chrome click “Advanced” and then “Proceed to <ip_address> (unsafe)”.

Note: These certificate warnings are expected due to the use of a self-signed certificate for initial deployment purposes. This certificate is generated at deploy time and is unique to the instance.

Logging In#

Enter “admin” for the user name and the value you typed earlier for SUPASS.

Docker Compose Profiles#

Intel® SceneScape uses Docker Compose profiles to organize services into logical groups. When starting or stopping services, you must specify the same profile(s) used during deployment.

The following profiles are available:

Profile

Description

controller

Scene Controller in default mode (analytics + tracking). Used by make demo.

analytics

Scene Controller in analytics-only mode (without tracking).

experimental

Enables mapping and cluster-analytics services.

mapping

Enables mapping service only.

cluster-analytics

Enables cluster-analytics service only.

vdms

Enables the VDMS visual database service (used for re-identification).

tracker

Enables the tracker service.

Profiles can be specified on the command line with --profile:

docker compose --profile controller up -d

Multiple profiles can be combined:

docker compose --profile controller --profile experimental up -d

Alternatively, profiles can be set via the COMPOSE_PROFILES environment variable:

export COMPOSE_PROFILES=controller
docker compose up -d

For multiple profiles, use a comma-separated list:

export COMPOSE_PROFILES=controller,experimental
docker compose up -d

For more details, see the Docker Compose profiles documentation and the COMPOSE_PROFILES environment variable reference.

Note: The --profile flags used with docker compose down must match those used when starting the services. Otherwise, containers started under a specific profile will remain running.

Stopping the System#

To stop the containers, use the following command in the project directory (see Docker Compose Profiles for details on choosing profiles):

docker compose --profile controller down --remove-orphans

Starting the System#

To start after the first time, use the following command in the project directory:

docker compose --profile controller up -d

Summary#

Intel® SceneScape was downloaded, built and deployed onto a fresh Ubuntu system. Using the web user interface, Intel® SceneScape provides two scenes by default that can be explored running from stored video data. SceneScape WebUI Homepage

Note: The “Documentation” menu option allows you to view Intel® SceneScape HTML version of the documentation in the browser.

Next Steps#

Learn how to use Intel® SceneScape#

Build a Scene in Intel® SceneScape#

Learn how to calibrate cameras for Intel® SceneScape#

Explore other topics#

Additional Resources#