Installation#
For a quick preview, follow the Quick Start guide.
Prerequisites#
Verify you meet the System Requirements.
Step 1: Get Scenescape#
Note that these operations must be executed when logged in as a standard (non-root) user. Do NOT use root or sudo.
Download the Scenescape software archive from open-edge-platform/scenescape.
Extract the Scenescape archive on the target Ubuntu system. Change directories to the extracted Scenescape folder.
cd scenescape-<version>
Clone the repository and change directories to the cloned repository:
git clone https://github.com/open-edge-platform/scenescape.git -b main
cd scenescape/
Note: The default branch is main. To work with a stable release version, list the available tags and checkout a specific version tag:
git tag
git checkout <tag-version>
Step 2: Choose a Deployment#
Scenescape can run on Docker Compose or on Kubernetes, and can be deployed clean (an empty scene database, ready for your own cameras and scenes) or with the bundled demo (two sample scenes preloaded with recorded video). Either way, you first need Scenescape’s container images available, either built from source or as prebuilt images.
I want to… |
Steps |
|---|---|
Deploy clean Scenescape on Docker |
|
Deploy clean Scenescape on Kubernetes |
|
Explore the bundled demo (Docker or Kubernetes) |
Note: The Kubernetes guides assume a cluster already exists and
kubectlis configured with access to it. To spin up a local, self-contained cluster for development or evaluation instead, see Scenescape on Kubernetes.
Next Steps#
Use Scenescape UI and Online Documentation: Navigate the web UI and view the online documentation, once you have deployed the demo.
Explore other topics#
How to Define Object Properties: Step-by-step guide for configuring the properties of an object class.
How to enable reidentification: Step-by-step guide to enable reidentification.
Viewing Re-identification Metrics: Guide for exposing and querying ReID match-latency, camera-count, and tracked-object-count metrics via OpenTelemetry.
How to Enable Observability (Experimental): Guide for enabling OpenTelemetry-based metrics and distributed traces for the Scene Controller and Tracker Service.
Geti AI model integration: Step-by-step guide for integrating a Geti trained AI model with Scenescape.
Running License Plate Recognition with 3D Object Detection: Step-by-step guide for running license plate recognition with 3D object detection.
How to Configure DL Streamer Video Pipeline: Step-by-step guide for configuring DL Streamer video pipeline.
Model configuration file format: Model configuration file overview.
How to Manage Files in Volumes: Step-by-step guide for managing files in Docker and Kubernetes volumes.
Additional Resources#
How to upgrade Scenescape: Step-by-step guide for upgrading from an older version of Scenescape.
How Scenescape converts Pixel-Based Bounding Boxes to Normalized Image Space
Hardening Guide for Custom TLS: Optimizing security posture for a Scenescape installation.