gemseo-sysml

Overview

gemseo-sysml is a GEMSEO connector to SysML v2. It parses a set of ODE4HERA SysML v2 models, based on the ODE4HERA ontology, and enables to set up a GEMSEO MDO problem from a SysML v2 MDAO model.

Currently, the following features can be extracted from the MDAO model:

• the disciplines
• the design space
• the objective function
• the constraints

Also, the plugin enables to update the input model with the optimization results. It also enables to check the requirement coverage, based on the constraint results.

Scope and limitations

Version 0.0.1 is a preliminary release: the API, the SysML v2 constructs that are read and the output that is written may all change in later versions, with no backward compatibility guaranteed yet.

gemseo-sysml is not a general-purpose SysML v2 connector. It is tightly coupled to the ODE4HERA ontology: the reader and the writer look for the specific parts, actions, attributes and metadata tags defined by the ODE4HERA metamodels, and identify them through those metamodels' semantic prefixes (#discipline, #designSpace, #contX, #evalOut, …). A SysML v2 model that does not specialize these metamodels cannot be read, even if it is otherwise valid SysML v2.

As a consequence, the plugin is currently usable in a limited context:

• only models built on version 1.0 of the ODE4HERA ontology;
• only a subset of MDAO problems — a single objective, continuous design variables only, and the MDF, IDF and BiLevel formulations.

The exact list of what is read, ignored and rejected is given on the Supported SysML v2 constructs page. The role of the ontology is described on the ODE4HERA ontology page.

Requirements

Syside Automator, being distributed as a compiled extension module, constrains the platforms and the Python versions on which the plugin can run. The plugin is supported on Windows and Linux, each with a minimum version:

Installing the plugin with pip pulls in a compatible Syside version, but an environment that already has one outside that range may fail.

The Python floor of 3.12 comes from Syside, not from GEMSEO, which itself supports Python 3.10 and later.

Syside imposes further constraints of its own, in particular on licensing (offline licenses are available for networks from which the Sensmetry licensing servers cannot be reached). Refer to the Sensmetry documentation for the authoritative and up-to-date details: installation and system requirements and licensing.

Installation

Install the latest version with pip install gemseo-sysml.

See pip for more information.

The plugin relies on Syside Automator from Sensmetry, to read/write data from/to textual SysML v2 models, for which a license is required.

The required SysML v2 metamodels from ODE4HERA project are available on the Sysand package index: Simulation and Analysis, SPDM, Architecture Design and Requirements Management. The plugin is compatible with version 1.0 of the ODE4HERA ontology only. These packages can be downloaded using the sysand command-line tool, which requires a Sysand account and an API token (see the related section of the ODE4HERA Ontology page).

Bugs and questions

Please use the gitlab issue tracker to submit bugs or questions.

You can also contact the authors using our Discourse channel.

Contributing

See the contributing section of GEMSEO.

Contributors

• Jean-Christophe Giret (IRT Saint Exupéry)
• Jean-Marie Gauthier (IRT Saint Exupéry)
• Sylvain Béchet (IRT Saint Exupéry)

The funding comes from European Union Clean Aviation project ODE4HERA, co-funded by the European Union under GA no. 101140510.