Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Papyrus-RT/Developer/Developer Guide/DevEnv"
(Created page with "== Introduction == This tutorial will show you how to setup the development environment for Papyrus for Real Time using the Oomph-based Eclipse Installer. {{Note | Java 8 |...") |
|||
Line 13: | Line 13: | ||
First, you will need to download and install the Eclipse Installer. | First, you will need to download and install the Eclipse Installer. | ||
− | + | 1. Go to [http://wiki.eclipse.org/Eclipse_Installer http://wiki.eclipse.org/Eclipse_Installer] | |
− | + | 2. Download the "'''Eclipse Installer'''" package for your operating system | |
− | + | 3. Decompress the downloaded archive to a folder such as "'''~/Apps/EclipseInstaller/'''" ''(folder name and location will vary depending on operating system)'' | |
<div class="figure">[[Image:PapyrusRT-O-EclipseInstaller.png]] | <div class="figure">[[Image:PapyrusRT-O-EclipseInstaller.png]] | ||
Line 27: | Line 27: | ||
=== Start the Eclipse Installer === | === Start the Eclipse Installer === | ||
− | + | 4. Open the '''eclipse-installer''' folder and double-click on the '''eclipse-inst''' application. | |
<div class="figure">[[Image:PapyrusRT-O-StartSclipseInstaller.png]] | <div class="figure">[[Image:PapyrusRT-O-StartSclipseInstaller.png]] | ||
Line 43: | Line 43: | ||
However, the Papyrus-RT developer setup project is not available in the list of projects presented to you. You will have to manually add it to the list. | However, the Papyrus-RT developer setup project is not available in the list of projects presented to you. You will have to manually add it to the list. | ||
− | + | 5. Click on the icon at the top right. | |
<div class="figure">[[Image:papyrus-rt-dev-env-install-2.png]] | <div class="figure">[[Image:papyrus-rt-dev-env-install-2.png]] | ||
</div> | </div> | ||
− | + | 6. Select "'''Advanced Mode...'''" | |
This has for effect to restart the Eclipse Installer in the "Advanced Mode", which will allow you to specify an external setup file. | This has for effect to restart the Eclipse Installer in the "Advanced Mode", which will allow you to specify an external setup file. | ||
Line 59: | Line 59: | ||
You can now set up the Papyrus-RT configuration that will define the how to install the product. | You can now set up the Papyrus-RT configuration that will define the how to install the product. | ||
− | + | 7. Select '''Eclipse.org''' from the list. | |
− | + | 8. Click on the '''[>]''' left of '''Eclipse.org''' to unfold. | |
− | + | 9. Select '''Eclipse IDE for Eclipse Committers'''. In the bottom, under '''Product Version''' select '''Latest (Neon)'''. Under '''Java VM''' choose the appropriate Java 1.8 JVM (you may need to navigate through the file system to find the one you need). | |
<div class="figure">[[Image:papyrus-rt-dev-env-install-4.png]] | <div class="figure">[[Image:papyrus-rt-dev-env-install-4.png]] | ||
</div> | </div> | ||
− | + | 10. Click '''[Next]''' | |
<div class="figure">[[Image:papyrus-rt-dev-env-install-5.png]] | <div class="figure">[[Image:papyrus-rt-dev-env-install-5.png]] | ||
</div> | </div> | ||
− | + | 11. Drag and drop the setup file ([[File:papyrus-rt-developer.setup]]) onto the '''<User>''' folder. | |
=== Install the development components === | === Install the development components === | ||
− | + | 12. Unfold '''Papyrus-RT''' and check all the boxes on the left. | |
− | + | 13. In the bottom of the dialog make sure that the ''Stream'' field in each entry is set to '''master (Neon/1.0)''' (You may need to click on each and select the appropriate stream). | |
<div class="figure">[[Image:papyrus-rt-dev-env-install-6.png]] | <div class="figure">[[Image:papyrus-rt-dev-env-install-6.png]] | ||
</div> | </div> | ||
− | + | 14. Click '''[Next]'''. | |
<div class="figure">[[Image:papyrus-rt-dev-env-install-7.png]] | <div class="figure">[[Image:papyrus-rt-dev-env-install-7.png]] | ||
</div> | </div> | ||
− | + | 15. Choose your installation and workspace folders and enter your Eclipse password. You may customize these values and more by checking on '''Show all variables''' at the bottom. | |
− | + | 16. Click '''[Next]'''. | |
<div class="figure">[[Image:papyrus-rt-dev-env-install-8.png]] | <div class="figure">[[Image:papyrus-rt-dev-env-install-8.png]] | ||
</div> | </div> | ||
− | + | This shows the first set of tasks of the installation. The second set will be executed when Eclipse launches automatically. | |
− | + | 17. Click '''[Finish]'''. | |
<div class="figure">[[Image:papyrus-rt-dev-env-install-9.png]] | <div class="figure">[[Image:papyrus-rt-dev-env-install-9.png]] | ||
</div> | </div> | ||
− | + | 18. Click '''[Finish]'''. Eclipse will relaunch automatically. | |
<div class="figure">[[Image:papyrus-rt-dev-env-install-10.png]] | <div class="figure">[[Image:papyrus-rt-dev-env-install-10.png]] | ||
</div> | </div> | ||
− | + | 19. On the bottom right it says '''Executing startup tasks'''. You can leave it alone, but it will take a few minutes to complete. If you'd like to see the progress, you can click on the icon to the left of this message (two circling arrows) | |
<div class="figure">[[Image:papyrus-rt-dev-env-install-11.png]] | <div class="figure">[[Image:papyrus-rt-dev-env-install-11.png]] | ||
Line 117: | Line 117: | ||
</div> | </div> | ||
− | + | 20. When asked for '''Gerrit Code Review Repository Authentication''' enter your Eclipse user ID and password. | |
<div class="figure">[[Image:papyrus-rt-dev-env-install-13.png]] | <div class="figure">[[Image:papyrus-rt-dev-env-install-13.png]] | ||
</div> | </div> | ||
− | + | 21. During setup, a few dialogs like the following will pop up: | |
<div class="figure">[[Image:papyrus-rt-dev-env-install-14.png]] | <div class="figure">[[Image:papyrus-rt-dev-env-install-14.png]] | ||
Line 129: | Line 129: | ||
These will setup and synchronize the various MyLyn queries for Bugzilla and Gerrit. | These will setup and synchronize the various MyLyn queries for Bugzilla and Gerrit. | ||
− | + | 22. Once it's finished you can click '''[Finish]''' to close the setup dialog and click on '''Workbench''' in the Eclipse Welcome page. You should see something like this: | |
<div class="figure">[[Image:papyrus-rt-dev-env-install-15.png]] | <div class="figure">[[Image:papyrus-rt-dev-env-install-15.png]] | ||
</div> | </div> | ||
− | + | 23. If the '''Package Explorer''' shows individual plugin projects instead of Working sets as shown above, you can choose to show them by clicking on the down arrow shown at the top-right of the '''Package Explorer''' view, selecting '''Top Level Elements''' and then '''Working Sets'''. | |
<div class="figure">[[Image:papyrus-rt-dev-env-install-16.png]] | <div class="figure">[[Image:papyrus-rt-dev-env-install-16.png]] | ||
Line 156: | Line 156: | ||
# Select '''Generate Model Code''' | # Select '''Generate Model Code''' | ||
− | <div class="figure">[[Image:papyrus-rt-dev-env-install- | + | <div class="figure">[[Image:papyrus-rt-dev-env-install-17.png]] |
</div> | </div> | ||
Line 170: | Line 170: | ||
# Select '''Run As''' | # Select '''Run As''' | ||
# Select '''Generate Xtext Artifacts''' | # Select '''Generate Xtext Artifacts''' | ||
+ | |||
+ | <div class="figure">[[Image:papyrus-rt-dev-env-install-18.png]] | ||
+ | </div> | ||
You may still have a couple of errors related to some missing folders. To get rid of these, | You may still have a couple of errors related to some missing folders. To get rid of these, |
Revision as of 16:42, 12 April 2016
Contents
Introduction
This tutorial will show you how to setup the development environment for Papyrus for Real Time using the Oomph-based Eclipse Installer.
Install the Eclipse Installer
First, you will need to download and install the Eclipse Installer.
1. Go to http://wiki.eclipse.org/Eclipse_Installer 2. Download the "Eclipse Installer" package for your operating system 3. Decompress the downloaded archive to a folder such as "~/Apps/EclipseInstaller/" (folder name and location will vary depending on operating system)
Install the development environment for Papyrus for Real Time
Now that the installer is available, you can install the software.
Start the Eclipse Installer
4. Open the eclipse-installer folder and double-click on the eclipse-inst application.
You should see this:
Add Papyrus-RT to the list of projects
You have now started the Eclipse Installer.
However, the Papyrus-RT developer setup project is not available in the list of projects presented to you. You will have to manually add it to the list.
5. Click on the icon at the top right.
6. Select "Advanced Mode..."
This has for effect to restart the Eclipse Installer in the "Advanced Mode", which will allow you to specify an external setup file.
Set up the Papyrus-RT configuration
You can now set up the Papyrus-RT configuration that will define the how to install the product.
7. Select Eclipse.org from the list. 8. Click on the [>] left of Eclipse.org to unfold. 9. Select Eclipse IDE for Eclipse Committers. In the bottom, under Product Version select Latest (Neon). Under Java VM choose the appropriate Java 1.8 JVM (you may need to navigate through the file system to find the one you need).
10. Click [Next]
11. Drag and drop the setup file (File:Papyrus-rt-developer.setup) onto the <User> folder.
Install the development components
12. Unfold Papyrus-RT and check all the boxes on the left.
13. In the bottom of the dialog make sure that the Stream field in each entry is set to master (Neon/1.0) (You may need to click on each and select the appropriate stream).
14. Click [Next].
15. Choose your installation and workspace folders and enter your Eclipse password. You may customize these values and more by checking on Show all variables at the bottom.
16. Click [Next].
This shows the first set of tasks of the installation. The second set will be executed when Eclipse launches automatically.
17. Click [Finish].
18. Click [Finish]. Eclipse will relaunch automatically.
19. On the bottom right it says Executing startup tasks. You can leave it alone, but it will take a few minutes to complete. If you'd like to see the progress, you can click on the icon to the left of this message (two circling arrows)
When it finishes it will look like this:
20. When asked for Gerrit Code Review Repository Authentication enter your Eclipse user ID and password.
21. During setup, a few dialogs like the following will pop up:
These will setup and synchronize the various MyLyn queries for Bugzilla and Gerrit.
22. Once it's finished you can click [Finish] to close the setup dialog and click on Workbench in the Eclipse Welcome page. You should see something like this:
23. If the Package Explorer shows individual plugin projects instead of Working sets as shown above, you can choose to show them by clicking on the down arrow shown at the top-right of the Package Explorer view, selecting Top Level Elements and then Working Sets.
Generate code for EMF projects
At this point you will likely have errors shown in several projects. For each of the following projects (found under the Papyrus XtUML-RT working set), perform the steps below:
-
org.eclipse.papyrusrt.xtumlrt.common.model
-
org.eclipse.papyrusrt.xtumlrt.statemach.model
-
org.eclipse.papyrusrt.xtumlrt.statemach.ext.model
-
org.eclipse.papyrusrt.xtumlrt.umlrt.model
Steps:
- Unfold the project
- Unfold the model folder
- Open the 'XXX'
.genmodel
file (by double-clicking it), where 'XXX' is the name of the model. - In the opened EMF editor, right-click the root element (named 'XXX')
- Select Generate Model Code
- Do the same for each of the projects mentioned above.
Generate code for the Xtext project
- Under the Papyrus XtUML-RT working set, locate the
org.eclipse.papyrusrt.xtumlrt.xtext
project - Unfold the project
- Unfold the src folder
- Unfold the org.eclipse.papyrusrt.xtumlrt.xtext folder
- Right-click on the Tumlrt.xtext file
- Select Run As
- Select Generate Xtext Artifacts
You may still have a couple of errors related to some missing folders. To get rid of these,
- Go to the
org.eclipse.papyrusrt.xtumlrt.xtext.ide
project - Right-click on the project
- Select New
- Select Folder
- In the resulting dialog, set the name of the new folder to src
- Repeat, creating the folders src-gen and xtend-gen