OEP-3 SysML v2 Applications and Examples
State | In Progress |
Slack Channel | |
Github Repository | |
Created | May 18, 2023 |
Authors | @Ed Seidewitz @robert karban @Fatma Karagรถz |
Motivation
OpenMBEE is fundamentally based on the Systems Modeling Language (SysML). The Object Management Group has just recently adopted the beta version of SysML 2.0. This will eventually be support in OpenMBEE MMS 5, but the SysML v2 Submission Team (SST) has already provided a pilot implementation for the new version of the language. It would be very beneficial to have some applications and examples of use of the new version of SysML, in order both to better understand the impact of the SysML v1 to v2 migration and to provide insight into how best to support SysML v2 in OpenMBEE.
Proposal
The SysML v2 Pilot Implementation release provides installers for both Eclipse and Jupyter Lab, which support model creation using the SysML v2 textual notation (with a limited capability for graphical visualization).
Jupyter
The OpenMBEE project supports a cloud-based JupyterHub deployment with SysML v2 installed.
Use Slack https://openmbee.slack.com/archives/C05GUM28KK9 to request an account on the OpenMBEE JupyterHub to be used for creating example SysML v2 models for this OEP.
Models can be exported from Jupyter as
.ipynb
notebook files and made available to the community in the SysML v2 Applications and Examples repository on GitHub.Use Slack https://openmbee.slack.com/archives/C05GUM28KK9 to request write access to the repository (GitHub username required).
The JupyterHub deployment does not provide a means to collaborate across accounts. Therefore, if a group of modelers wishes to create an example model together, they will need to coordinate the use of a single account.
Alternatively, modelers can install Jupyter and the SysML v2 kernel locally, following the SysML v2 release installation instructions for Jupyter.
Eclipse
If they wish, modelers can also install SysML v2 in Eclipse, following the SysML v2 Release installation instructions for Eclipse.
Models created in Eclipse can be exported as
.sysml
notebook files and made available to the community in the SysML v2 Applications and Examples repository on GitHub.Use Slack https://openmbee.slack.com/archives/C05GUM28KK9 to request write access to the repository (GitHub username required).
Guidelines
Modelers should take advantage of the rich-text capabilities of Jupyter to organize and explain the models in their notebooks.
Modelers will retain copyright to their models. Each notebook should include a copyright notice at the beginning.
Models contributed to the GitHub repository will be distributed under the Apache 2.0 License.
Models must not contain any proprietary or limited-access information. Modelers represent that they have the right to contribute their models and license their distribution.
Resources
SysML v2 Applications and Examples Repository โ https://github.com/Open-MBEE/SysML-v2-Applications-and-Examples
OpenMBEE JupyterHub for SysML v2 โ https://jupyter.openmbee.org
SysML v2 Release โ http://github.com/Systems-Modeling/SysML-v2-Release
SysML v2 Training Material โ SysML-v2-Release/doc/Intro to the SysML v2 Language-Textual Notation.pdf at master ยท Systems-Modeling/SysML-v2-Release
SysML 2.0 Beta1 Specification Document - https://www.omg.org/spec/SYSML/2.0/Beta1/Language/PDF