View source for Papyrus/customizations/robotics/devinstall

== Installation of Papyrus for Robotics development environment ==

Use the Papyrus for Robotics development environment, if you plan to extend or improve Papyrus for Robotics by contributing to its source code. In the sequel, we propose two different methods to install a suitable development environment.

=== Manual installation ===

* Install Papyrus SW designer (which in turn will install Papyrus itself and MARTE) using the following nightly [https://ci.eclipse.org/papyrus/job/papyrus-designer-2022-06/lastSuccessfulBuild/artifact/releng/org.eclipse.papyrus.designer.p2/target/repository/ update site] within a recent base Eclipse (2020-06).

* Install ESF Infra from its [https://ci.eclipse.org/esf/job/esf-infra-nightly-build/lastSuccessfulBuild/artifact/p2/target/repository/ update site]

* Install the necessary IDE extensions, notably
** Xtend SDK
** Acceleo
** QVT/o (optional, only if you plan to modify QVT transformation files)
** UML2 extender SDK (if you re-generate static profiles)

* Clone the Papyrus for Robotics [http://git.eclipse.org/c/papyrus/org.eclipse.papyrus-robotics.git git repository]

* Import the plugins contained in the git repository (notably in the "plugins" sub-folder) into your Eclipse installation.

=== Oomph installation ===

An Oomph installation process is available. It is similar to the one described for Papyrus itself: [[Papyrus/Papyrus_Developer_Guide/Papyrus_With_Oomph|Papyrus with Oomph]].
Download the [https://www.eclipse.org/downloads/ Eclipse installer] supporting Oomph. Then, download the [https://git.eclipse.org/c/papyrus/org.eclipse.papyrus-robotics.git/plain/releng/org.eclipse.papyrus.robotics.oomph/setups/papyrus-for-robotics.setup Papyrus-for-Robotics setup file].

After opening the Eclipse installer, change to the advanced mode and choose an "Eclipse IDE for committers". Then, use the "add" button, select the "Eclipse projects" catalog and browse the file system to the downloaded Papyrus-for-Robotics setup file (Step 1 in the figure below). Afterwards, you can select Papyrus for Robotics, as shown below.

<center>
[[Image:Papyrus-customizations-robotics-DevSetup.png|750px]]<br/>
Eclipse installer based on Oomph, Papyrus-for-Robotics selection
</center>

=== Overview of plugins ===

The Papyrus for Robotics (P4R) git is organized in the following way

  plugins/         plugin folder
  releng/          feature definition, RCP and update-site
  targetplatform/  target platform definitions, currently 2019-12 and 2020-06
  
The plugin folder has 5 main packages

  customization/   all plugins related to the Papyrus customization, e.g. diagram customization (Papyrus architecture framework), adapted property views, tables, ...
  examples/        example models
  faultinjection/  fault-injection examples (RobMoSys eITUS ITP)
  ros2/            ROS2 related plugins, notably code-generation, model-libraries (service definitions) and reverse-engineering mechanisms
  taskbasedriskanalysis/ risk analysis tables