Skip to content

Commit 60d693a

Browse files
committed
ST6RI-179 Updated org.omg.sysml.site README.
1 parent 0105a77 commit 60d693a

2 files changed

Lines changed: 22 additions & 11 deletions

File tree

org.omg.sysml.site/README.md

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
# Eclipse Installation
1+
# SysML v2 Release 2020-03 Eclipse Installation
22

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
44

55
## Installing the plugins
66

77
1. Open an Eclipse workspace.
88

99
2. Select `Help > Install New Software`.
1010

11-
3. Select `Add...` and then, in the add dialog, select `Local...` .
11+
3. Select `Add...` and then, in the add dialog, select `Archive...` .
1212

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.)
1414

1515
5. In the Install window, select the `KerML and SysML Editors` category and click `Next`.
1616

@@ -32,19 +32,30 @@ Requirements: Eclipse 2019-06 (4.12) or later, with Java Development Kit
3232

3333
**Important Note:** Import the `kerml` and `sysml` projects *only* after importing and building the `sysml.library` project.
3434

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+
3538
## Creating model files
3639

3740
1. Create Kernel Modeling Language (KerML) files in the `kerml/src` directory. The extension for a KerML file is `.kerml`.
3841

3942
2. Create Systems Modeling Language (SysML) files in the `sysml/src` directory. The extension for a SysML fiile is `.sysml`.
4043

4144
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.
4248

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.
4461

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.

org.omg.sysml.site/README.pdf

3.04 KB
Binary file not shown.

0 commit comments

Comments
 (0)