Skip to content

Commit

Permalink
Updated org.omg.sysml.site for release.
Browse files Browse the repository at this point in the history
- Updated README.

- Changed referenced repository URL (temporarily) to
https://dl.bintray.com/himi-sysml/plantuml-sysmlv2/updates/1.1
  • Loading branch information
seidewitz committed Jul 15, 2020
1 parent 1bb61d3 commit cfa52ab
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 23 deletions.
Binary file modified org.omg.sysml.interactive/dist/sysmli.jar
Binary file not shown.
57 changes: 37 additions & 20 deletions org.omg.sysml.site/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SysML v2 Release 2020-03 Eclipse Installation
# SysML v2 Release 2020-06 Eclipse Installation

**Requirements:** Eclipse 2019-12 (4.14) or later, with Java Development Kit

Expand All @@ -10,7 +10,7 @@

3. Select `Add...` and then, in the add dialog, select `Archive...` .

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.) Click `Add`.
4. Navigate to the `org.omg.sysml.site-0.4.0.zip` archive and select it. (You can give it a name if you wish.) Click `Add`.

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

Expand Down Expand Up @@ -38,34 +38,51 @@ below, delete the `kerml`, `sysml` and `sysml.library` projects from your worksp
After installation is complete, if you wish to turn `Build Automatically` back on, first go to `Preferences > General > Workspace > Build`
and make sure that `sysml.library` is before `kerml` and `sysml` in the build order.

<br>
## Installing PlantUML graphical visualization

## Creating model files
Graphical visualization is available in Eclipse using the open source [PlantUML](https://plantuml.com) tooling to render diagrams.

1. Create Kernel Modeling Language (KerML) files in the `kerml/src` directory. The extension for a KerML file is `.kerml`.
0. Make sure that your Eclipse has PlantUML with SysMLv2 extensions. You can install it from the update site of [ https://dl.bintray.com/himi-sysml/plantuml-sysmlv2/updates/1.1](https://dl.bintray.com/himi-sysml/plantuml-sysmlv2/updates/1.1) with Help > Install New Software

2. Create Systems Modeling Language (SysML) files in the `sysml/src` directory. The extension for a SysML file is `.sysml`.
1. PlantUML visualization requires that [GraphViz](https://www.graphviz.org) be installed. Visit [ https://www.graphviz.org/download/](https://www.graphviz.org/download/)
and download the appropriate package for your environment.

2. If Eclipse cannot automatically find the path to the GraphViz executable, you can set it by going to `Preferences > PlantUML`.
For details, visit [ https://plantuml.com/en/eclipse](https://plantuml.com/en/eclipse).

## Working with model files

3. Alternatively, you can create a separate project for your KerML or SysML files. Create the project as a Java project, with
the `sysml.library` project on the build path.
1. Double click on a file with a `.kerml` or `.sysml` extension to view it in a Kernel Modeling Language (KerML) or Systems Modeling Language (SysML).

2. Create new KerML files in the `kerml/src` directory with the extension `.kerml`.

4. You can view the model library files in the `sysml.library` project, but *do not change them*.
2. Create new SysML files in the `sysml/src` directory with the extension `.sysml`.

3. You can view the model library files in the `sysml.library` project, but *do not change them*.

**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.
4. 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
in the active SysML editor view. Tree (BDD-like), interconnection (IBD-like) and state machine views are currently supported.

## Graphical visualization
**Release Note:** While performance has improved significantly in this release, there are still cases in which the processing of a file with
several name resolution errors can take a long time, particularly if the `Quantities and Units` library is being used.

This release includes a prototype graphical visualization capability with diagrams rendered using the open source [PlantUML](https://plantuml.com) tooling.
## Initializing new model projects

0. Make sure that your Eclipse has PlantUML with SysMLv2 extensions. You can install it from the update site of https://dl.bintray.com/himi-sysml/plantuml-sysmlv2/updates/ with Help > Install New Software
You can also create a separate project for your KerML or SysML files.

1. PlantUML visualization requires that [GraphViz](https://www.graphviz.org) be installed. Visit [ https://www.graphviz.org/download/](https://www.graphviz.org/download/)
and download the appropriate package for your environment.
1. Select `File > New > Project...` to open the New Project wizard.

2. If Eclipse cannot automatically find the path to the GraphViz executable, you can set it by going to `Preferences > PlantUML`.
For details, visit [ https://plantuml.com/en/eclipse](https://plantuml.com/en/eclipse).
2. Select `General/Project`.

3. Enter the project name (and location if necessary), then press Next.

4. On the Project References page, check the `sysml.library` project. This step tells Eclipse which other projects should be visible for resolving cross-references.

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

6. Create any text files with `.kerml` or `.sysml` extensions to start working with a new file.

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
in the active SysML editor view. Basic block definition (class) and state machine diagrams are currently supported.
**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 missed, 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.
Binary file modified org.omg.sysml.site/README.pdf
Binary file not shown.
5 changes: 2 additions & 3 deletions org.omg.sysml.site/category.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@
<description name="SysML v2 Pilot Implementation Update Site">
This site contains feature and plugin versions for the Eclipse-based pilot implementation of SysML v2, as developed by the SysML v2 Submission Team.
</description>
<repository-reference location="https://download.eclipse.org/releases/2019-12" enabled="true" />
<repository-reference location="https://dl.bintray.com/himi-sysml/plantuml-sysmlv2/updates/" enabled="true" />

<feature id="org.omg.sysml.feature">
<category name="KerML and SysML Editors"/>
</feature>
Expand All @@ -17,4 +14,6 @@
Xtext editors for the KerML and SysML textual notations.
</description>
</category-def>
<repository-reference location="https://download.eclipse.org/releases/2019-12" enabled="true" />
<repository-reference location="http://https://dl.bintray.com/himi-sysml/plantuml-sysmlv2/updates/1.1" enabled="true" />
</site>

0 comments on commit cfa52ab

Please sign in to comment.