Changes for page Running KEITH

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

Summary

Details

Page properties
Content
... ... @@ -1,33 +1,48 @@
1 -== Setting up your eclipse ==
1 +== Running the already build LS ==
2 2  
3 -For everything not mentioned here refer to [[Configuring Eclipse>>doc:KIELER.Configuring Eclipse||shape="rect"]] guide.
3 +Go to the latest [[Bamboo build>>url:https://rtsys.informatik.uni-kiel.de/bamboo/browse/KISEMA-NSI||shape="rect"]] and go to Artifacts.
4 4  
5 -Use the installer go to advanced mode, add the KIELER url. Then select first pragmatics and after that semantics (that is very important).
5 +[[image:attach:image2019-2-7_17-46-58.png]]
6 6  
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.
7 +Select Language Server Zip and download the LS and unpack it somewhere.
8 8  
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.
9 +Locate the kieler.ini file. Depending on the OS it has a different location (linux; toplevel, windows, toplevel, mac: Content/Eclipse/kieler.ini)
10 10  
11 -\\
11 +Paste the following at the beginning of the ini-file:
12 12  
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.
13 +{{code language="bash"}}
14 +-application
15 +de.cau.cs.kieler.language.server.LanguageServer
16 +-noSplash
17 +{{/code}}
14 14  
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//
19 +Since an eclipse application is built, this is needed to start the LS without a splashscreen.
16 16  
17 -== [[image:attach:Screenshot from 2019-02-15 14-10-50.png]] ==
21 +If you want to connect that LS via socket to your Theia application (KEITH) add the following to the vmargs:
18 18  
19 -\\
23 +{{code}}
24 +-Dport=5007
25 +{{/code}}
20 20  
21 -You have to edit the arguments too. The Vm arguments host and port are added to connect the LS via socket.
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:
22 22  
23 -[[image:attach:Screenshot from 2019-02-15 14-13-34.png]]
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:
24 24  
25 -The default port to which KEITH tries to connect is 5007.
31 +[[image:attach:image2019-2-7_17-58-22.png]]
26 26  
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 +
27 27  == Setting up a KEITH developer setup... ==
28 28  
29 29  General requirements:
30 30  
45 +* Java (for eclipse, you know how to get Java)
31 31  * node
32 32  * npm (whatever node installs)
33 33  * yarn (latest version)
... ... @@ -34,6 +34,7 @@
34 34  * Python (2.7.X)
35 35  * gcc, g++, and make (for native dependencies of some npm packages)
36 36  * [[Visual Studio Code>>url:https://code.visualstudio.com/||shape="rect"]] (latest version)
52 +* eclipse installer
37 37  * a cloned [[keith >>url:https://git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/keith/browse||shape="rect"]]repository
38 38  
39 39  == ... on linux: ==
... ... @@ -87,60 +87,46 @@
87 87  xcode-select --install
88 88  {{/code}}
89 89  
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).
106 +\\
91 91  
92 -= Stuff that may help =
108 +\\
93 93  
94 -== Running the already build LS ==
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).
95 95  
96 -Go to the latest [[Bamboo build>>url:https://rtsys.informatik.uni-kiel.de/bamboo/browse/KISEMA-NSI||shape="rect"]] and go to Artifacts.
112 +== How run KEITH in developer setup (socket) ==
97 97  
98 -[[image:attach:image2019-2-7_17-46-58.png]]
114 +Run the following to build and run KEITH in its developer setup (in socket mode, so the LS has to be started separately)
99 99  
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 -
106 106  {{code language="bash"}}
107 --application
108 -de.cau.cs.kieler.language.server.LanguageServer
109 --noSplash
117 +yarn && cd keith-app && yarn run socket
110 110  {{/code}}
111 111  
112 -Since an eclipse application is built, this is needed to start the LS without a splashscreen.
120 +Per default the KEITH opens on localhost:3000.
113 113  
114 -If you want to connect that LS via socket to your Theia application (KEITH) add the following to the vmargs:
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.
115 115  
116 -{{code}}
117 --Dport=5007
118 -{{/code}}
124 +== Setting up your eclipse ==
119 119  
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:
126 +For everything not mentioned here refer to [[Configuring Eclipse>>doc:KIELER.Configuring Eclipse||shape="rect"]] guide.
121 121  
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:
128 +Use the installer go to advanced mode, add the kieler url. Then select first pragmatics and after that semantics (that is very important).
123 123  
124 -[[image:attach:image2019-2-7_17-58-22.png]]
130 +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.
125 125  
126 -Open the {{code language="none"}}package.json{{/code}}. In the{{code language="none"}} package.json{{/code}} are several scripts defined.
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.
127 127  
128 -[[image:attach:image2019-2-7_18-0-7.png]]
134 +\\
129 129  
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}}.
136 +The setup tasks might fail. Disable Modular Target and Theia Target (Theia Target2 is the right target) and repeat them.
131 131  
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"]].
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//
133 133  
140 +== [[image:attach:Screenshot from 2019-02-15 14-10-50.png]] ==
141 +
134 134  \\
135 135  
136 -== How run KEITH in developer setup (socket) ==
144 +You have to edit the arguments too. The Vm arguments host and port are added to connect the LS via socket.
137 137  
138 -Run the following to build and run KEITH in its developer setup (in socket mode, so the LS has to be started separately)
146 +[[image:attach:Screenshot from 2019-02-15 14-13-34.png]]
139 139  
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.
148 +The default port to which KEITH tries to connect is 5007.
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -56852516
1 +54198535
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/56852516/Running KEITH
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/54198535/Running KEITH

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage