Skip to main content

Capella Model Explorer

image image

A webapp for exploring Capella models through simple "auto-generated" textual and graphical views.

Longer story

We see a larger non-MBSE crowd struggling with the things hidden in the model. With this app we expose model contents in an easy to review readable form with basic graphical annotations. Under the hood it uses Jinja templates enabling the tooling teams to support their users with model-derived documents of any shape and form.

Use cases

  • Provide insights into / "spell-out" the model for non-MBSE stakeholders via document-a-like dynamic views that describe model elements in a human-readable form.

  • Provide meaningful default views (that can be further customized) for the key elements to kickstart the model exploration.

There are a few more use cases but we will reveal them a bit later.

Installation

You can install the latest released version directly from PyPI.

pip install capella-model-explorer

Run the app

The app comes with a command line interface (CLI). Run cme --help to get help or cme SUBCOMMAND --help to get help for any subcommand.

cme run --help

When running the app, the used IP address and port are printed to the console.

Run the app locally

cme run

Build a Docker image and run the app in a container

docker build -t capella-model-explorer .
cme run --container --image capella-model-explorer

Above will start the app with a sample model which can be found here: In-Flight Entertainment System

Stop the app via CTRL+C.

Run the app in a container with a custom remote model

export CME_MODEL='git+https://github.com/DSD-DBS/Capella-IFE-sample.git'
export CME_PORT=5000  # optional, default is 8000
cme run --container

More information describing what kinds of values can be specified via the environment variable CME_MODEL can be found in the capellambse documentation.

Run the app in a container with a custom local model

If you want to be able to explore a local Capella model, you can mount a local model into the container.

export CME_MODEL=/path/on/host/to/model
cme run --container

Run the app in a container and enable live report template editing

If you want to be able to live edit and test local templates, you can mount a local model and a templates folder into the container. Live template reloading and rendering will be enabled.

export CME_TEMPLATES_DIR=$(realpath ./templates)
cme run --container

Integration in the Capella Collaboration Manager

The Capella Model Explorer can be integrated into the Capella Collaboration Manager. Navigate to Settings > Tools, then Add a new tool with the following configuration:

name: Capella model explorer
integrations:
  t4c: false
  pure_variants: false
config:
  resources:
    cpu:
      requests: 0.4
      limits: 2
    memory:
      requests: 1.6Gi
      limits: 6Gi
  environment:
    CME_MODEL:
      stage: before
      value:
        path: "{CAPELLACOLLAB_SESSION_PROVISIONING[0][path]}"
        diagram_cache:
          path: "{CAPELLACOLLAB_SESSION_PROVISIONING[0][diagram_cache]}"
          password: "{CAPELLACOLLAB_SESSION_API_TOKEN}"
          username: "{CAPELLACOLLAB_SESSION_REQUESTER_USERNAME}"
        fallback_render_aird: "true"
    CME_LOG_FILE: /var/log/session/model-explorer.log
    CME_LIVE_MODE: "0"
    CME_ROUTE_PREFIX: "{CAPELLACOLLAB_SESSIONS_BASE_PATH}"
  connection:
    methods:
      - id: f51872a8-1a4f-4a4d-b4f4-b39cbd31a75b
        type: http
        name: Browser connection
        ports:
          metrics: 8000
          http: 8000
        sharing:
          enabled: true
        redirect_url: "{CAPELLACOLLAB_SESSIONS_SCHEME}://{CAPELLACOLLAB_SESSIONS_HOST}:{CAPELLACOLLAB_SESSIONS_PORT}{CAPELLACOLLAB_SESSIONS_BASE_PATH}/"
  monitoring:
    prometheus:
      path: /metrics
    logging:
      enabled: true
  provisioning:
    directory: /models
    max_number_of_models: 1
    required: true
    provide_diagram_cache: true
  persistent_workspaces:
    mounting_enabled: false
  supported_project_types:
    - general

You can tune the resources according to your needs.

After saving the configuration, you have to add a version for the new tool. Since the Capella Model Explorer can load different Capella versions, we can use one generic version:

name: "Generic"
config:
  is_recommended: true
  is_deprecated: false
  sessions:
    persistent:
      image: ghcr.io/dsd-dbs/capella-model-explorer/model-explorer:latest
  backups:
    image: null
  compatible_versions: [1, 2, 3, 4]

Replace the numbers in compatible_versions with the version IDs for the versions you want to support.

When configured properly, users will be able to start read-only sessions for the Capella Model Explorer. More information about read-only sessions is available in the Capella Collaboration Manager documentation.

Theme

The app comes with a default light and dark theme and the hue value for the primary color can be customized via the environment variable CME_PRIMARY_COLOR_HUE. The default hue value is 231 which corresponds to the purple/ blue color used as primary color in the Capella Collaboration Manager documentation.

Contributing

We'd love to see your bug reports and improvement suggestions! Please take a look at our guidelines for contributors for details. It also contains a short guide on how to set up a local development environment.

Licenses

This project is compliant with the REUSE Specification Version 3.0.

Copyright DB InfraGO AG, licensed under Apache 2.0 (see full text in LICENSES/Apache-2.0.txt)

Dot-files are licensed under CC0-1.0 (see full text in LICENSES/CC0-1.0.txt)

Metadata

Release files for capella-model-explorer 0.3.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for capella-model-explorer 0.3.3
File Size Uploaded Provenance Actions
capella_model_explorer-0.3.3.tar.gz 187.2 kB With provenance Details for capella_model_explorer-0.3.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for capella-model-explorer 0.3.3
File Interpreter ABI Platform Actions
capella_model_explorer-0.3.3-py3-none-any.whl Python 3 none any Details for capella_model_explorer-0.3.3-py3-none-any.whl

Total release size: 221.8 kB

Release files / capella_model_explorer-0.3.3.tar.gz

Download URL capella_model_explorer-0.3.3.tar.gz
Size 187.2 kB
Tags Source
SHA-256 checksum
How to use checksums
50fb5beab905bdc72d97e5fe832ef174ca0836c69474bbda6a909ce418c8a521
BLAKE2b-256 checksum
How to use checksums
7d1387eef8e6b86170d8370504b431e630c128871445e8b655f14b565d60871f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 18, 2025.

Transparency log

Release files / capella_model_explorer-0.3.3-py3-none-any.whl

Download URL capella_model_explorer-0.3.3-py3-none-any.whl
Size 34.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1204b956c032f6423a92287b7b5ffac09da57038d82672a8856808a0030e3d1b
BLAKE2b-256 checksum
How to use checksums
910731fcfe347d13f4fb422aea60a14f258e8f996470c037aca938ced3dbbec2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 18, 2025.

Transparency log

Security for capella-model-explorer 0.3.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for capella_model_explorer-0.3.3.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 18, 2025.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page