Changes for page Running KEITH

Last modified by Richard Kreissig on 2023/09/14 08:48

From version < 36.1 >

edited by Soeren Domroes
on 2020/04/16 11:49

To version < 40.1 >

edited by Soeren Domroes
on 2020/08/12 11:46

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)
Objects (1 modified, 0 added, 0 removed)
- Confluence.Code.ConfluencePageClass[0]

Details

Page properties

Content

@@ -1,19 +1,26 @@
--= Running KEITH =
++{{layout}}
++{{layout-section ac:type="single"}}
++{{layout-cell}}
--
  {{toc maxLevel="2"/}}
++{{/layout-cell}}
++{{/layout-section}}
++{{layout-section ac:type="single"}}
++{{layout-cell}}
  == Setting up your Eclipse ==
--For everything not mentioned here refer to [[Getting Eclipse>>doc:KIELER.Getting Eclipse||shape="rect"]] guide.
++For everything not mentioned here refer to [[Getting Eclipse>>doc:KIELER.Getting Eclipse||shape="rect"]] guide. Choose the last Eclipse version and I personally recommend Eclipse for RCP & RAP developers since the Plug-In Development perspective is the default one. Another helpful perspective might be the Git perspective.
  Use the installer go to advanced mode, add the KIELER url. If you plan to develop for the semantic language server (e.g. for the compiler) you should select KIELER semantics for diagram only KIELER pragmatics. In any case select the keith stream.
--If you plan to develop in elk at the same time first select the Eclispe Layout Kernel setup and after that the semantics or pragmatics setup.
++If you plan to develop in elk at the same time first select the Eclispe Layout Kernel setup and after that either the semantics or pragmatics setup.
  Wait till everything installs and the setup tasks finish. If you have any problems in this stage refer to the [[Getting Eclipse>>doc:KIELER.Getting Eclipse||shape="rect"]] guide.
++Make sure that you have necessary forks of ELK/KlighD set up.
++
  If you have problems in the workspace that are still there after a clean build do the following:
  * Disable Project>Build automatically
@@ -20,7 +20,13 @@
  * Select all Klighd and pragmatics plugins and do Project>Clean>Only selected and build only selected
  * Do the same for the semantics projects
  * Enable Project>Build automatically
++{{/layout-cell}}
++{{/layout-section}}
++{{layout-section ac:type="two_equal"}}
++{{layout-cell}}
++== Legacy Eclipse Application ==
++
  To run the language server go to //Run Configurations// create a new E//clipse Application// run configuration and select //Run an application//  and //de.cau.cs.kieler.language.server.LanguageServer// (for semantics LS,//de.cau.cs.kieler.kgraph.language.server.LanguageServer// otherwise)
  == [[image:attach:Screenshot from 2019-02-15 14-10-50.png]] ==
@@ -41,8 +41,34 @@
  [[image:attach:Screenshot from 2019-02-15 14-13-34.png]]
--The default port to which KEITH tries to connect is 5007. You can of course change this for the languae server but be aware that this has to be changed in KEITH too.
++The default port to which KEITH tries to connect is 5007. You can of course change this for the language server but be aware that this has to be changed in KEITH too.
++\\
++{{/layout-cell}}
++
++{{layout-cell}}
++== Java Application ==
++
++To run the language server go to //Run Configurations// create a new //Java Application// run configuration.
++
++Select the **//Project//** //de.cau.cs.kieler.language.server// or //de.cau.cs.kieler.pragmatics.language.server// and the **Main class **//de.cau.cs.kieler.language.server.LanguageServer// or //de.cau.cs.kieler.pragmatics.language.server.PragmaticsLanguageServer//.
++
++[[image:attach:Screenshot from 2020-08-12 13-32-36.png]]
++
++In the next step all projects that you want to include in your language server have to be added to the classpath.
++
++Go to **Classpath**, select **User Entries**,  click** Add Projects...**, and select all required projects (if you are unsure just add all of them).
++
++Click on **Advanced**>**Add Folders** add select the project folders of all projects you added earlier.
++
++In the **Arguments** tab make sure to add //-Dport=5007// to the **VM arguments**.
++
++\\
++{{/layout-cell}}
++{{/layout-section}}
++
++{{layout-section ac:type="single"}}
++{{layout-cell}}
  == Setting up a KEITH developer setup... ==
  General requirements:
