-
Notifications
You must be signed in to change notification settings - Fork 1
/
api_generator.js
440 lines (396 loc) · 16.6 KB
/
api_generator.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
let elem_input = document.getElementById('data_input');
let elem_output = document.getElementById('data_output');
let elem_error = document.getElementById('elem_error');
function isValidJson(json) {
try {
JSON.parse(json);
return true;
} catch (e) {
return false;
}
}
function textAreaAdjust(element) {
element.style.height = "1px";
element.style.height = (25+element.scrollHeight)+"px";
}
function clearApiImplementation(){
elem_output.value = '';
setOutputElemVisibility(false);
}
function setOutputElemVisibility(val){
// document.getElementById('data_output').style.visibility = val ? 'visible' : 'hidden';
document.getElementById('download_output').style.visibility = val ? 'visible' : 'hidden';
}
function generateApiImplementation(){
clearApiImplementation();
elem_error.innerHTML = '<br>';
if(isValidJson(elem_input.value)){
let md = JSON.parse(elem_input.value);
if(checkMetadataFormat(md)){
elem_output.value = generateCodeFromMetadata(md);
// textAreaAdjust(elem_output);
setOutputElemVisibility(true);
}
} else {
elem_error.innerHTML += '<h3>Invalid JSON format of inserted metadata</h3>';
}
}
function getModuleNameFromMetaData(){
if(isValidJson(elem_input.value)){
let md = JSON.parse(elem_input.value);
if(checkMetadataFormat(md)){
return md['Execution_settings']['Module'];
}
}
return "undefined"
}
// ====================================================================================================
// Metadata Validation
// ====================================================================================================
function insertEmptyTemplateMetadata(){
let client = new XMLHttpRequest();
client.open('GET', './empty_md.json');
client.onreadystatechange = function() {
elem_input.value = client.responseText;
generateApiImplementation();
}
client.send();
}
const setAtValues = ['initialization', 'timestep'];
const valueTypes = ['Scalar', 'Vector', 'Tensor', 'ScalarArray', 'VectorArray', 'TensorArray'];
const dataTypes = [
'mupif.Property',
'mupif.TemporalProperty',
'mupif.Field',
'mupif.TemporalField',
'mupif.Function',
'mupif.HeavyStruct',
'mupif.PyroFile',
'mupif.String',
'mupif.GrainState',
'mupif.DataList[mupif.Property]',
'mupif.DataList[mupif.TemporalProperty]',
'mupif.DataList[mupif.Field]',
'mupif.DataList[mupif.TemporalField]',
'mupif.DataList[mupif.Function]',
'mupif.DataList[mupif.HeavyStruct]',
'mupif.DataList[mupif.PyroFile]',
'mupif.DataList[mupif.String]',
'mupif.DataList[mupif.GrainState]'
];
function checkMetadataItem(md, key, obj_name, check_nonempty=false, enum_values=[]){
if(!(key in md)){
elem_error.innerHTML += '<div class="p4">' + obj_name + ' is missing key "' + key + '".</div>';
return false;
}
if(check_nonempty && (md[key] === '' || md[key] === null)){
elem_error.innerHTML += '<div class="p4">' + obj_name + ' item "' + key + '" cannot be empty.</div>';
return false;
}
if(enum_values.length > 0 && !enum_values.includes(md[key])){
elem_error.innerHTML += '<div class="p4">' + obj_name + ' item "' + key + '" must be chosen from [' + enum_values.map(v => '"'+v+'"').join(', ') + '].</div>';
return false;
}
return true;
}
function checkMetadataInputOrOutput(md, inputOrOutput, num){
const name = inputOrOutput + ' #' + num;
let retval = true;
const keys = inputOrOutput === 'Input' ? ['Name', 'Type_ID', 'Type', 'Required', 'Set_at'] : ['Name', 'Type_ID', 'Type'];
keys.forEach(key => {
if(!(key in md)){
elem_error.innerHTML += '<div class="p4">' + name + ' is missing key "' + key + '".</div>';
retval = false;
}
})
if(retval){
if(!dataTypes.includes(md['Type'])){
elem_error.innerHTML += '<div class="p4">"Type" of ' + name + ' must be chosen from [' + dataTypes.map(v => '"'+v+'"').join(', ') + '].</div>';
retval = false;
}
if('Required' in md) {
if (![true, false].includes(md['Required'])) {
elem_error.innerHTML += '<div class="p4">"Required" of ' + name + ' must be chosen from [true, false].</div>';
retval = false;
}
}
if('Set_at' in md) {
if (!setAtValues.includes(md['Set_at'])) {
elem_error.innerHTML += '<div class="p4">"Set_at" of ' + name + ' must be chosen from [' + setAtValues.map(v => '"'+v+'"').join(', ') + '].</div>';
retval = false;
}
}
}
if("Type" in md){
if(
md["Type"] === "mupif.Property"
|| md["Type"] === "mupif.String"
|| md["Type"] === "mupif.TemporalProperty"
|| md["Type"] === "mupif.Field"
|| md["Type"] === "mupif.TemporalField"
|| md["Type"] === "mupif.Function"
|| md["Type"] === "mupif.DataList[mupif.Property]"
|| md["Type"] === "mupif.DataList[mupif.String]"
|| md["Type"] === "mupif.DataList[mupif.TemporalProperty]"
|| md["Type"] === "mupif.DataList[mupif.Field]"
|| md["Type"] === "mupif.DataList[mupif.TemporalField]"
|| md["Type"] === "mupif.DataList[mupif.Function]"
){
if(!("ValueType" in md)){
elem_error.innerHTML += '<div class="p4">' + name + ' is missing key "ValueType".</div>';
retval = false;
}else if(!valueTypes.includes(md["ValueType"])){
elem_error.innerHTML += '<div class="p4">"ValueType" of ' + name + ' must be chosen from [' + valueTypes.map(v => '"'+v+'"').join(', ') + '].</div>';
retval = false;
}
}
}
return retval;
}
function checkMetadataSubItem(obj, keys, obj_name, check_nonempty=false, enum_values=[]){
let retval = true;
keys.forEach(k => {
if(!checkMetadataItem(obj, k, obj_name, check_nonempty, enum_values)){retval = false;}
})
return retval;
}
function checkMetadataFormat(md){
let base_keys = [
'Name',
'ID',
'Inputs',
'Outputs',
'Execution_settings'
]
let retval = true;
base_keys.forEach(k => {
if(!checkMetadataItem(md, k, 'Metadata', true)){retval = false;}
})
const physics_meta = {
"Type": ['Electronic', 'Atomistic', 'Molecular', 'Mesoscopic', 'Continuum', 'Other'],
"Entity": ['Atom', 'Electron', 'Grains', 'Finite volume', 'Other'],
}
const physics_keys = Object.keys(physics_meta);
const solver_meta = {
"Software": null,
"Language": null,
"License": null,
"Creator": null,
"Version_date": null,
"Documentation": null,
"Estim_time_step_s": null,
"Estim_comp_time_s": null,
"Estim_execution_cost_EUR": null,
"Estim_personnel_cost_EUR": null,
"Required_expertise": ["None", "User", "Expert"],
"Accuracy": ["Low", "Medium", "High", "Unknown"],
"Sensitivity": ["Low", "Medium", "High", "Unknown"],
"Complexity": ["Low", "Medium", "High", "Unknown"],
"Robustness": ["Low", "Medium", "High", "Unknown"],
}
const solver_keys = Object.keys(solver_meta);
for(let i=0;i<md["Inputs"].length;i++){
if(!checkMetadataInputOrOutput(md["Inputs"][i], 'Input', i+1)){
retval = false;
}
}
for(let i=0;i<md["Outputs"].length;i++){
if(!checkMetadataInputOrOutput(md["Outputs"][i], 'Output', i+1)){
retval = false;
}
}
if(!checkMetadataSubItem(md["Execution_settings"], ['Type', 'Class', 'Module', 'jobManName'], 'Execution_settings', true)){retval = false;}
if(!checkMetadataSubItem(md["Physics"], physics_keys, 'Physics')){retval = false;}
physics_keys.forEach(k => {
if (physics_meta[k] !== null) {
if(!checkMetadataSubItem(md["Physics"], [k], 'Physics', false, physics_meta[k])){retval = false;}
}
})
if(!checkMetadataSubItem(md["Solver"], solver_keys, 'Solver')){retval = false;}
solver_keys.forEach(k => {
if (solver_meta[k] !== null) {
if(!checkMetadataSubItem(md["Solver"], [k], 'Solver', false, solver_meta[k])){retval = false;}
}
})
return retval;
}
// ====================================================================================================
// Code Generation
// ====================================================================================================
function generateCodeFromMetadata(md){
let md_str = "MD = " + JSON.stringify(md, null, 4);
md_str = md_str.replaceAll('false', 'False');
md_str = md_str.replaceAll('true', 'True');
let md_lines = md_str.split('\n');
md_lines = push_indents_before_each_line(md_lines, 2);
let inputs = md['Inputs'];
let outputs = md['Outputs'];
let obj_id;
let code = [];
code.push("import mupif");
code.push("import Pyro5");
code.push("");
code.push("");
code.push("@Pyro5.api.expose");
code.push("class " + md['Execution_settings']['Class'] + "(mupif.Model):");
code.push("\tdef __init__(self, metadata=None):");
code.push("\t\t");
extend_array(code, md_lines);
code.push("");
code.push("\t\tsuper().__init__(metadata=MD)");
code.push("\t\tself.updateMetadata(metadata)");
code.push("");
// refactor inputs/outputs
let Inputs = [];
let Outputs = [];
let newitem;
if(inputs.length) {
inputs.forEach(item => {
obj_id = null;
if ('Obj_ID' in item) {
obj_id = item['Obj_ID'];
}
if (obj_id === null || typeof obj_id == 'string') {
newitem = JSON.parse(JSON.stringify(item));
Inputs.push(item);
} else if (obj_id.constructor.name === "Array") {
for (let ii = 0; ii < obj_id.length; ii++) {
newitem = JSON.parse(JSON.stringify(item));
newitem['Obj_ID'] = obj_id[ii];
Inputs.push(newitem);
}
}
})
}
if(outputs.length) {
outputs.forEach(item => {
obj_id = null;
if ('Obj_ID' in item) {
obj_id = item['Obj_ID'];
}
if (obj_id === null || typeof obj_id == 'string') {
newitem = JSON.parse(JSON.stringify(item));
Outputs.push(newitem);
} else if (obj_id.constructor.name === "Array") {
for (let ii = 0; ii < obj_id.length; ii++) {
newitem = JSON.parse(JSON.stringify(item));
newitem['Obj_ID'] = obj_id[ii];
Outputs.push(newitem);
}
}
})
}
// default values for inputs/outputs
if(Inputs.length || Outputs.length) {
Inputs.forEach(item => {
item['code_name'] = 'self.input_' + item['Name'].replaceAll(' ', '_').replaceAll('-', '_');
if ('Obj_ID' in item && item['Obj_ID'] && item['Name'] !== item['Obj_ID'])
item['code_name'] += '_' + item['Obj_ID'].replaceAll(' ', '_').replaceAll('-', '_');
});
Outputs.forEach(item => {
item['code_name'] = 'self.output_' + item['Name'].replaceAll(' ', '_').replaceAll('-', '_');
if ('Obj_ID' in item && item['Obj_ID'] && item['Name'] !== item['Obj_ID'])
item['code_name'] += '_' + item['Obj_ID'].replaceAll(' ', '_').replaceAll('-', '_');
});
Inputs.forEach(item => {code.push("\t\t" + item['code_name'] + " = None");})
Outputs.forEach(item => {code.push("\t\t" + item['code_name'] + " = None");})
code.push("");
}
code.push("\tdef initialize(self, workdir='', metadata=None, validateMetaData=True, **kwargs):");
code.push("\t\tsuper().initialize(workdir=workdir, metadata=metadata, validateMetaData=validateMetaData, **kwargs)");
code.push("");
code.push("\tdef get(self, objectTypeID, time=None, objectID=\"\"):");
if(Outputs.length) {
Outputs.forEach(item => {
obj_id = null;
if ('Obj_ID' in item) {
obj_id = item['Obj_ID'];
}
if (obj_id === null) {
code.push("\t\tif objectTypeID == " + item['Type_ID'] + ":");
code.push("\t\t\tif " + item['code_name'] + " is None:");
code.push("\t\t\t\traise ValueError(\"Value not defined\")");
code.push("\t\t\treturn " + item['code_name']);
} else if (typeof obj_id == 'string') {
code.push("\t\tif objectTypeID == " + item['Type_ID'] + " and objectID == \"" + obj_id + "\":");
code.push("\t\t\tif " + item['code_name'] + " is None:");
code.push("\t\t\t\traise ValueError(\"Value not defined\")");
code.push("\t\t\treturn " + item['code_name']);
} else if (obj_id.constructor.name === "Array") {
for (let ii = 0; ii < obj_id.length; ii++) {
code.push("\t\tif objectTypeID == " + item['Type_ID'] + " and objectID == \"" + obj_id[ii] + "\":");
code.push("\t\t\tif " + item['code_name'] + " is None:");
code.push("\t\t\t\traise ValueError(\"Value not defined\")");
code.push("\t\t\treturn " + item['code_name']);
}
}
})
} else {
code.push("\t\tpass");
}
code.push("");
code.push("\tdef set(self, obj, objectID=\"\"):");
if(Inputs.length) {
Inputs.forEach(item => {
obj_id = null;
if ('Obj_ID' in item) {
obj_id = item['Obj_ID'];
}
if (obj_id === null) {
code.push("\t\tif obj.isInstance(" + item['Type'] + ") and obj.getDataID() == " + item['Type_ID'] + ":");
code.push("\t\t\t" + item['code_name'] + " = obj");
} else if (typeof obj_id == 'string') {
code.push("\t\tif obj.isInstance(" + item['Type'] + ") and obj.getDataID() == " + item['Type_ID'] + " and objectID == \"" + obj_id + "\":");
code.push("\t\t\t" + item['code_name'] + " = obj");
} else if (obj_id.constructor.name === "Array") {
for (let ii = 0; ii < obj_id.length; ii++) {
code.push("\t\tif obj.isInstance(" + item['Type'] + ") and obj.getDataID() == " + item['Type_ID'] + " and objectID == \"" + obj_id[ii] + "\":");
code.push("\t\t\t" + item['code_name'] + " = obj");
}
}
})
} else {
code.push("\t\tpass");
}
code.push("");
code.push("\tdef getApplicationSignature(self):");
code.push("\t\treturn \"" + md['Execution_settings']['Class'] + "\"");
code.push("");
code.push("\tdef getAPIVersion(self):");
code.push("\t\treturn 1");
code.push("");
code.push("\tdef solveStep(self, tstep, stageID=0, runInBackground=False):");
let required_inputs = Inputs.filter(inp => inp['Required'] === true);
if (required_inputs.length) {
code.push("\t\tfor inp in [" + required_inputs.map(inp => inp['code_name']).join(', ') + "]:");
code.push("\t\t\tif inp is None:");
code.push("\t\t\t\traise ValueError(\"A required input was not defined\")");
}
code.push("\t\t");
code.push("\t\traise NotImplementedError(\"Not implemented\")");
code.push("");
if(md['Execution_settings']['Type'] === 'Distributed') {
code.push("");
code.push("if __name__ == '__main__':");
code.push("\timport " + md['Execution_settings']['Module']);
code.push("\tmupif.SimpleJobManager(");
code.push("\t\tns=mupif.pyroutil.connectNameserver(),");
code.push("\t\tappClass=" + md['Execution_settings']['Module'] + "." + md['Execution_settings']['Class'] + ",");
code.push("\t\tappName='" + md['Execution_settings']['jobManName'] + "',");
code.push("\t\tmaxJobs=10");
code.push("\t).runServer()");
code.push("");
}
return formatCodeToText(replace_tabs_with_spaces_for_each_line(code));
}
function downloadCode() {
let code = elem_output.value;
let filename = getModuleNameFromMetaData() + ".py";
let element = document.createElement('a');
element.setAttribute('href', 'data:text/plain;charset=utf-8,' + encodeURIComponent(code));
element.setAttribute('download', filename);
element.style.display = 'none';
document.body.appendChild(element);
element.click();
document.body.removeChild(element);
}