# FDL22: Modeling with KIELER
## Getting the Best of Textual and Graphical Modeling

Here you can find a brief description on how to test the KLighD visualization for Turing machines as presented on the FDL'22 tutorial, as well as some links for further direction.

This tutorial is similar to the tutorial found here: https://github.com/kieler/KLighD/wiki/Lightweight-Diagrams-Tutorial
1. Download and unzip the the fdl22-tutorial-projects.zip file found next to this readme somewhere onto your system.
2. Make sure you have Java installed (tested with Java17),
3. then go through the first steps in that tutorial to install Eclipse with Modeling Tools (We suggest to use version 2022-03)
4. Install the *KIELER Lightweight Diagrams - Developer Resources & Examples* feature as in the tutorial, as well as *KIELER Lightweight Diagrams as Language Server* and *KIELER Lightweight Diagrams Generic Diagram View*. For this tutorial use the latest release: https://kieler.github.io/KLighD/v2.2.0/
5. After restarting, via the same window install *Eclipse Layout Kernel (Incubation) Layout Algorithms* from https://download.eclipse.org/elk/updates/releases/0.8.1/
6. Finally, via the same window also install *Xtext Complete SDK* from 2022-03 - https://download.eclipse.org/releases/2022-03
7. Import all projects unzipped in step 1 in your new Eclipse via *File>Import...>General>Existing Projects into Workspace*.

Now, your Eclipse should build all source projects. If something highlights with an error, go to *Project>Clean...>Clean all projects>Clean*, this should fix any remaining errors.

To open the KLighD visualization in a new Eclipse, do these steps:
1. Go to *Run>Run Configurations...* and run the Eclipse Application *Launch Runtime Eclipse*.
2. In the newly opened Eclipse, create a new project and copy the *.turingmachine* and *.turingdsl* files into it.
3. Open the file you want to view
4. Go to *Window>Show View>Other...>Diagram* (not the deprecated one)

To open the KLighD visualization in your browser, do these steps:
1. Download the KLighD CLI for your operating system from the latest KLighD-VS Code release, found as *klighd-[your OS] under *Assets* in: https://github.com/kieler/klighd-vscode/releases/tag/v0.4.0
2. make sure the KLighD CLI is executable on your systems (maybe you need to add the executable permission on your system)
3. In your Eclipse, go to *Run>Run Configurations...* and run the Java Application *Turingvis Language Server*.
4. Start the KLighD CLI via `./klighd-[your OS] --ls_port 5007 [path to the .turingmachine file you want to view]`. This should open the visualization in your default browser, we recommend using a Chromium-based browser for this.


## For further information
see KLighD: https://github.com/kieler/klighd

KLighD VSCode: https://github.com/kieler/klighd-vscode

and our project wiki: https://rtsys.informatik.uni-kiel.de/confluence/

or contact us: {nre, sdo, rvh}@informatik.uni-kiel.de