Skip to main content
Jump to: navigation, search

Papyrus-RT/User/User Guide/Installation

PapyrusForRealTime-Logo-Icon.png


Manual Installation of Papyrus for Real Time


Introduction

This tutorial will show you how to install Papyrus for Real Time.

Note: You will need Java 1.7 installed.

Note: The instructions in this tutorial are illustrated using Linux. Steps and images may differ slightly if the installation is done on a different operating system (both Windows and Mac OS are supported for developing models). Some of these differences have been indicated when known, but some may also be missing.


Install a base Eclipse platform

First, we will install a base Eclipse package upon which we will be able to add the required software component for Papyrus for Real Time.


Note: If you are installing into an existing Eclipse workbench, skip this step and go directly to step 2.


Install a base Eclipse package

  1. Go to http://eclipse.org/downloads/
  2. Download the "Eclipse IDE for Java Developers" package for your operating system
  3. Decompress the downloaded archive to a folder such as "~/Apps/Papyrus-RT" (folder name and location will vary depending on operating system)

Note: The base Eclipse IDE for Java Developers package does not include Papyrus, which is the base for Papyrus for Realtime. We will need to install Papyrus for Real Time after this base package is installed


PapyrusRT-install-a-base-eclipse-package.png

Start Eclipse

  1. Go to the folder where you extracted Eclipse (from the previous step)
  2. Run "eclipse" (the executable name and representation may vary depending on operating system - Linux shown below)

PapyrusRT-start-eclipse.png

Eclipse is now running

The "Welcome" view is the default view after installing Eclipse.


PapyrusRT-eclipse-is-now-running.png

Install Papyrus

Now that a base Eclipse environment is installed and available, we will install the remaining components needed for Papyrus for Real Time.


The base for Papyrus for Real Time is, of course, Papyrus UML. Since the base Eclipse IDE for Java Developers package we installed in the previous steps does not include Papyrus, let's install it first.


Because Papyrus for Real Time is not on the same release schedule as Papyrus, we will install a more recent update of Papyrus rather than the last formal release.


Install New Software

  1. Select the "Help > Install New Software" menu item

PapyrusRT-install-new-software.png

Add a new site

Papyrus for Real Time needs a recent versions of the Mars Papyrus installation, so we will install it from the it's update site. In order to do that, we need to add the "Papyrus Mars Release Updates" site to the list of available software site.

  1. Click on [Add...]

PapyrusRT-add-a-new-site.png

Add a new repository

In the resulting dialog, enter the following information:


  1. Name : Papyrus Mars updates
  2. Location : http://download.eclipse.org/modeling/mdt/papyrus/updates/releases/mars
  3. Click [OK]

PapyrusRT-add-a-new-repository.png

Select the software to install

  1. Select "Papyrus" (and nothing else)
  2. Click [Next]

PapyrusRT-select-the-software-to-install.png

Installation details

  1. Review the items to be installed, only Papyrus UML and its developer resources are of interest
  2. Note: The versions shown may be different from the ones you will see on your screen
  3. Click [Next]

PapyrusRT-installation-details.png

Review License and Agree to Terms

You will now need to review and accept the terms of the license agreement before installing.


  1. Read the terms
  2. Accept the terms by clicking on the radio button
  3. Click [Finish]

PapyrusRT-review-licenses.png

Restart the workbench

After all updated components have been downloaded and installed, you will have to restart the workbench.


  1. Click on [Yes]

PapyrusRT-restart-the-workbench.png

Papyrus is now installed in the Eclipse workbench

PapyrusRT-papyrus-is-now-installed-in-the-eclipse-workbench.png

Install the Papyrus for Real Time Components

Now that we have a good version of Papyrus, we can install the Papyrus for Real Time components:


  • The core and feature components for the user interface
  • The profile provides the DSML basics for UML-RT
  • The code generator translates the UML-RT model into C++ source code
  • The runtime service library provides the framework and infrastructure to be able to execute the code generated from UML-RT models The runtime service library also provides a UML model library of UML-RT constructs that are useful when modeling.

Install the new software

  1. Select the "Help > Install New Software" menu item

PapyrusRT-install-the-new-software.png

Add a new site

Because the Papyrus for Real Time is still in incubation and not part of the Mars release train, we will have to add a new location from which components can be installed.


  1. Click on [Add...]

PapyrusRT-add-a-new-site.png

Add a new repository

In the resulting dialog, enter the following information:


  1. Name : Papyrus-RT 0.7.1 Release
  2. Location : http://download.eclipse.org/papyrus-rt/updates/releases/mars/0.7.1/
  3. Click [OK]

PapyrusRT-add-a-new-repository-papyrusrt.png

Pick from available software

There is only one component, so the choice is easy


  1. Select the "PapyrusRT" item
  2. Click [Next]

PapyrusRT-pick-from-available-software.png

Review the items to install

After checking all the dependencies, you are presented with a dialog to "Review the items to be installed".


  1. Click [Next]

PapyrusRT-review-the-items-to-install.png

Review and accept License

One last time, you will now need to review and accept the terms of the license agreement for the new software before installing.


  1. Read the terms
  2. Accept the terms by clicking on the radio button
  3. Click [Finish]

PapyrusRT-review-licenses.png

Agree to install the software

As this software is still in incubation, some of the components are still unsigned.


  1. Click [OK]

PapyrusRT-agree-to-install-the-software.png

Restart the workbench

After all Papyrus for Real Time components have been downloaded and installed, you will have to restart the workbench.


  1. Click on [Yes]

PapyrusRT-restart-the-workbench.png

Switch to the Papyrus perspective

We can now switch to the Papyrus perspective in order to start modeling.


Close the welcome page

  1. Click on the big arrow, at the top right, to close the welcome view

PapyrusRT-close-the-welcome-page.png

Open the Papyrus Perspective

  1. Click on the "Open Perspective" button, just left of the Java Perspective
  2. Select the "Papyrus" entry
  3. Click [OK]

PapyrusRT-open-the-papyrus-perspective.png

[Optional] Remove the Java perspective

If you do not need the Java perspective, you can remove it.


  1. Right click on the Java perspective icon
  2. Select "Close"

PapyrusRT-optional-remove-the-java-perspective.png

Set the viewpoint for UML-RT

In order to get all the benefits from Papyrus for Real Time, you will need to set the correct Papyrus viewpoint.


Open Preferences

  1. Select "Window* > Preferences" ("****Eclipse > Preferences''" on Mac*)

PapyrusRT-open-preferences.png

Open and set Papyrus preferences

in the "Preferences" dialog:


  1. Expand "Papyrus"
  2. Select "Viewpoints Configuration"
  3. Select "Deployed through the extension point"
  4. Make sure that the following fields contain the right information: Stakeholder: UML-RT Modeler Viewpoint: UMLRT Viewpoint
  5. Click [OK]

PapyrusRT-open-and-set-papyrus-preferences.png

Done! You are now ready to create models!

PapyrusRT-InstallCongrats.png

Back to the top