Welcome to the documentation!

Python Capella MBSE Tools

Date: Jun 18, 2025 Version: 0.7.3.dev9+g5b7121e

>>> import capellambse
>>> model = capellambse.MelodyModel("git+https://github.com/DSD-DBS/coffee-machine.git")
>>> model.search("SystemFunction").by_name("make coffee")
<SystemFunction 'make coffee' (8b0d19df-7446-4c3a-98e7-4a739c974059)>
.available_in_states = [0] <State 'Ready for request' (15e28744-1a3b-41ce-a2ee-28fb33ed3bda)>
.context_diagram = <Diagram 'Context of make coffee'>
.inputs = [0] <FunctionInputPort 'FIP 1' (9a409efc-75bc-44b5-8888-8abefebc69d0)>
          [1] <FunctionInputPort 'FIP 1' (fac29291-c465-4130-a95b-8dbdd8a9a5cf)>
.is_leaf = True
.kind = <FunctionKind.FUNCTION: 'FUNCTION'>
.layer = <SystemAnalysis 'System Analysis' (fe55c3c2-28d3-4d80-b54d-aae12cdc6bc6)>
.name = 'make coffee'
.outputs = [0] <FunctionOutputPort 'FOP 1' (2bd6785b-08ff-4108-b6f0-c8fd94ab08c0)>
           [1] <FunctionOutputPort 'FOP 2' (1dc12e9d-14f6-494f-9dfc-867635951e91)>
           [2] <FunctionOutputPort 'FOP 3' (c87688f6-adc7-45e2-b254-8f22e85fec4b)>
.parent = <SystemFunction 'Root System Function' (eff8d0b0-84df-431e-aec8-66150a0b1365)>
.pvmt = <Property Value Management for <SystemFunction 'make coffee' (8b0d19df-7446-4c3a-98e7-4a739c974059)>>
.realization_view = <Diagram 'Realization view of make coffee'>
.uuid = '8b0d19df-7446-4c3a-98e7-4a739c974059'
.visible_on_diagrams = [0] <Diagram '[ES] make coffee'>
                       [1] <Diagram '[ES] make coffee (refined)'>
                       [2] <Diagram '[SDFB] make coffee'>
                       [3] <Diagram '[SAB] make coffee'>
.xtype = 'org.polarsys.capella.core.data.ctx:SystemFunction'

Description

This library was designed to enable and support Model Based System Engineering using Polarsys’ Capella with Python. Common usage for this API:

• parsing .aird files

• easy access to model elements and objects

• property-value access and manipulation

• diagram access and export as SVG

Additionally and as a core idea it provides an interface for the underlying database of the Capella model.

Since v0.5, it also supports a simple, but powerful declarative modelling language, which is based on the API for the semantic model.

If you want a quickstart at how to use this package, head right into the how-tos section.

Start

• Installation
• Specifying models
• Environment variables affecting py-capellambse
• Introduction to py-capellambse API
• Declarative modelling
• Migrating from py-capellambse v0.5.x to v0.6.x

Tutorials

• How Tos
  • 1. Introduction
  • 2. Introduction to Physical Architecture API
  • 3. Data Types and Data Values
  • 4. Using capellambse with Jinja2
  • 5. Introduction to Libraries
  • 6. Introduction to Requirement access and management
  • 7. Introduction to Code Generation
  • 8. Property Values and Property Value Management Tool (PVMT) support
  • 9. Property Value Management (PVMT)
  • 10. Context Diagrams Extension
  • 11. Declarative Modeling Example
  • 12. Complexity Assessment

API reference

• src
  • capellambse package
    • Subpackages
      • capellambse.aird package
      • capellambse.diagram package
      • capellambse.extensions package
      • capellambse.filehandler package
      • capellambse.loader package
      • capellambse.metamodel package
      • capellambse.model package
      • capellambse.svg package
    • Submodules
    • capellambse.cli_helpers module
      • ModelCLI
      • ModelInfoCLI
      • enumerate_known_models()
      • loadcli()
      • loadinfo()
    • capellambse.decl module
      • FindBy
      • Metadata
      • ModelMetadata
      • Promise
      • UUIDReference
      • UnfulfilledPromisesError
      • WriterMetadata
      • YDMDumper
      • YDMLoader
      • apply()
      • dump()
      • load()
      • load_with_metadata()
    • capellambse.diagram_cache module
    • capellambse.helpers module
      • EverythingContainer
      • UUIDString
      • deterministic_ids()
      • embed_images()
      • escape_linked_text()
      • extent_func()
      • flatten_html_string()
      • flock()
      • generate_id()
      • get_term_cell_size()
      • get_text_extent()
      • get_transformation()
      • is_uuid_string()
      • load_font()
      • make_short_html()
      • normalize_pure_path()
      • ntuples()
      • process_html_fragments()
      • qtype_of()
      • relpath_pure()
      • repair_html()
      • replace_hlinks()
      • resolve_namespace()
      • split_links()
      • ssvparse()
      • unembed_images()
      • unescape_linked_text()
      • word_wrap()
      • xpath_fetch_unique()
      • xtype_of()

Integration with other tools

• The py-capellambse Sphinx extension
  • Usage
  • Configuration
  • Known limitations

Development

• Low-level API
  • The MelodyLoader object
  • Shifting between API levels
  • Moving along the XML tree
  • Resolving references
  • Finding elements elsewhere
  • Manipulating objects
  • Creating and deleting objects
  • Saving modifications
• How to explore Capella meta-model
  • Getting the meta-model sources
  • Quick intro to package structure
  • Visualizations of some frequently used ontology elements
  • Appendix: Visualizing ECores
• Documentation development
• The py-capellambse REPL
  • capellambse