Skip to main content

Extension for py-capellambse that adds automatically generated context diagrams for arbitrary model elements.

Project description

Context Diagram extension for capellambse

This extension of py-capellambse enables generation of views (diagrams) that describe an element context (from a user-defined perspective). This allows systems engineers to do less layouting work and at the same time get diagrams with optimal layouts into the model-derived documents.

The contents of an element context (what elements make it to the context) depend on the element of interest and are selected based on a hand-picked set of rules. However in many cases end user can further customize what and how needs to be in the context view.

The generated views are delivered as SVG images and do not persist in the model itself. This approach enables generation of large number of views at scale (in parallel) in the document production pipeline and also saves quite some XML space in the models. When you rely on generated views for documentation the models can stay lite as they only need to have the engineering / design views (that dont need to have a nice layout).

The layout work is done by elkjs' Layered algorithm.

Generate Context Diagrams from your model data!

When the extension is installed you get additional method .context_diagram available on those model elements that are already covered by context view definitions.

Simple context

Context diagram of Left

Interface context

Interface context diagram of Interface

Have a look at our documentation to get started and see the capabilities of this extension.


Special thanks goes to the developers and maintainers of Eclipse Layout Kernel™.

Licenses

Copyright and license information added and maintained via the reuse tool from Reuse Software.

Copyright 2022 DB InfraGO AG, own contributions licensed under Apache 2.0 (see full text in LICENSES/Apache-2.0)

Copyright (c) 2021 Kiel University and others, ELK/Sprotty contributions (elkgraph-json.js & elkgraph-to-sprotty.js) licensed under EPL-2.0

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

capellambse_context_diagrams-0.4.4.tar.gz (325.5 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file capellambse_context_diagrams-0.4.4.tar.gz.

File metadata

File hashes

Hashes for capellambse_context_diagrams-0.4.4.tar.gz
Algorithm Hash digest
SHA256 f85332cb2f814a47122d1d4fc9c7968fbf2593f6cf46cc52fe11f2c1c716e4c7
MD5 e460b1cbbf47e10a90d96d49635a8f96
BLAKE2b-256 f489937a54d4337d83af2add9c813ada19e96510f9d7d78eeead7c5f14cb1246

See more details on using hashes here.

File details

Details for the file capellambse_context_diagrams-0.4.4-py3-none-any.whl.

File metadata

File hashes

Hashes for capellambse_context_diagrams-0.4.4-py3-none-any.whl
Algorithm Hash digest
SHA256 1acd576758685967d22a5e58cc18f4ef13fb1124dbfc5972eb638d46ec0c7873
MD5 614d73519bbbccc80f190e462dd815e7
BLAKE2b-256 969823b54db7c9a3501590ff3e22ac9495f84f39277d7648b91fdb597a286987

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page