You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: org.omg.sysml.site/README.md
+22-11Lines changed: 22 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,16 @@
1
-
# Eclipse Installation
1
+
# SysML v2 Release 2020-03 Eclipse Installation
2
2
3
-
Requirements: Eclipse 2019-06 (4.12) or later, with Java Development Kit
3
+
**Requirements:** Eclipse 2019-12 (4.14) or later, with Java Development Kit
4
4
5
5
## Installing the plugins
6
6
7
7
1. Open an Eclipse workspace.
8
8
9
9
2. Select `Help > Install New Software`.
10
10
11
-
3. Select `Add...` and then, in the add dialog, select `Local...` .
11
+
3. Select `Add...` and then, in the add dialog, select `Archive...` .
12
12
13
-
4. Navigate to the `org.omg.sysml.site` directory and select it. (You can give it a name if you wish.)
13
+
4. Navigate to the `org.omg.sysml.site-0.3.0.zip` archive and select it. (You can give it a name if you wish.)
14
14
15
15
5. In the Install window, select the `KerML and SysML Editors` category and click `Next`.
16
16
@@ -32,19 +32,30 @@ Requirements: Eclipse 2019-06 (4.12) or later, with Java Development Kit
32
32
33
33
**Important Note:** Import the `kerml` and `sysml` projects *only* after importing and building the `sysml.library` project.
34
34
35
+
After installation is complete, if you wish to turn `Build Automatically` back on, first go to `Preferences > General > Workspace > Build`
36
+
and make sure that `sysml.library` is before `kerml` and `sysml` in the build order.
37
+
35
38
## Creating model files
36
39
37
40
1. Create Kernel Modeling Language (KerML) files in the `kerml/src` directory. The extension for a KerML file is `.kerml`.
38
41
39
42
2. Create Systems Modeling Language (SysML) files in the `sysml/src` directory. The extension for a SysML fiile is `.sysml`.
40
43
41
44
3. You can view the model library files in the `sysml.library` project, but *do not change them*.
45
+
46
+
**Release Note:** In the current implementation, there are cases in which the processing of a file with several name resolution errors can take a very long time,
47
+
particularly if the `Quantities and Units` library is being used. This will be fixed in a future release.
42
48
43
-
3. After installation is complete, you can turn `Build Automatically` back on if you wish. However, if you ever experience excessive build times in either the KerML or SysML projects, do the following:
49
+
## Graphical visualization
50
+
51
+
This release includes a prototype graphical visualization capability with diagrams rendered using the open source [PlantUML](https://plantuml.com) tooling.
52
+
53
+
1. PlantUML visualization requires that [GraphViz](https://www.graphviz.org) be installed. Visit [https://www.graphviz.org/download/](https://www.graphviz.org/download/)
54
+
and download the appropriate package for your environment.
55
+
56
+
2. If Eclipse cannot automatically find the path to the GraphViz executable, you can set it by going to `Preferences > PlantUML`.
57
+
For details, visit [https://plantuml.com/en/eclipse](https://plantuml.com/en/eclipse).
58
+
59
+
3. To show SysML diagrams, in `Window > Show View > Other...` select the PlantUML view. The diagram rendered in the view is relative to the text selected
60
+
in the active SysML editor view. Basic block definition (class) and state machine diagrams are currently supported.
44
61
45
-
* Cancel any ongoing build.
46
-
* Turn `Build Automatically` off.
47
-
* Click on the `sysml.library` project and select `Project > Build Project`.
48
-
* Similarly rebuild the `kerml` and/or `sysml` projects as necessary.
49
-
50
-
**Release Note:** In the current implementation, there are cases in which the processing of a file with several name resolution errors can take a very long time, particularly if the `Quantities and Units` library is being used. This will be fixed in a future release.
0 commit comments