Wiki source code of Running KEITH

Version 34.1 by Soeren Domroes on 2020/03/27 14:35

version	line-number	content
7.1	1	= Running KEITH =
6.1	2
7.1	3
	4
16.1	5	{{toc maxLevel="2"/}}
6.1	6
32.1	7	== Setting up your Eclipse ==
1.1	8
8.1	9	For everything not mentioned here refer to [[Getting Eclipse>>doc:KIELER.Getting Eclipse\|\|shape="rect"]] guide.
1.1	10
34.1	11	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.
1.1	12
34.1	13	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.
1.1	14
8.1	15	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.
1.1	16
34.1	17	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)
1.1	18
5.1	19	== [[image:attach:Screenshot from 2019-02-15 14-10-50.png]] ==
1.1	20
5.1	21	\\
1.1	22
33.1	23	You have to edit the arguments too. The Vm arguments host and port are added to connect the LS via socket:
1.1	24
33.1	25	{{code}}
	26	-os ${target.os} -ws ${target.ws} -arch ${target.arch} -nl ${target.nl} -consoleLog
	27	{{/code}}
	28
	29	{{code}}
	30	-Dhost=localhost -Dport=5007
	31	{{/code}}
	32
	33	\\
	34
5.1	35	[[image:attach:Screenshot from 2019-02-15 14-13-34.png]]
1.1	36
34.1	37	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.
1.1	38
	39	== Setting up a KEITH developer setup... ==
	40
	41	General requirements:
	42
