SRRC Wiki

Service Robotics Research Center
at Ulm University of Applied Sciences

User Tools

Site Tools


smartmdsd-toolchain:installation

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
smartmdsd-toolchain:installation [2019/08/15 15:48]
Alex Lotz [Installation Instructions]
smartmdsd-toolchain:installation [2019/08/15 17:06] (current)
Dennis Stampfer
Line 26: Line 26:
 </​code>​ </​code>​
  
-If you just want to use the toolchain, then you are finished here and can try out the [[tutorials:​start|tutorials]]. In case if you require a more fine-controlled installation including non-standard plugins, then you can alternativelly use the advanced installer (explained next). +If you just want to use the toolchain, then you are finished here and can try out the [[tutorials:​start|tutorials]]. In case if you require a more fine-controlled installation including non-standard plugins, then you can alternativelly use the [[smartmdsd-toolchain:​installation-advanced|advanced ​installer]].
-===== Advanced Installation with the Eclipse OOMPH Installer (for users and developers) ===== +
- +
-You can use the **default Eclipse (OOMPH) installer** for which we provide **custom installer configuration** setup files (if you need a more customized installation). This section describes detailed step-by-step insallation instructions for how to configure the installer. In brief, the overall installation procedure consists of two main steps: +
- +
-  - Download the latest **[[https://​www.eclipse.org/​downloads/​|Eclipse (OOMPH) Installer]]**. +
-  - Download one of the provided installer configurations,​ and select it during installation within the Eclipse installer:​ +
-    * Toolchain **Users**: use **[[https://​github.com/​Servicerobotics-Ulm/​SmartMDSD-Toolchain/​blob/​master/​org.smartmdsd.infrastructure/​org.smartmdsd.installer/​SmartMDSD.runtime.setup|SmartMDSD.runtime.setup]]** if you are a user of the SmartMDSD Toolchain +
-    * Toolchain **Developers**:​ use **[[https://​github.com/​Servicerobotics-Ulm/​SmartMDSD-Toolchain/​blob/​master/​org.smartmdsd.infrastructure/​org.smartmdsd.installer/​SmartMDSD.github.setup|SmartMDSD.github.setup]]** if you want to contribute to the development of the SmartMDSD Toolchain +
- +
-Please also visit the **[[https://​github.com/​Servicerobotics-Ulm/​SmartMDSD-Toolchain|SmartMDSD Toolchain Github Repository]]** and its **[[https://​github.com/​Servicerobotics-Ulm/​SmartMDSD-Toolchain/​releases|public releases section]]**. +
- +
-==== 1. Download, extract and execute the latest Eclipse (OOMPH) Installer ==== +
- +
-Go to **[[https://​www.eclipse.org/​downloads/​|www.eclipse.org/​downloads]]** and download the latest **Eclipse (OOMPH) Installer**:​ +
- +
-{{ :smartmdsd-toolchain:​eclipsedownloadpage.png?​500 |}} +
- +
-It does not matter if you use a newer installer version than the one shown in the screenshot. Each Eclipse Installer version allows ​installation ​of different Eclipse versions. Later we will select the **Oxygen** version within the installer. +
- +
-After downloading,​ extract and execute the Eclipse Installer. +
- +
-{{ :smartmdsd-toolchain:​installer1.png?​600 ​|}} +
- +
-  - Open **Menu** (on the top right of the installer ​window) +
-  - //​Optionally://​ select **Update** to get the most recent version of the installer (after Update the installer will restart) +
-  - Select **Advanced Mode**... +
- +
-You should now see this window: +
- +
-{{ :​smartmdsd-toolchain:​installer2.png?​600 |}} +
- +
-  * Select the **Eclipse Modeling Tools** package +
-  * Select **Oxygen** as the Product Version +
-  * Select your **JDK 8** installation +
-  * Activate **Bundle Pool** (this is optional, yet highly recommended) +
-  * Press **Next** +
- +
-Now you can proceed with step 2. (see the following section). +
- +
-==== 2. Download and select a suitable installer configuration ==== +
- +
-Go to the **[[https://​github.com/​Servicerobotics-Ulm/​SmartMDSD-Toolchain|SmartMDSD Toolchain Github repository]]** and download one of the two different **installer configurations**:​ +
- +
-  * [[https://​github.com/​Servicerobotics-Ulm/​SmartMDSD-Toolchain/​tree/​master/​org.smartmdsd.infrastructure/​org.smartmdsd.installer]] +
- +
-From here on, proceed with one of the following two options: +
- +
-  * 2.1: if you want to start developing robotics components and systems +
-  * 2.2: if you want to dig into the details of the behind-the-scene realization of the toolchain plugins +
- +
- +
-=== 2.1 Setup the precompiled SmartMDSD Toolchain runtime version ​ === +
- +
-If you just like to try out the SmartMDSD Toolchain, or to start developing robotics components and systems, then please download the **[[https://​github.com/​Servicerobotics-Ulm/​SmartMDSD-Toolchain/​blob/​master/​org.smartmdsd.infrastructure/​org.smartmdsd.installer/​SmartMDSD.runtime.setup|SmartMDSD.runtime.setup]]**. +
- +
-Now go back to the Eclipse Installer and select the downloaded **installer configuration**:​ +
- +
-{{ :​smartmdsd-toolchain:​runtimeinstaller1a.png?​600 |}} +
- +
-  - Press the **+** icon to add our custom installer setup +
-  - Select **Eclipse Projects** in the Catalog drop-down menu +
-  - Press **Browse File System...** and select the downloaded **installer configuration** +
-  - Press **OK** +
- +
-You should now see this window: +
- +
-{{ :​smartmdsd-toolchain:​runtimeinstaller2.png?​600 |}} +
- +
-Press **Next** and you should see this window: +
- +
-{{ :​smartmdsd-toolchain:​runtimeinstaller3.png?​600 |}} +
- +
-Here you can configure some installation options, like the **installation location** where the SmartMDSD Toolchain should be installed into. Please keep **Oxygen** as the taget platform. Now press **Next** and you should see this window: +
- +
-{{ :​smartmdsd-toolchain:​runtimeinstaller4.png?​600 |}} +
- +
-Here just press **Finish** and the installation process will automatically download all the required Eclipse plugins (from the public Eclipse repositories) and the SmartMDSD Toolchain plugins (from our [[https://​web2.servicerobotik-ulm.de/​files/​SmartMDSD_Toolchain/​updatesite/​|hosted update site]]). During installation,​ the installer will ask to confirm the used licenses (like the **Eclipse Public License (EPL)** and the **BSD 3** License which is used by the SmartMDSD related plugins). +
- +
-{{ :​smartmdsd-toolchain:​runtimeinstaller6.png?​600 |}}  +
- +
-Please **accept** all these licenses as it is mandatory to complete the installation process. Furthermore,​ the installer will warn about **unsigned content** and ask for confirmation. At the moment, our SmartMDSD Toolchain plugin binaries are not yet signed with an official Eclipse certifacate,​ but rest assured, they are safe to use so please **accept** this warning: +
- +
-{{ :​smartmdsd-toolchain:​runtimeinstaller7.png?​600 |}} +
- +
-After the installation process finishes, a new Eclipse instance will be automatically started which now consist of all the required SmartMDSD Toolchain plugins. +
- +
-{{ :​smartmdsd-toolchain:​runtimeinstaller9.png?​600 |}} +
- +
-Here you can deactivate the option "​Always show Welcome at start up", and **close the Welcome page**. You can now use this Eclipse instance to develop robotics software components and systems. +
- +
-From here, you can have a look into the **[[tutorials:​start|Tutorials]]** sections that provides various examples for the usage of the SmartMDSD Toolchain. Have fun! +
- +
- +
- +
- +
- +
-=== 2.2 Setup the SmartMDSD Toolchain plugin sources === +
- +
-If you want to investigate the SmartMDSD Toolchain sources and to dig into the details, then please download the **[[https://​github.com/​Servicerobotics-Ulm/​SmartMDSD-Toolchain/​blob/​master/​org.smartmdsd.infrastructure/​org.smartmdsd.installer/​SmartMDSD.github.setup|SmartMDSD.github.setup]]** installer configuration file. +
- +
-The configuration of the installer is very similar to the runtime installation (see section 2.1), with the difference that another installer configuration file (see link above) is used. In the following, only the deviating screenshots (compared to 2.1) are presented. +
- +
-We assume that you have downloaded and execured the Eclipse installer as shown in section 1, as well as that you have selected the "​Eclipse Modeling Tools" package and pressed "​Next"​. Now you can select the downloaded ​ **[[https://​github.com/​Servicerobotics-Ulm/​SmartMDSD-Toolchain/​blob/​master/​org.smartmdsd.infrastructure/​org.smartmdsd.installer/​SmartMDSD.github.setup|SmartMDSD.github.setup]]** installer configuration file as shown in the next screenshot:​ +
- +
-{{ :​smartmdsd-toolchain:​gh-installer1.png?​600 |}} +
- +
-  - Press the **+** icon to add our custom installer setup +
-  - Select **Github Projects** in the Catalog drop-down menu +
-  - Press **Browse File System...** and select the downloaded **installer configuration** +
-  - Press **OK** +
- +
-You should now see this window: +
- +
-{{ :​smartmdsd-toolchain:​gh-installer2.png?​600 |}} +
- +
-Press **Next** to continue installation. In the next window you can configure some of the installation options like the **installation folder** and the **java runtime**. +
- +
-{{ :​smartmdsd-toolchain:​gh-installer3.png?​600 |}} +
- +
-In contrast to the runtime installer, here you can also select the **Github URL for the SmartMDSD Toolchain sources**. It is recommended to use the **HTTPS (read-only, anonymous)** option if you just want to read the sources. Keep **Oxygen** as the Target Platform and press **Next** to continue installation. In the next window, just press **Finish** to start the installation process. During installation,​ you will be asked to accept the required licenses and certificates that you should comply. At some point a new Eclipse instance will be automatically started as shown in the following screenshot:​ +
- +
-{{ :​smartmdsd-toolchain:​gh-installer4.png?​600 |}} +
- +
-Please note, when the new Eclipse Instance is automatically started, **the installation process is not yet finished**! Instead, the second part of the installation process continues that automatically clones the Github repository for the toolchain sources, imports them into a new Eclipse workspace and compiles the whole workspace. You can track the progress by clicking on the rotating icon at the bottom right in the Eclipse Window (see screenshot above). The compilation procedure will take some time (approx. 10 minutes). At the end you should see the confirmation about the completed installation process: +
- +
-{{ :​smartmdsd-toolchain:​gh-installer5.png?​600 |}} +
- +
-From here you can start a **Runtime Eclipse Instance** to see the compiled plugins in action by selecting the Eclipse menu: **Run** -> **Debug Configuration...**. You should see this dialog: +
- +
-{{ :​smartmdsd-toolchain:​gh-installer6.png?​700 |}} +
- +
-Select the **Launch-Runtime-Toolchain-v3.x** under "​Eclipse Applications"​ and press **Debug**. This will start a yet another Eclipse Instance that automatically loads and executes all the compiled workspace plugins. +
- +
-{{ :​smartmdsd-toolchain:​runtime1.png?​600 |}} +
- +
-You can use this instance to create new Domain Model Repositories,​ Components and Systems. It is recommended to open the **Modeling Perspective** as shown in the following screenshot:​ +
- +
-{{ :​smartmdsd-toolchain:​runtime2.png?​600 |}} +
- +
-This concludes the overall installation processHave fun!+
  
  
Line 174: Line 34:
 ===== Automatic Installation and Update Script ===== ===== Automatic Installation and Update Script =====
  
-As of December 2018, we are reworking the installation method of the SmartMDSD Toolchain. Script-Based installation is not supported at the moment. FIXME+//We are reworking the installation method of the SmartMDSD Toolchain. Script-Based installation is not supported at the moment.// FIXME
  
 <​del>​Launch the [[installer:​start|installer script as described]]. To install the SmartMDSD Toolchain exclusively,​ only select ''​2) Update/​Install SmartMDSD Toolchain''​. This will install the latest version to ''​~/​SOFTWARE/​SmartMDSD_Toolchain.latest/''​. Use the desktop launcher to start it. See [[tutorials:​start|tutorials]] on what to do next.</​del>​ <​del>​Launch the [[installer:​start|installer script as described]]. To install the SmartMDSD Toolchain exclusively,​ only select ''​2) Update/​Install SmartMDSD Toolchain''​. This will install the latest version to ''​~/​SOFTWARE/​SmartMDSD_Toolchain.latest/''​. Use the desktop launcher to start it. See [[tutorials:​start|tutorials]] on what to do next.</​del>​
smartmdsd-toolchain/installation.txt · Last modified: 2019/08/15 17:06 by Dennis Stampfer