Installing Lyo Designer¶

Installing from a ready-built package (recommended)¶

Make sure you have Java 17 installed on your platform.
Download the Lyo Designer application for your target operating system from the stable track (recommended) or development track (normally, at your risk, unless instructed by the dev team).
Unzip your download to any desired application.
Run the lyodesigner executable.
Regularly try to update the application by selecting Help → Check for Updates

Pro tip: which Lyo Designer version do I need?

Normally, you want the latest stable version as linked above.

The latest development version is usually a risky choice, but could be good to access latest features (esp. if there was no stable release in the last 6 months), or to open projects that are using the development version already (e.g., we normally apply latest development version of Lyo Designer on the Reference Implementation project).

Older versions may be useful to open an older project where its import crashes in the newer versions of Lyo Designer. Normally, this should not happen - latest versions of Lyo Designer can recognize older versions of the metamodel and display warnings when some parts of the opened model need to me updated. You can check the version of the Lyo Designer used to generate your project by looking for the Generated by Lyo Designer #.#.#.xxx comment in your Application.java file (example).

Older versions can be downloaded from the Releases page.

Installing as plugins on an Eclipse installation¶

You can also install Lyo Designer as a set of plugins into an existing Eclipse installation. This is recommended for advanced users that can deal with conflicts in plugin dependencies when installing multiple plugins.

Prerequisites: the Modelling environment and code generator are known to work on Eclipse versions up until Eclipse 2022-03.

Installation steps:

First make sure your Eclipse environment is setup as expected for general Lyo-based development, as instructed in Eclipse Setup for Lyo-based Development
Select Help → Install New Software...
Set Work With: to the update site
1. Use http://download.eclipse.org/lyo/p2/stable/ for the stable build (recommended)
2. Use https://download.eclipse.org/lyo/product/p2/edge for the latest unreleased build (use at your risk!)
Select both features (1) Lyo Code Generator and (2) Lyo Toolchain Designer.
Proceed with the installation steps.
Install the following plugins
- Acceleo
- Sirius Integration with Xtext
- Sirius Properties Views - Runtime Support
- Sirius Properties Views - Specifier Support
- Sirius Specifier Environment

Problems installing?

If you face problems installing the plugin (or when updating to a new version), try one of the following:

Make sure the correct update site is selected in the dropdown. DO NOT check the "Contact all update sites during install to find required software" option.
Check/uncheck "Group items by category" (particularly the case, if you get the message "there are no categorized items").
Uninstall existing version and then re-install the plugin again.

Switching to development track plugins at a later point¶

USE AT YOUR RISK

You can configure the Lyo Designer application to get updates from yet-unreleased builds of Lyo Designer.

Select Window → Preferences
Select Install/Update → Available Software Sites
Either enable or create a new site with the location https://download.eclipse.org/lyo/product/p2/edge
Click Apply and Close.
Update the application by selecting help → Check for Updates

Running from source¶

Prerequisites¶

Install JDK 17 and ensure it is the default JDK on your systems. For example, using winget:

winget install -e --id EclipseAdoptium.Temurin.17.JDK

Eclipse installation¶

Get a fresh install of Eclipse IDE for Enterprise Java and Web Developers (version 2022-03 R). Do not use Eclipse Installer.

Open the Eclipse IDE and do a preliminary setup:

Uncheck Project → Build Automatically
Add your JDK 17 under Window → Preferences → Java → Installed JREs. Make sure it is selected by default.

Install required plugins from Eclipse:

Open Help → Install New Software...
Select 2022-03 under Work with
Uncheck the Contact all update sites during install to find required software
Select the following plugins:
Modeling → Acceleo
Modeling → Sirius Specifier Environment
Modeling → EMF - Eclipse Modeling Framework SDK (not EclipseRT Target Platform Components → EMF - Eclipse Modeling Framework SDK)

Risk of breaking your installation

You must ensure that all plugin installations are done with the Contact all update sites during install to find required software option UNCHECKED. Leaving it checked could lead to incompatible newer versions of plugin dependencies to be pulled.

Install required plugins from Eclipse Lyo:

Open Help → Install New Software...
Paste https://download.eclipse.org/lyo/bundle/p2/edge/ under Work with and press Enter.
Select the entire Lyo OSGi Bundles group

Ignore the SLF4J resolution error

When installing Lyo OSGi Bundles with the Contact all update sites during install to find required software option unchecked, you may encounter resolution warnings for the slf4j.api plugin. Proceed with Keep my installation the same and modify the items being installed to be compatible.

Import Lyo Designer sources:

Clone this repository
Run mvn clean install on the model projects (or from the repository root) to generate the model code.
Open File → Import Projects
Use the Import Existing Projects
Provide the path to the cloned repository under Import Existing Projects and import all projects.

Initial setup:

Select Project → Clean... and build the entire workspace.
Create a new Eclipse Application configuration called Lyo Designer:
Select Run → Run Configurations ...
Select Eclipse Application
Press New button to create a new configuration
- In the new dialog, Set name to Lyo Designer
- In Arguments tab, change VM argument value to -Xms256m -Xmx2048m

Validation problems on launch

When launching the child IDE, two validation problems can be safely ignored:

jakarta.xml.bind-api
org.apache.xalan