30.1	43	* node (and additional dependencies see [[Theia developer guide>>url:https://github.com/theia-ide/theia/blob/master/doc/Developing.md\|\|shape="rect"]])
1.1	44	* npm (whatever node installs)
	45	* yarn (latest version)
	46	* Python (2.7.X)
	47	* gcc, g++, and make (for native dependencies of some npm packages)
	48	* [[Visual Studio Code>>url:https://code.visualstudio.com/\|\|shape="rect"]] (latest version)
	49	* a cloned [[keith >>url:https://git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/keith/browse\|\|shape="rect"]]repository
	50
	51	== ... on linux: ==
	52
	53	(Theia has a [[guide >>url:https://www.theia-ide.org/doc/authoring_extensions\|\|shape="rect"]]for extension development that might be helpful)
	54
	55	install node 8:
	56
	57	{{code}}
	58	curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.5/install.sh \| bash
	59	nvm install 8
	60	{{/code}}
	61
	62	Install python if you haven't (remember: Python 2: , Python 3: ).
	63
	64	{{code language="none"}}
	65	Install yarn (a package manager build on the package manager npm):
	66	{{/code}}
	67
	68	{{{}}}
	69
	70	\\
	71
	72	{{code}}
	73	npm install -g yarn
	74	{{/code}}
	75
	76	\\
	77
	78	== ... on windows: ==
	79
	80	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}}.
	81
11.1	82	Use that to install windows-build-tools by executing the command in an administrative powershell.
1.1	83
	84	{{code}}
	85	npm install -g windows-build-tools
	86	{{/code}}
	87
15.1	88	This installs make, gcc, g++, python and all this. Somehow this does not really terminate. If nothing happens anymore it may be finished, just kill the process if it does not terminate.
1.1	89
15.1	90	All the installed executables are not in the path and that is okay. This is not needed since yarn/npm knows how to call them when needed.
	91
14.1	92	Yarn can be downloaded and installed from [[here>>url:https://yarnpkg.com/lang/en/docs/install/#windows-stable\|\|shape="rect"]].
	93
11.1	94	=== Known Problems in this step ===
	95
15.1	96	If python3 was already installed this may cause some problems.
11.1	97
1.1	98	== ... on mac: ==
	99
	100	Get a package manager, something like [[brew>>url:https://brew.sh/index_de\|\|shape="rect"]].
	101
	102	Use brew to install all necessary stuff.
	103
	104	Apparently there is an issue with xcode-select: [[Theia developers>>url:https://github.com/theia-ide/theia/blob/master/doc/Developing.md\|\|shape="rect"]] recommend the following:
	105
	106	{{code}}
	107	xcode-select --install
	108	{{/code}}
	109
32.1	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).
1.1	111
5.1	112	= Stuff that may help =
1.1	113
5.1	114	== Running the already build LS ==
1.1	115
5.1	116	Go to the latest [[Bamboo build>>url:https://rtsys.informatik.uni-kiel.de/bamboo/browse/KISEMA-NSI\|\|shape="rect"]] and go to Artifacts.
1.1	117
5.1	118	[[image:attach:image2019-2-7_17-46-58.png]]
1.1	119
5.1	120	Select Language Server Zip and download the LS and unpack it somewhere.
	121
	122	Locate the kieler.ini file. Depending on the OS it has a different location (linux; toplevel, windows, toplevel, mac: Content/Eclipse/kieler.ini)
	123
	124	Paste the following at the beginning of the ini-file:
	125
1.1	126	{{code language="bash"}}
5.1	127	-application
	128	de.cau.cs.kieler.language.server.LanguageServer
	129	-noSplash
1.1	130	{{/code}}
	131
32.1	132	Since an Eclipse application is built, this is needed to start the LS without a splashscreen.
1.1	133
5.1	134	If you want to connect that LS via socket to your Theia application (KEITH) add the following to the vmargs:
3.1	135
5.1	136	{{code}}
	137	-Dport=5007
	138	{{/code}}
1.1	139
5.1	140	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:
1.1	141
5.1	142	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:
1.1	143
5.1	144	[[image:attach:image2019-2-7_17-58-22.png]]
1.1	145
5.1	146	Open the {{code language="none"}}package.json{{/code}}. In the{{code language="none"}} package.json{{/code}} are several scripts defined.
3.1	147
26.1	148	{{code language="js"}}
	149	"scripts": {
	150	"prepare": "yarn run clean && yarn build",
	151	"clean": "theia clean",
	152	"build": "theia build --mode development",
	153	"start": "theia start --root-dir=../workspace",
	154	"socket": "node ./src-gen/backend/main.js --root-dir=../workspace --LSP_PORT=5007 --port=3000 --loglevel=debug",
	155	"watch": "theia build --watch --mode development"
	156	},
	157	{{/code}}
1.1	158
26.1	159	\\
	160
5.1	161	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}}.
3.1	162
5.1	163	== How run KEITH in developer setup (socket) ==
3.1	164
5.1	165	Run the following to build and run KEITH in its developer setup (in socket mode, so the LS has to be started separately)
3.1	166
26.1	167	=== Running KEITH in the browser ===
	168
	169	\\
	170
5.1	171	{{code language="bash"}}
	172	yarn && cd keith-app && yarn run socket
	173	{{/code}}
	174
13.1	175	//yarn// builds all the stuff. //yarn run socket// in keith-app starts the application. After an initial build via yarn you can run //yarn watch // to watch the changes in your repository. In another console you run yarn run socket in keith-app. Now refreshing your browser is enough to apply the changes.
	176
5.1	177	Per default the KEITH opens on localhost:3000.
	178
26.1	179	{{info}}
27.1	180	If you previously build keith electron, you have to execute {{code language="none"}}yarn run rebuild:browser{{/code}}
26.1	181	{{/info}}
7.1	182
26.1	183	\\
	184
	185	=== Running KEITH as (unbundled) electron app ===
	186
	187	{{code language="bash"}}
	188	yarn && yarn run rebuild:electron && cd keith-app-electron && yarn run socket
	189	{{/code}}
	190
	191	//yarn// builds all the stuff. //yarn run socket// in keith-app-electron starts the application. After an initial build via yarn you can run //yarn watch // to watch the changes in your repository. In another console you run yarn run socket in keith-app-electron. Now refreshing your browser is enough to apply the changes.
	192
	193	{{info}}
27.1	194	If you previously build keith electron, you have to execute {{code language="none"}}yarn run rebuild:electron{{/code}}
26.1	195	{{/info}}
	196
13.1	197	=== Known issues for windows: ===
	198
	199	nsfw.code not found: In the top level package.json exists a script called postinstall. Remove this on windows, delete the node_modules folder and rebuilt the application. This is a known issue of electron-builder.
	200
	201	=== Known issues on mac: ===
	202
	203	Since SWT is still used as part of the diagram synthesis (but is not relevant anymore). Since it is not called on the main thread this causes a deadlock. Therefore mac just does not work.
	204
	205	=== Known issues: ===
	206
26.1	207	* KEITH works in the browser/electron app, but not in the electron app/browser with the following error message:(((
	208	{{code language="none"}}symbol lookup error: ... symbol lookup error: .../keith/node_modules/nsfw/build/Release/nsfw.node: undefined symbol: _ZN2v816FunctionTemplate3NewEPNS_7IsolateEPFvRKNS_20FunctionCallbackInfoINS_5ValueEEEENS_5LocalIS4_EENSA_INS_9SignatureEEEiNS_19ConstructorBehaviorENS_14SideEffectTypeE {{/code}}{{code language="none"}}Done in 0.90s.{{/code}}
13.1	209
26.1	210	* run
	211
	212	{{code language="none"}}
	213	yarn run rebuild:electron/browser
29.1	214	{{/code}} after yarn to fix this. If it does not work, delete the
	215
	216	{{code language="none"}}
	217	node_modules
	218	{{/code}} folder and try again (for browser version rebuild browser is not needed, since
	219
	220	{{code language="none"}}
	221	yarn
	222	{{/code}} already builds the correct sources).
26.1	223	)))
	224
21.1	225	\\

Wiki source code of Running KEITH

Navigation

Quick Links