Papyrus README
Table of Contents
INTRODUCTION
One component of CSE435 is producing UML diagrams. For this task, we will make use of Papyrus, which is a plugin for Eclipse.
A complete overview of the installation may be found here:
http://www.eclipse.org/modeling/mdt/papyrus/updates/index.php
What follows is a step-by-step guide on how to install and run Papyrus successfully, including a small tutorial and issues that I found during the installation process.
Last revision: Erik Fredericks, 2011
REQUIRED DOWNLOADS
> Java Runtime Environment
Eclipse is built with Java, and you must have the Java Runtime Environment installed for it to function.
It may be downloaded here: Java Runtime Environment
> Eclipse Modeling Package
Eclipse is available for Windows, Linux, and Mac OS in both 32 and 64 bit versions. The flavor of Eclipse required for this course is the Eclipse Modeling Package, Helios version, and that may be downloaded here:
Eclipse Modeling Package - Helios
> Papyrus
No separate download is required for Papyrus, as it can be installed through the Discovery interface within Eclipse. If you wish to install it separately, please follow the instructions located on the Eclipse website (from the link in the introduction).
> Papyrus Diagram Export Module
In order to properly export UML diagrams from Papyrus, a separate export module is required. This will enable you to output diagrams in various image formats.
The general walkthrough is available here:
Walkthrough
Here are direct links to the files required:
- Image Export Plugin
- Logging Plugin
INSTALLATION
> Installing the Java Runtime Environment
Simply visit the website mentioned in the installation section, and follow the instructions for updating Java on your machine.
> Installing Eclipse
Unzip the archive that you downloaded to your preferred location. No installation is actually required, as Eclipse is self-contained within the archive.
> Installing Papyrus
Run Eclipse. Open the Help menu, and select Install Modeling Components. Select Papyrus, and follow the steps provided by Eclipse.
> Installing the Image Export Plugin
Unzip the archive, and browse inside the 'eclipse' folder within the unzipped archive. Contained within should be a 'features' and a 'plugins' folder. Copy those into the directory containing your installation of Eclipse (ie ./eclipse). The files contained within should be copied into their proper locations. Please note that these directories already exist, and you are simply copying the new plugins into those directories.
> Installing the Logging Plugin
Unzip the archive, and copy the unzipped files into your installed Eclipse plugin directory (./eclipse/plugins/).
QUICK TUTORIAL
> To create a new Papyrus project:
- File -> New -> Papyrus Project
- Specify a project name and click 'Next'
- Ensure 'UML' is checked and click 'Next'
- Specify a diagram name and select your preferred diagram type (this tutorial will use UML_Class_Diagram)
You can update the main window with different types of nodes, accessible either from the Palette window, or from the top menu
(Papyrus -> Diagrams -> ...).
> Insert a Class node into the main window.
Select the new Class node from either method above.
- In the bottom window, you can update the Class name and various other parameters.
- You can add attributes, operations, or nested classifiers to the compartments within the newly created class.
To do so, simply drag and drop the component that your require.
- For instance, you can add a new Property node to the new class by dragging a Property node into the 2nd compartment
of the class
NOTES
> 32 vs 64 bit installation
In order for Eclipse to run properly, your version of the Java Runtime Environment must match Eclipse. If you are using a 32-bit version of the JRE, then you must also use a 32 bit version of Eclipse. The same is true for the 64-bit version.
If you attempt to mix bit versions, then Eclipse will fail to run.
> Other Operating Systems
I put this README together while running Windows 7 (64 bit). If there are issues in installing this software for Mac or Linux, please follow the general directions posted in the introductory paragraph by viewing the installation notes for your particular distribution. The only real OS dependencies should be in installing the Java Runtime Environment and Eclipse...Papyrus should be platform-independent.