Skip to content

Commit d1f9c86

Browse files
committed
ST6RI-844 Update various README files.
1 parent 3a7e2a1 commit d1f9c86

File tree

4 files changed

+21
-24
lines changed

4 files changed

+21
-24
lines changed

README.adoc

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,11 @@ The project provides a configuration file for the https://wiki.eclipse.org/Eclip
1919
+
2020
image:installer-advanced.png[switch to advanced mode]
2121

22-
4. In the product list, select "Eclipse Modeling Tools" with Product Version: 2024-03.
22+
4. In the Products window, select "Eclipse Modeling Tools" with:
23+
* Product Version: 2025-03
24+
* Java VM: Java 21
2325

24-
5. 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.
26+
5. On the next page (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.
2527
* e.g. `file:/C:/git/sysml/SysML-v2-Pilot-Implementation/org.omg.sysml.installer/SysML2.setup`
2628
* **Note:** If you have installed the SysML v2 Pilot Implementation previously, this may already be pre-selected.
2729

@@ -30,9 +32,9 @@ image:installer-advanced.png[switch to advanced mode]
3032
image:oomph-projects.png[oomph projects]
3133

3234
7. On the next page, update the following variables, then press Next.
33-
* Git clone location rule: Select "Located in specific absolute folder location" and browse to the directory for the SysML git repository.
34-
* Root install folder: Change this if you wish the installation to be under a specific folder.
35-
* Workspace location rule: Change this if you wish to place the workspace at a specific location.
35+
* Installation folder name: Change this if you wish the installation to be under a specific folder.
36+
* Workspace folder name: Change this if you wish to place the workspace at a specific location.
37+
* Git clone location: Browse to the directory for the SysML git repository.
3638

3739
8. On the Confirmation page, press Finish.
3840

@@ -42,12 +44,12 @@ image:oomph-projects.png[oomph projects]
4244

4345
==== Manual installation
4446

45-
1. Install Eclipse 2024-03 (4.25) and Xtext.
47+
1. Install Eclipse 2025-03 (4.35) and Xtext.
4648
* Install the “Eclipse Modeling Tools” package.
47-
** `https://www.eclipse.org/downloads/packages/release/2024-03/r/eclipse-modeling-tools`
49+
** `https://www.eclipse.org/downloads/packages/release/2025-03/r/eclipse-modeling-tools`
4850

4951
* To install Xtext, select Help > Install New Software, use the update site URL given below, and install “Xtext Complete SDK” (under General Purpose Tools).
50-
** `http://download.eclipse.org/releases/2024-03`
52+
** `http://download.eclipse.org/releases/2025-03`
5153

5254
* (Optional) For PlantUML visualization, you need to install PlantUML-Eclipse with SysMLv2 extensions from
5355
the update site of `https://github.com/himi/p2-update-puml-sysmlv2/raw/main/updates` with Help > Install New Software.
@@ -67,19 +69,14 @@ image:oomph-projects.png[oomph projects]
6769
* `org.sysml.xtext.ide`
6870
* `org.sysml.xtext.ui`
6971

70-
**Note:**
71-
72-
* https://gradle.org/[Gradle] is used to build project `org.omg.sysml.jupyter`.
73-
* https://maven.apache.org/[Maven] is used to perform a coordinated build of all projects (including packaging the SysML Interactive JAR file that is used by `org.omg.sysml.jupyter`).
72+
4. https://maven.apache.org/[Maven] is used to perform a coordinated build of all projects (including packaging the SysML Interactive JAR file that is used by `org.omg.sysml.jupyter`).
7473
* To build the repository, invoke `mvn clean package` from the base `SysML-v2-Pilot-Implementation` directory.
7574
* If you have https://www.eclipse.org/m2e/[M2Eclipse] installed (with the Tycho Project Configurators connector), it can also launch a Maven build in Eclipse using the launch configuration in `SysML-v2-Pilot-Implementation/launch`.
7675

7776
=== Prototype SysML Implementation
7877

7978
==== Getting Started
80-
1. 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`.
81-
82-
2. 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.
79+
1. Right click on project `org.omg.sysml`, and select Run As > Eclipse Application. This should launch a new runtime Eclipse instance.
8380

8481
3. Add the SysML-v2-Pilot-Implementation Git repository (already cloned previously) to the runtime Eclipse instance.
8582

@@ -138,7 +135,7 @@ Set up a Java code template as follows:
138135
----
139136
/**
140137
* SysML 2 Pilot Implementation
141-
* Copyright (C) 2020 California Institute of Technology ("Caltech")
138+
* Copyright (C) 2025 <Your organization name>
142139
*
143140
* This program is free software: you can redistribute it and/or modify
144141
* it under the terms of the GNU Lesser General Public License as published by
@@ -161,7 +158,7 @@ Set up a Java code template as follows:
161158

162159
=== For existing code
163160
* When modifying existing code created by someone in a different organization, add a new copyright line, without changing anything else in the header.
164-
* When modifying existing code for the first time in a new year, add the year as the latest year in the appropriate copy right line. (E.g., in 2021, "Copyright (C) 2020" becomes "Copyright (C) 2020-2021" and in 2022 it becomes "Copyright (C) 2020-2022".)
161+
* When modifying existing code for the first time in a new year, add the year as the latest year in the appropriate copy right line. (E.g., in 2025, "Copyright (C) 2024" becomes "Copyright (C) 2024-2025" and in 2026 it becomes "Copyright (C) 2024-2026".)
165162

166163
=== Sources
167164
* https://www.gnu.org/licenses/gpl-3.0.en.html[GNU GPL v3.0 - How to Apply These Terms to Your New Programs]

org.omg.sysml.jupyter.installer/README.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
== All Operating Systems
44

5-
1. Install Java 11+, e.g. https://adoptopenjdk.net/index.html?variant=openjdk11&jvmVariant=hotspot[OpenJDK 11].
5+
1. Install Java 21+, e.g. https://adoptium.net/temurin/releases/?os=any&arch=any&version=21[OpenJDK 21].
66
* You can check the Java version you have installed by running `java -version` in Terminal (Linux / macOS) or Command Prompt (Windows). See https://www.baeldung.com/java-check-is-installed[How to Check if Java is Installed].
77
2. Install https://docs.conda.io/en/latest/miniconda.html[Miniconda] with Python version 3.x.
88
* **[Windows]** During installation, enable the "Add Anaconda to my PATH environment variable" option. See https://medium.com/@GalarnykMichael/install-python-on-windows-anaconda-c63c7c3d1444[Install Python on Windows]

org.omg.sysml.jupyter.kernel/README.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
= Jupyter SysML Kernel
22

3-
A http://jupyter.org/[Jupyter] kernel for executing SysML v2 models. The kernel executes models via the new SysML textual language. Some of the additional commands should be supported as needed via a syntax similar to the IPython magics.
3+
A http://jupyter.org/[Jupyter] kernel for executing SysML v2 models. The kernel executes models via the new SysML textual language.
44

55
Built on top of https://github.com/SpencerPark/jupyter-jvm-basekernel[jupyter-jvm-basekernel].
66

77
== Requirements
88

9-
1. http://www.oracle.com/technetwork/java/javase/downloads/index.html[Java >= 17].
9+
1. http://www.oracle.com/technetwork/java/javase/downloads/index.html[Java >= 21].
1010
2. Some Jupyter-like environment to use the kernel in. A non-exhaustive list of options:
1111
* http://jupyter.org/install[Jupyter]
1212
* http://jupyterlab.readthedocs.io/en/stable/getting_started/installation.html[JupyterLab]
@@ -28,7 +28,7 @@ Get the latest _release_ of the software with no compilation needed. See <<Insta
2828

2929
**Note:** if you have an old installation or a debug one from running `gradlew installKernel` it is suggested that it is first removed via `jupyter kernelspec remove sysml`.
3030

31-
1. Download the release from the [releases tab](.). A prepackaged distribution will be in an artifact named `sysml-jupyter-kernel-$version.zip`.
31+
1. Download the release from the https://github.com/Systems-Modeling/SysML-v2-Pilot-Implementation/releases[releases tab]. A prepackaged distribution will be in an artifact named `sysml-jupyter-kernel-$version.zip`.
3232

3333
2. Unzip it into a temporary location. It should have at least the `install.py` and `sysml` folder extracted in there.
3434

@@ -91,7 +91,7 @@ For example to set the heap size to `128m`:
9191

9292
=== Run
9393

94-
This is where the documentation diverges as each environment has its own way of selecting a kernel. To test from command line with Jupyter's console application run:
94+
Each Jupyter environment has its own way of selecting a kernel. To test from the command line with Jupyter's console application run:
9595

9696
[source,bash]
9797
----

org.omg.sysml.site/README.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
= SysML v2 Release Eclipse Installation
22

3-
*Requirements:* Eclipse 2024-03 (4.31), with Java Development Kit
3+
*Requirements:* Eclipse 2025-03 (4.35), with Java Development Kit
44

5-
(*Note:* The release may work on later versions of Eclipse, but it has only been tested on 2024-03.)
5+
(*Note:* The release may work on later versions of Eclipse, but it has only been tested on 2025-03.)
66

77
== Installing the plugins
88

0 commit comments

Comments
 (0)