SysMD-Kickstart.md

title	SysMD Kickstart
subtitle	SysMD Notebook User Interface
author	RPTU Kaiserslautern-Landau, Chair of Cyber-Physical Systems
logo	Files/icon.png

[toc]

SysMD Notebook Overview

We distinguish between the SysMD Notebook tool and the SysML v2 language extensions SysMD.

The tool permits editing documents that consist of cells that can be

• documentation written in Markdown, or
• models written in the language SysMD itself.

The language extension extends SysML v2 to better support

• interactive work,
• integration in Notebook-like environments,
• formulation of constraints and ranges for which the expression syntax is carefully extended.

In the following, we first give an introduction to the SysMD Notebook, and then a
brief overview of the SysML v2 textual language constructs as supported by SysMD. The figure below gives an overview of the SysMD Notebook User Interface (UI).

{width=800 height=500}

SysMD Notebook consists of

• The left pane in which projects are selected and edited.
• The main window, in which the files of a project are edited; they are each displayed as a sequence of cells.
• Each cell can be of different kind; depending on the kind, a renderer or editor is chosen.
• In the right pane, issues and errors are listed.

Projects

To create a new SysMD project, select the rider “Project” in the left panel. It is shown below.

{width=600 height=500}

Creating a project

Click on the large "+" icon. This opens a dialog in which you can enter the data for the project:

• name of the project,
• description of the project,
• maintainers of the project,
• license of the project (t.b.d.),
• usages of the project (t.b.d.)

The path in which all projects are saved is shown on the bottom of the panels. You can edit the path; the default is 'SysMD' in the user's home directory.

Updating a project

Click on the pencil in the project's card. This will open the project update dialog, where you can update the project's data.

Deleting a project

Click on the trash bin in the project's card. This will remove the project. The project is actually not deleted, only marked as deleted by adding a suffix .deleted.

In case something goes wrong, the project is still in the directory with a suffix '.deleted'. In the files .project.json and .meta.json you find further settings - see below.

(Usages, Icon: t.b.d.)

Files

A project consists of multiple files. The files appear once a project is opened as tabs in the main window of SysMD Notebook.

Creating, (re-)naming, and deleting Files

In SysMD, each project consists of multiple files. Each file is saved in the project's folder. The project's folder is in the user's home directory and by default called 'SysMD.' In this folder the project folder is created in a directory with the same name as the project's initial name. In the project folder are

• an initial file created together with the project.

• a file .project.json that holds the main project data.

• a file .meta.json that holds an index of all files that belong to a project.

• additional files if added.

• Note that deleting a file will not remove it from the computer, it will only be removed from the index.

Adding and renaming files

In SysMD Notebook, all files of a project are opened and shown as tabs in the main window. To add a file, click on the '+' right of the list of all tabs or files.

{width=600 height=250}

A new tab and a new file are created; you can rename it by using a secondary (right) mouse click on the tab.

Deleting files

(t.b.d. -- currently only closes the tab)

Some options are not yet available via the UI.

• To have nice icon in the project list and the document, add a file icon.png to the project's folder Files.
• Usages can be added to the file .project.json.
• Multiple source files are registered in .meta.json.
• All files are saved in the Markdown format; SysML v2 and KerML textual representations are saved in code parts of the Markdown documents.

Cells

Each file is structured into cells. A cell can be of the kinds

• Documentation that is written in the "Markdown" Language that is between a What-You-See-Is-What-You get Editor like Word or Excel and pure text. Markdown allows us to document our model in a structured way, including a document structure (Chapters, Sections, etc.), Pictures, Tables. This helps us to better explain how we came to requirements – and others to understand it as well. In SysMD, Documentation is tightly interwoven and linked (via Relationships) with more formal, textual models.

• Textual representation of a model. We can formulate models in the modeling languages SysMD or a subset of SysML v2 textual. Both languages are translated into SysML’s KerML metamodel class instances and can be exchanged via the SysMLv2 API.

Add and Delete Cells

A new SysMD document is empty in the beginning. To add a cell, click on the small gray circle with a "+" that is shown.

It adds a document-cell, either in the start, the end or between existing cells. Now you have created your first document-cell. Left of each document-cell, icons are shown. If an element is not selected, they are gray; if an element is selected, the icons are in different colors. If the mouse is over an icon, SysMD notebook shows an explanation what action is done when clicking the item. To delete an element, select the trash bin, to edit the pencil, and to minimize the document-cell, select the “-”.

##- Documentation vs. Code-Cells. Markdown is easy to learn, efficient, and effective. The following text shows how to create a third level heading, how to emphasize; just to give you an example.

Double-click into the cell below!

Third level Heading; click here!

Below an item list:

• This is emphasized.
• This is Bold.
• This is ++underlined++.
• This is strikethrough.

Double click into this cell to edit it. You want to learn more on Markdown?

[Learn more about Markdown by clicking this link!]

Note that SysMD Notebook also renders LaTeX equations like $\alpha = \sum_{x=0}^{100} x$.