Changes for page Running KEITH

Last modified by Richard Kreissig on 2023/09/14 08:48
<
From version < 3.1 >
edited by Soeren Domroes
on 2019/02/15 13:19
To version < 5.1 >
edited by Soeren Domroes
on 2019/02/15 14:29
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,48 +1,33 @@
1 -== Running the already build LS ==
1 +== Setting up your eclipse ==
2 2  
3 -Go to the latest [[Bamboo build>>url:https://rtsys.informatik.uni-kiel.de/bamboo/browse/KISEMA-NSI||shape="rect"]] and go to Artifacts.
3 +For everything not mentioned here refer to [[Configuring Eclipse>>doc:KIELER.Configuring Eclipse||shape="rect"]] guide.
4 4  
5 -[[image:attach:image2019-2-7_17-46-58.png]]
5 +Use the installer go to advanced mode, add the KIELER url. Then select first pragmatics and after that semantics (that is very important).
6 6  
7 -Select Language Server Zip and download the LS and unpack it somewhere.
7 +Select the Theia stream for semantics and the Keith stream for pragmatics and use the latest eclipse if possible. Set the targetplatform to photon and finish.
8 8  
9 -Locate the kieler.ini file. Depending on the OS it has a different location (linux; toplevel, windows, toplevel, mac: Content/Eclipse/kieler.ini)
9 +Wait till everything installs and the setup tasks finish. If you have any problems in this stage refer to the [[Configuring Eclipse>>doc:KIELER.Configuring Eclipse||shape="rect"]] guide.
10 10  
11 -Paste the following at the beginning of the ini-file:
11 +\\
12 12  
13 -{{code language="bash"}}
14 --application
15 -de.cau.cs.kieler.language.server.LanguageServer
16 --noSplash
17 -{{/code}}
13 +The setup tasks for Modular Target will fail. Disable it after this happens and execute them again via //Help>Perform Setup Tasks//. Run //clean build//. Several pragmatics projects have error. Just close them and you will be fine.
18 18  
19 -Since an eclipse application is built, this is needed to start the LS without a splashscreen.
15 +To run the language server go to //Run Configurations// create a new //eclipse application// run configuration and select //Run an application//  and //de.cau.cs.kieler.language.server.LanguageServer//
20 20  
21 -If you want to connect that LS via socket to your Theia application (KEITH) add the following to the vmargs:
17 +== [[image:attach:Screenshot from 2019-02-15 14-10-50.png]] ==
22 22  
23 -{{code}}
24 --Dport=5007
25 -{{/code}}
19 +\\
26 26  
27 -5007 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:
21 +You have to edit the arguments too. The Vm arguments host and port are added to connect the LS via socket.
28 28  
29 -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:
23 +[[image:attach:Screenshot from 2019-02-15 14-13-34.png]]
30 30  
31 -[[image:attach:image2019-2-7_17-58-22.png]]
25 +The default port to which KEITH tries to connect is 5007.
32 32  
33 -Open the {{code language="none"}}package.json{{/code}}. In the{{code language="none"}} package.json{{/code}} are several scripts defined.
34 -
35 -[[image:attach:image2019-2-7_18-0-7.png]]
36 -
37 -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}}.
38 -
39 -You can also set these options for an already build [[keith electron app>>url:http://rtsys.informatik.uni-kiel.de/~~kieler/files/nightly/sccharts-integration/||shape="rect"]].
40 -
41 41  == Setting up a KEITH developer setup... ==
42 42  
43 43  General requirements:
44 44  
45 -* Java (for eclipse, you know how to get Java)
46 46  * node
47 47  * npm (whatever node installs)
48 48  * yarn (latest version)
... ... @@ -49,7 +49,6 @@
49 49  * Python (2.7.X)
50 50  * gcc, g++, and make (for native dependencies of some npm packages)
51 51  * [[Visual Studio Code>>url:https://code.visualstudio.com/||shape="rect"]] (latest version)
52 -* eclipse installer
53 53  * a cloned [[keith >>url:https://git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/keith/browse||shape="rect"]]repository
54 54  
55 55  == ... on linux: ==
... ... @@ -103,46 +103,60 @@
103 103  xcode-select --install
104 104  {{/code}}
105 105  
106 -\\
90 +After doing this for your OS all that is missing is running KEITH (in developer setup) and setting up your eclipse for language server development).
107 107  
108 -\\
92 += Stuff that may help =
109 109  
110 -After doing this for your OS all that is missing is running KEITH (in developer setup) and setting up your eclipse for language server development).
94 +== Running the already build LS ==
111 111  
112 -== How run KEITH in developer setup (socket) ==
96 +Go to the latest [[Bamboo build>>url:https://rtsys.informatik.uni-kiel.de/bamboo/browse/KISEMA-NSI||shape="rect"]] and go to Artifacts.
113 113  
114 -Run the following to build and run KEITH in its developer setup (in socket mode, so the LS has to be started separately)
98 +[[image:attach:image2019-2-7_17-46-58.png]]
115 115  
100 +Select Language Server Zip and download the LS and unpack it somewhere.
101 +
102 +Locate the kieler.ini file. Depending on the OS it has a different location (linux; toplevel, windows, toplevel, mac: Content/Eclipse/kieler.ini)
103 +
104 +Paste the following at the beginning of the ini-file:
105 +
116 116  {{code language="bash"}}
117 -yarn && cd keith-app && yarn run socket
107 +-application
108 +de.cau.cs.kieler.language.server.LanguageServer
109 +-noSplash
118 118  {{/code}}
119 119  
120 -Per default the KEITH opens on localhost:3000.
112 +Since an eclipse application is built, this is needed to start the LS without a splashscreen.
121 121  
122 -It is required to restart the language server if KEITH is restarted, sicne the diagram view has a problem (since theia-sprotty is used) to reconnect after that.
114 +If you want to connect that LS via socket to your Theia application (KEITH) add the following to the vmargs:
123 123  
124 -== Setting up your eclipse ==
116 +{{code}}
117 +-Dport=5007
118 +{{/code}}
125 125  
126 -For everything not mentioned here refer to [[Configuring Eclipse>>doc:KIELER.Configuring Eclipse||shape="rect"]] guide.
120 +5007 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:
127 127  
128 -Use the installer go to advanced mode, add the kieler url. Then select first pragmatics and after that semantics (that is very important).
122 +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:
129 129  
130 -Select the Theia stream for both of them and use the latest eclipse if possible. Set the targetplatform to photon and finish.
124 +[[image:attach:image2019-2-7_17-58-22.png]]
131 131  
132 -Wait till everything installs and the setup tasks finish. If you have any problems in this stage refer to the [[Configuring Eclipse>>doc:KIELER.Configuring Eclipse||shape="rect"]] guide.
126 +Open the {{code language="none"}}package.json{{/code}}. In the{{code language="none"}} package.json{{/code}} are several scripts defined.
133 133  
134 -\\
128 +[[image:attach:image2019-2-7_18-0-7.png]]
135 135  
136 -The setup tasks might fail. Disable Modular Target and Theia Target (Theia Target2 is the right target) and repeat them.
130 +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}}.
137 137  
138 -To run the language server go to //Run Configurations// create a new //eclipse application// run configuration and select //Run an application//  and //de.cau.cs.kieler.language.server.LanguageServer//
132 +You can also set these options for an already build [[keith electron app>>url:http://rtsys.informatik.uni-kiel.de/~~kieler/files/nightly/sccharts-integration/||shape="rect"]].
139 139  
140 -== [[image:attach:Screenshot from 2019-02-15 14-10-50.png]] ==
141 -
142 142  \\
143 143  
144 -You have to edit the arguments too. The Vm arguments host and port are added to connect the LS via socket.
136 +== How run KEITH in developer setup (socket) ==
145 145  
146 -[[image:attach:Screenshot from 2019-02-15 14-13-34.png]]
138 +Run the following to build and run KEITH in its developer setup (in socket mode, so the LS has to be started separately)
147 147  
148 -The default port to which KEITH tries to connect is 5007.
140 +{{code language="bash"}}
141 +yarn && cd keith-app && yarn run socket
142 +{{/code}}
143 +
144 +Per default the KEITH opens on localhost:3000.
145 +
146 +It is required to restart the language server if KEITH is restarted, since the diagram view has a problem (since theia-sprotty is used) to reconnect after that.
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -54198533
1 +56852516
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/54198533/Running KEITH
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/56852516/Running KEITH

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage