= SysML v2 Pilot Implementation Protoyping
This software is licensed under the GNU Lesser General Public License. See the files LICENSE and LICENSE-GPL.
== Installation Instructions
=== Development Environment
==== Install using Oomph Installer
The project provides a configuration file for the https://wiki.eclipse.org/Eclipse_Installer[Eclipse Installer] which eases the creation of reproducible development environments.
Download the Eclipse Installer from https://www.eclipse.org/downloads/packages/installer
.
Clone our GitHub repository from the URL below.
https://github.com/Systems-Modeling/SySML-v2-Pilot-Implementation.git
Open Eclipse Installer and switch to Advanced mode: + image:installer-advanced.png[switch to advanced mode]
In the product list, select "Eclipse Modeling Tools" with Product Version: 2024-03.
In the Projects window, to the right of the text box, click the "+" to the add the Sysml2 project as user project. In the dialog, choose Catalog: Github Projects and browse the file system to select the setup file from the local git repository.
file:/C:/git/sysml/SysML-v2-Pilot-Implementation/org.omg.sysml.installer/SysML2.setup
Select SysML2 in the Projects list: + image:oomph-projects.png[oomph projects]
On the next page, update the following variables, then press Next.
On the Confirmation page, press Finish.
(Optional) For PlantUML visualization, GraphViz is needed. Visit https://www.graphviz.org/download/ and download the appropriate package for your environment.
==== Manual installation
Install Eclipse 2024-03 (4.25) and Xtext.
Install the “Eclipse Modeling Tools” package.
** https://www.eclipse.org/downloads/packages/release/2024-03/r/eclipse-modeling-tools
To install Xtext, select Help > Install New Software, use the update site URL given below, and install “Xtext Complete SDK” (under General Purpose Tools).
** http://download.eclipse.org/releases/2024-03
(Optional) For PlantUML visualization, you need to install PlantUML-Eclipse with SysMLv2 extensions from
the update site of https://github.com/himi/p2-update-puml-sysmlv2/raw/main/updates
with Help > Install New Software.
Clone our GitHub repository from the URL below.
https://github.com/Systems-Modeling/SySML-v2-Pilot-Implementation.git
Import projects from the repository into your Eclipse workspace. This should include at least the projects:
org.omg.sysml
org.omg.kerml.expressions.xtext
org.omg.kerml.expressions.xtext.ide
org.omg.kerml.expressions.xtext.ui
org.kerml.xtext
org.kerml.xtext.ide
org.kerml.xtext.ui
org.sysml.xtext
org.sysml.xtext.ide
org.sysml.xtext.ui
Note:
org.omg.sysml.jupyter
.org.omg.sysml.jupyter
).
mvn clean package
from the base SysML-v2-Pilot-Implementation
directory.SysML-v2-Pilot-Implementation/launch
.=== Prototype SysML Implementation
==== Getting Started
Find the file org.omg.kerml.expressions.xtext/src/org.omg.kerml.expressions.xtext/KerMLExpressions.xtext
, right click on it, and select Run As > Generate Xtext Artifacts, to execute the Xtext generator. Repeat with org.omg.kerml.xtext/src/org.omg.kerml.xtext/KerML.xtext
and org.omg.sysml.xtext/src/org.omg.sysml.xtext/SysML.xtext
.
Once the generation is complete, right click on project org.omg.sysml
, and select Run As > Eclipse Application. This should launch a new runtime Eclipse instance.
Add the SysML-v2-Pilot-Implementation Git repository (already cloned previously) to the runtime Eclipse instance.
Turn off Project > Build Automatically.
Import the projects kerml
, sysml
and sysml.library
into the runtime Eclipse workspace. (See the following section if you wish to create additional projects.)
Execute Project > Clean with the following settings:
sysml.library
: SelectedRepeat Project > Clean as above for kerml
and sysml
.
sysml.library
before building kerml
or sysml
.Double clicking on any .kerml
or .sysml
file will open it in the generated Xtext KerML or SysML editor.
(Optional) To show SysML diagrams, in Window > Show View > Other... menu, you can enable PlantUML view.
==== Initializing New SysML Model Projects
Open the New project wizard by selecting File > New > Project... menu item.
Select General/Project.
Give the project its expected name (and location if necessary), then press Next.
On the Project References page, check the sysml.library
project. This step tells Eclipse which other projects should be visible for resolving cross-references.
+
image:project-wizard.png[project wizard]
Right-click the new project and select Configure > Convert to an Xtext project. This step sets up the indexing infrastructure necessary for resolving references between different files.
Create any text files with .kerml
or .sysml
extensions to start working with a new file.
Note: Adding the project references to an existing project can be done in the project Properties dialog available from the popup menu on the project in the Project References page.
Note: If the Xtext setup (step 5) is missing, opening the KerML or SysML editor shows a dialog asking to convert the project to an Xtext project. Accepting this has the same results as manually selecting the menu item on the project.
== Copyright License Header
=== For new code Set up a Java code template as follows:
Window > Preferences (Mac-OS: Eclipse > Preferences)
Java > Code Style > Code Templates
Code > New Java files > Edit
Prepend (insert above the existing content) the following and modify the second line:
/**
=== For existing code
=== Sources