Getting Started¶

System Requirements

To run Ocelescope locally, you must have Docker and Docker Compose installed on your system.

To get Ocelescope running docker compose. To run ocelescope you can just use the below docker compose script.

docker-compose.yaml
services:
  backend:
    image: grkmr/ocelescope_backend:latest
    volumes:
      - plugins_store:/plugins
    restart: unless-stopped

  frontend:
    image: grkmr/ocelescope_frontend:latest
    ports:
      - "3000:3000"
    restart: unless-stopped

volumes:
  plugins_store:

Download

Starting the Services¶

Run the following command in the same directory as your docker-compose.yml:

docker compose up -d

This will start both the backend (API) and frontend (web interface).

Uploading Plugins¶

You can upload plugins directly from the web interface at:

👉 http://localhost:3000/plugins

Uploaded plugins will be stored in the plugins_store volume and made available for execution.

Stopping Ocelescope¶

To stop the services, run:

1	`docker compose down`

Example Plugins¶

Here are some example plugins you can explore and use with Ocelescope

PM4PY Discovery

Discover object-centric process models through the discovery algorithms of the PM4PY python library

Download
TOTeM

Generate Temporal Object Type Models ( TOTeM) to uncover type-level temporal and cardinality relations in event logs

Download
OC-DECLARE

Discover and check object-centric declarative process constraints ( OC-DECLARE) from object-centric event logs. Proof of concept for using Rust via Python bindings in Ocelescope plugins.

Download
Discqvery

Proof of concept for extended OCELs with quantity states to better model logistics processes. An example extended log is available here.

Download
OCEL Graph

Result of the plugin development tutorial: generates an OCEL Graph (spanning tree) from a selected object/event root to visualize relationships in an event log. Follow the tutorial here.

Download