@@ -59,11 +59,11 @@
  (Theia has a [[guide >>url:https://www.theia-ide.org/doc/authoring_extensions||shape="rect"]]for extension development that might be helpful)
--install node 8:
++install node (for the version we refer to the Theia developer guide):
  {{code}}
  curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.5/install.sh | bash
--nvm install 8
++nvm install 10
  {{/code}}
  Install python if you haven't (remember: Python 2: , Python 3: ).
@@ -84,7 +84,7 @@
  == ... on windows: ==
--Install [[node 8>>url:https://nodejs.org/download/release/v8.15.0/||shape="rect"]] for windows. I personally used the {{code language="none"}}.msi{{/code}}.
++Install [[node>>url:https://nodejs.org/download/release/v8.15.0/||shape="rect"]] for windows. I personally used the {{code language="none"}}.msi{{/code}}. For the version refer to the Theia developer guide.
  Use that to install windows-build-tools by executing the command in an administrative powershell.
@@ -153,8 +153,12 @@
  {{info}}
  If you previously build keith electron, you have to execute {{code language="none"}}yarn run rebuild:electron{{/code}}
  {{/info}}
++{{/layout-cell}}
++{{/layout-section}}
--== Running the already build LS (you normally do not want to do this) ==
++{{layout-section ac:type="two_equal"}}
++{{layout-cell}}
++== Running the already build LS (legacy, you normally do not want to do this) ==
  Go to the latest [[Bamboo build>>url:https://rtsys.informatik.uni-kiel.de/bamboo/browse/KISEMA-NSI||shape="rect"]] and go to Artifacts.
@@ -180,6 +180,26 @@
  -Dport=5007
  {{/code}}
++\\
++
++\\
++{{/layout-cell}}
++
++{{layout-cell}}
++== Running the already build LS ==
++
++Go to the latest [[Bamboo build>>url:https://rtsys.informatik.uni-kiel.de/bamboo/browse/KISEMA-TSIWE/latest||shape="rect"]] and go to Artifacts.
++
++Select the language server for your OS (this will be a jar file) and run it via:
++
++{{code}}
++java -Dport=5007 -jar <name-of-the-jar-file>
++{{/code}}
++{{/layout-cell}}
++{{/layout-section}}
++
++{{layout-section ac:type="single"}}
++{{layout-cell}}
 is the standard port KEITH is currently connecting to in socket mode. You can find this port in your Theia application at the following location:
  Assume you are in the [[keith >>url:https://git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/keith/browse||shape="rect"]]repository. Go to {{code language="none"}}keith-app{{/code}}, you should see something like this:
@@ -202,7 +202,11 @@
  \\
  The {{code language="none"}}LSP_PORT{{/code}} option is used to activate the connection via socket. It is also possible to specify a relative location to a LS via {{code language="none"}}LS_PATH=<path to LS>{{/code}}.
++{{/layout-cell}}
++{{/layout-section}}
++{{layout-section ac:type="single"}}
++{{layout-cell}}
  = Known Issues =
  === Known issues for windows: ===
@@ -232,5 +232,6 @@
  yarn
  {{/code}} already builds the correct sources).
  )))
--
--\\
++{{/layout-cell}}
++{{/layout-section}}
++{{/layout}}

Confluence.Code.ConfluencePageClass[0]

Id

@@ -1,1 +1,1 @@
--75694098
++88310090

URL

@@ -1,1 +1,1 @@
--https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/75694098/Running KEITH
++https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/88310090/Running KEITH

Changes for page Running KEITH

Summary

Details

Navigation

Quick Links