/
projectService.js
3511 lines (3153 loc) · 114 KB
/
projectService.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
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/***********************************************************************************************************************
* OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
* following conditions are met:
*
* (1) Redistributions of source code must retain the above copyright notice, this list of conditions and the following
* disclaimer.
*
* (2) Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other materials provided with the distribution.
*
* (3) Neither the name of the copyright holder nor the names of any contributors may be used to endorse or promote
* products derived from this software without specific prior written permission from the respective party.
*
* (4) Other than as required in clauses (1) and (2), distributions in any form of modifications or other derivative
* works may not use the "OpenStudio" trademark, "OS", "os", or any other confusingly similar designation without
* specific prior written permission from Alliance for Sustainable Energy, LLC.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER, THE UNITED STATES GOVERNMENT, OR ANY CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
**********************************************************************************************************************/
import jetpack from 'fs-jetpack';
//import os from 'os';
import path from 'path';
import { app, dialog } from '@electron/remote';
import jsZip from 'jszip';
import fs from 'fs';
import archiver from 'archiver';
export class Project {
constructor($q, $log, $http, $uibModal, MeasureManager, $sce, Message, toastr, $translate) {
'ngInject';
const vm = this;
vm.$log = $log;
vm.jetpack = jetpack;
vm.fs = fs;
vm.jsZip = jsZip;
vm.MeasureManager = MeasureManager;
vm.dialog = dialog;
vm.archiver = archiver;
vm.$q = $q;
vm.$http = $http;
vm.$uibModal = $uibModal;
vm.$sce = $sce;
vm.Message = Message;
vm.toastr = toastr;
vm.$translate = $translate;
vm.analysisTypes = ['Manual', 'Algorithmic'];
vm.cliDebugTypes = [{value: '', label: 'false'}, {value: '--debug', label: 'true'}];
vm.cliVerboseTypes = [{value: '', label: 'false'}, {value: '--verbose', label: 'true'}];
vm.downloadReportsTypes = [{value: false, label: 'false'}, {value: true, label: 'true'}];
vm.downloadOSMTypes = [{value: false, label: 'false'}, {value: true, label: 'true'}];
vm.downloadOSWTypes = [{value: false, label: 'false'}, {value: true, label: 'true'}];
vm.downloadZIPTypes = [{value: false, label: 'false'}, {value: true, label: 'true'}];
vm.numberDPsToDisplay = 150;
vm.reportTypes = [{
id: 'Calibration Report',
name: 'reports.type.calibrationReport'
}, {
id: 'Radiance Report',
name: 'reports.type.radianceReport'
}, {
id: 'Parallel Coordinates',
name: 'reports.type.parallelCoordinates'
}, {
id: 'Radar Chart',
name: 'reports.type.radarChart'
}, {
id: 'EDAPT Export',
name: 'reports.type.edaptExport'
}];
vm.samplingMethods = vm.setSamplingMethods();
vm.runTypes = vm.setRunTypes();
vm.algorithmOptions = vm.setAlgorithmOptions();
vm.resetRemoteSettings();
vm.clusters = [];
vm.modified = false;
vm.analysisType = null;
vm.cliDebug = null;
vm.cliVerbose = null;
vm.downloadReports = null;
vm.downloadOSW = null;
vm.downloadOSM = null;
vm.downloadZIP = null;
vm.timeoutWorkflow = null;
vm.timeoutUploadResults = null;
vm.timeoutInitWorker = null;
vm.reportType = null;
vm.runType = vm.runTypes[0];
vm.samplingMethod = vm.samplingMethods[0];
vm.rubyMD5 = null;
vm.mongoMD5 = null;
vm.openstudioServerMD5 = null;
vm.openstudioCLIMD5 = null;
vm.openstudioMD5 = null;
vm.projectDir = null; // this is a jetpack object (like all other *Dir variables)
vm.projectLocalResultsDir = null;
vm.projectClustersDir = null;
vm.projectName = null;
vm.mongoDir = null;
vm.logsDir = null;
vm.projectMeasuresDir = null;
vm.seedDir = null;
vm.weatherDir = null;
vm.seeds = [];
vm.defaultSeed = null;
vm.weatherFiles = [];
vm.defaultWeatherFile = null;
vm.algorithmSettings = [];
vm.measures = [];
vm.designAlternatives = [];
vm.filesToInclude = [];
vm.setServerScripts();
vm.analysisID = '';
vm.datapoints = [];
const src = jetpack.cwd(app.getPath('userData'));
vm.railsDir = jetpack.dir(path.resolve(src.path() + '/openstudioServer/openstudio-server/server'));
// aws path
vm.awsDir = jetpack.dir(app.getPath('appData') + '/.aws');
if (vm.Message.showDebug()) vm.$log.debug('.aws dir location: ', vm.awsDir.path());
// set my measures dir
vm.MeasureManager.isReady().then(() => {
vm.MeasureManager.getMyMeasuresDir().then(response => {
if (angular.isUndefined(response.my_measures_dir)) {
vm.$log.error('response.my_measures_dir undefined');
}
if (response.my_measures_dir) {
vm.setMeasuresDir(response.my_measures_dir);
}
if (vm.Message.showDebug()) vm.$log.debug('My measures Dir: ', vm.myMeasuresDir.path());
}, error => {
vm.$log.error('Error in Measure Manager getMyMeasuresDir: ', error);
});
}, error => {
vm.$log.error('Error in Measure Manager isReady function ', error);
});
// json objects
vm.pat = {};
vm.osa = {};
}
setDefaults() {
const vm = this;
vm.seeds = [];
vm.weatherFiles = [];
vm.setSeeds();
vm.setWeatherFiles();
vm.defaultSeed = vm.seeds.length > 0 ? vm.seeds[0] : null;
vm.defaultWeatherFile = vm.weatherFiles.length > 0 ? vm.weatherFiles[0] : null;
vm.seedsDropdownArr = [];
vm.weatherFilesDropdownArr = [];
vm.setSeedsDropdownOptions();
vm.setWeatherFilesDropdownOptions();
vm.filesToInclude = [];
vm.setServerScripts();
vm.analysisName = vm.getProjectName();
vm.analysisType = 'Manual';
vm.cliDebug = '';
vm.cliVerbose = '';
vm.downloadReports = true;
vm.downloadOSW = true;
vm.downloadOSM = true;
vm.downloadZIP = true;
vm.timeoutWorkflow = 28800;
vm.timeoutUploadResults = 28800;
vm.timeoutInitWorker = 28800;
vm.reportType = 'Calibration Report';
vm.samplingMethod = vm.samplingMethods.length > 0 ? vm.samplingMethods[0] : null;
vm.runType = vm.runTypes[0];
vm.resetRemoteSettings();
vm.algorithmSettings = [];
vm.measures = [];
vm.designAlternatives = [];
vm.osa = {};
vm.analysisID = '';
vm.datapoints = [];
vm.helmInfoShown = false;
// TODO: still need these?
vm.rubyMD5 = '';
vm.mongoMD5 = '';
vm.openstudioServerMD5 = '';
vm.openstudioCLIMD5 = '';
vm.openstudioMD5 = '';
}
// import from pat.json
// TODO: add check to ensure that the measures really are in the PAT project folder and haven't been deleted
// TODO: if measure is in pat dir but not in json, ignore
// TODO: if measure is in pat dir, not in json, and user tries to add it, overwrite existing measure in dir? (currently it doesn't overwrite)
initializeProject() {
const vm = this;
if (vm.Message.showDebug()) vm.$log.debug('Project initializeProject');
if (angular.isDefined(vm.projectName)) {
const filename = vm.projectDir.path('pat.json');
if (vm.Message.showDebug()) vm.$log.debug('filename: ', filename);
// for new and existing projects
vm.setDefaults();
if (vm.jetpack.exists(filename)) {
// existing project
vm.pat = vm.jetpack.read(filename, 'json');
if (vm.Message.showDebug()) vm.$log.debug('PAT.json: ', vm.pat);
if (vm.Message.showDebug()) vm.$log.debug('filename: ', filename);
vm.measures = vm.pat.measures;
if (!angular.isDefined(vm.measures)) {
vm.measures = [];
}
// recalculate measure_dir to point to this location (in case project moved/copied)
_.forEach(vm.measures, (measure) => {
// windows vs mac paths are different, and we can't assume this project was created on this os
let path_parts = _.split(measure.measure_dir, '/');
if (path_parts.length == 1) {
// split again with other delimiter
path_parts = _.split(measure.measure_dir, '\\');
if (path_parts.length == 1){
path_parts = _.split(measure.measure_dir, '\\\\');
}
}
if (vm.Message.showDebug()) vm.$log.debug('PATH PARTS: ', path_parts);
measure.measure_dir = vm.projectDir.path('measures', _.last(path_parts));
measure.directory = measure.measure_dir;
});
if (vm.Message.showDebug()) vm.$log.debug('InitializeProject-measures with updated dir paths: ', vm.measures);
vm.designAlternatives = vm.pat.designAlternatives;
if (!angular.isDefined(vm.designAlternatives)) {
vm.designAlternatives = [];
}
vm.analysisName = vm.pat.analysisName ? vm.pat.analysisName : vm.projectName;
vm.analysisType = vm.pat.analysis_type ? vm.pat.analysis_type : vm.analysisType;
vm.cliDebug = vm.pat.cliDebug ? vm.pat.cliDebug : vm.cliDebug;
vm.cliVerbose = vm.pat.cliVerbose ? vm.pat.cliVerbose : vm.cliVerbose;
vm.downloadReports = vm.pat.downloadReports ? vm.pat.downloadReports : vm.downloadReports;
vm.downloadOSW = vm.pat.downloadOSW ? vm.pat.downloadOSW : vm.downloadOSW;
vm.downloadOSM = vm.pat.downloadOSM ? vm.pat.downloadOSM : vm.downloadOSM;
vm.downloadZIP = vm.pat.downloadZIP ? vm.pat.downloadZIP : vm.downloadZIP;
vm.timeoutWorkflow = vm.pat.timeoutWorkflow ? vm.pat.timeoutWorkflow : vm.timeoutWorkflow;
vm.timeoutUploadResults = vm.pat.timeoutUploadResults ? vm.pat.timeoutUploadResults : vm.timeoutUploadResults;
vm.timeoutInitWorker = vm.pat.timeoutInitWorker ? vm.pat.timeoutInitWorker : vm.timeoutInitWorker;
vm.samplingMethod = vm.pat.samplingMethod ? vm.pat.samplingMethod : vm.samplingMethod;
vm.defaultSeed = vm.pat.seed ? vm.pat.seed : vm.defaultSeed;
vm.defaultWeatherFile = vm.pat.weatherFile ? vm.pat.weatherFile : vm.defaultWeatherFile;
if (vm.Message.showDebug()) vm.$log.debug('vm.algorithmSettings: ', vm.algorithmSettings);
if (vm.Message.showDebug()) vm.$log.debug('vm.pat.algorithmSettings: ', vm.pat.algorithmSettings);
vm.algorithmSettings = vm.pat.algorithmSettings ? vm.pat.algorithmSettings : vm.algorithmSettings;
vm.rubyMD5 = vm.pat.rubyMD5 ? vm.pat.rubyMD5 : vm.rubyMD5;
vm.mongoMD5 = vm.pat.mongoMD5 ? vm.pat.mongoMD5 : vm.mongoMD5;
vm.openstudioServerMD5 = vm.pat.openstudioServerMD5 ? vm.pat.openstudioServerMD5 : vm.openstudioServerMD5;
vm.openstudioCLIMD5 = vm.pat.openstudioCLIMD5 ? vm.pat.openstudioCLIMD5 : vm.openstudioCLIMD5;
vm.openstudioMD5 = vm.pat.openstudioMD5 ? vm.pat.openstudioMD5 : vm.openstudioMD5;
vm.analysisID = vm.pat.analysisID ? vm.pat.analysisID : vm.analysisID;
vm.datapoints = vm.pat.datapoints ? vm.pat.datapoints : vm.datapoints;
vm.remoteSettings = vm.pat.remoteSettings ? vm.pat.remoteSettings : vm.remoteSettings;
vm.serverScripts = vm.pat.serverScripts ? vm.pat.serverScripts : vm.serverScripts;
// filesToInclude
// convert paths to platform-specific delimiters
_.forEach(vm.pat.filesToInclude, (file) => {
let path_parts = [];
if (!_.isNil(file.dirToInclude) && !_.isNil(file.unpackDirName)){
// first check for no leading dots (current directory)
if (file.dirToInclude.substring(0, 2) !== '..')
path_parts.push(file.dirToInclude);
else {
path_parts = _.split(file.dirToInclude, '/');
if (path_parts.length === 1) {
// split again with other delimiter
path_parts = _.split(file.dirToInclude, '\\');
if (path_parts.length === 1) {
path_parts = _.split(file.dirToInclude, '\\\\');
}
}
}
file.dirToInclude = path.join.apply(this, path_parts);
if (vm.Message.showDebug()) vm.$log.debug('new file to include path: ', file.dirToInclude);
}
});
vm.filesToInclude = vm.pat.filesToInclude ? vm.pat.filesToInclude : vm.filesToInclude;
}
} else {
vm.$log.error('No project selected...cannot initialize project');
}
if (vm.Message.showDebug()) vm.$log.debug('Server Scripts: ', vm.serverScripts);
}
sleep(ms) {
return new Promise(resolve => setTimeout(resolve, ms));
}
savePrettyOptions() {
const vm = this;
if (vm.Message.showDebug()) vm.$log.debug('Parse arguments and save Options hash to each measure');
_.forEach(vm.measures, (measure) => {
const options = [];
// first find out how many options there are (from the optionDelete special argument)
let optionKeys = [];
if (!_.isNil(measure.arguments) && measure.arguments.length > 0) {
const keys = Object.keys(measure.arguments[0]);
optionKeys = _.filter(keys, (k) => {
return k.indexOf('option_') !== -1;
});
}
_.forEach(optionKeys, (key) => {
const theOption = {};
// option name and ID
theOption.id = key;
// set argument values
theOption.arguments = [];
_.forEach(measure.arguments, (argument) => {
const theArg = {};
if (argument.specialRowId == 'optionName') {
theOption.name = argument[key];
} else if (argument.specialRowId == 'optionDescription') {
theOption.description = argument[key];
}
// get the row's value for key corresponding to the col's name
// add to arguments array
else if (!('specialRowId' in argument)) {
if (key in argument) {
theArg.name = argument.name;
theArg.value = argument[key];
theOption.arguments.push(theArg);
} else {
// check if argument is required
if (argument.required) {
// TODO: throw an error here: need a value for this argument in this option
if (vm.Message.showDebug()) vm.$log.debug('ARG: ', argument.name, ' value left blank in option: ', theOption.name);
}
}
}
});
options.push(theOption);
});
// save to measure
measure.options = options;
});
if (vm.Message.showDebug()) vm.$log.debug('Measures with pretty options: ', vm.measures);
}
// computes all project measure arguments with selected seed
// uses empty seed model otherwise
computeAllMeasureArguments() {
const vm = this;
const deferred = vm.$q.defer();
const promises = [];
if (vm.Message.showDebug()) vm.$log.debug('in Project computeAllMeasureArguments()');
// const osmPath = (vm.defaultSeed == null) ? null : vm.seedDir.path(vm.defaultSeed);
_.forEach(vm.measures, (measure) => {
if (!_.isNil(measure.seed)) {
if (vm.Message.showDebug()) vm.$log.debug(`computeAllMeasureArguments using unique seed for measure: ${measure}`);
}
// todo: ensure that this modifies the vm.measures directly
const promise = vm.computeMeasureArguments(measure);
promises.push(promise);
});
vm.$q.all(promises).then(() => {
if (vm.Message.showDebug()) vm.$log.debug('ComputeAllMeasures resolved');
deferred.resolve();
vm.setModified(true);
}, error => {
vm.$log.error('ERROR in ComputeAllMeasures: ', error);
deferred.reject(error);
});
// recalculate pretty options (not unless we modify the actual options themselves
//vm.savePrettyOptions();
return deferred.promise;
}
computeMeasureArguments(measure) {
const vm = this;
const deferred = vm.$q.defer();
if (vm.Message.showDebug()) vm.$log.debug('in Project computeMeasureArguments()');
let osmPath;
if (_.isNil(vm.seedDir)) {
vm.$log.warn('vm.seedDir is undefined. Computing measure arguments with empty seed model.');
osmPath = null;
} else if (_.isNil(measure.seed)) {
vm.$log.warn('measure.seed is undefined. Computing measure arguments with empty seed model.');
osmPath = null;
} else {
osmPath = vm.seedDir.path(measure.seed);
}
vm.MeasureManager.computeArguments(measure.measure_dir, osmPath).then((newMeasure) => {
// merge with existing project measure
if (vm.Message.showDebug()) vm.$log.debug('New computed measure: ', newMeasure);
// remove arguments that no longer exist (by name) (in reverse) (except for special display args)
_.forEachRight(measure.arguments, (arg, index) => {
if (_.isUndefined(arg.specialRowId)) {
const match = _.find(measure.arguments, {name: arg.name});
if (_.isUndefined(match)) {
measure.arguments.splice(index, 1);
}
}
});
// then add/merge (at argument level)
_.forEach(newMeasure.arguments, (arg) => {
const match = _.find(measure.arguments, {name: arg.name});
if (_.isUndefined(match)) {
measure.arguments.push(arg);
} else {
_.merge(match, arg);
}
});
deferred.resolve(measure);
}, error => {
vm.$log.error('Error in MM computerArguments: ', error);
deferred.reject();
});
return deferred.promise;
}
// export OSA
exportOSA(selectedOnly = false) {
const vm = this;
vm.osaErrors = [];
const deferred = vm.$q.defer();
if (vm.Message.showDebug()) vm.$log.debug('In Project::exportOSA');
if (vm.Message.showDebug()) vm.$log.debug('SelectedOnly? ', selectedOnly);
vm.osa = {};
vm.osa.analysis = {};
vm.osa.analysis.display_name = vm.analysisName;
vm.osa.analysis.name = vm.analysisName;
if (/[.$\u20AC\xA3]/.test(vm.osa.analysis.name)){
vm.$log.error('illegal character (.$€£) detected in analysis name: ', vm.osa.analysis.name);
vm.osaErrors.push(`illegal character (.$€£) detected in analysis name: ${vm.osa.analysis.name}`);
}
if (vm.Message.showDebug()) vm.$log.debug(`Creating OSA for analysis named ${vm.analysisName}`);
// first export common data
vm.exportCommon();
// check what kind of analysis it is
if (vm.analysisType == 'Manual') {
vm.exportManual(selectedOnly);
} else {
vm.exportAlgorithmic();
}
// reject if there are errors in osa
if (vm.osaErrors.length > 0){
deferred.reject(vm.osaErrors);
} else {
// export serverScripts
vm.exportScripts();
// write to file
const filename = vm.projectDir.path(vm.analysisName + '.json');
vm.jetpack.write(filename, vm.osa);
if (vm.Message.showDebug()) vm.$log.debug('Project OSA file exported to ' + filename);
const output = fs.createWriteStream(vm.projectDir.path(vm.analysisName + '.zip'));
const archive = vm.archiver('zip');
output.on('close', function () {
console.log(archive.pointer() + ' total bytes');
console.log('archiver has been finalized and the output file descriptor has closed.');
deferred.resolve();
});
archive.on('error', function (err) {
deferred.reject();
throw err;
});
archive.pipe(output);
archive.glob('**/*', {
cwd: vm.projectMeasuresDir.path()
}, {
prefix: 'measures'
});
archive.glob('**/*', {
cwd: vm.seedDir.path()
}, {
prefix: 'seeds'
});
archive.glob('**/*', {
cwd: vm.weatherDir.path()
}, {
prefix: 'weather'
});
// add server scripts (if they exist)
_.forEach(vm.serverScripts, (script, type) => {
if (script.file) {
const newType = _.includes(type, 'server') ? 'analysis' : 'data_point';
archive.glob('**/*', {
cwd: vm.projectDir.path('scripts', newType)
}, {
prefix: 'scripts/' + newType
});
}
});
// add files to include
_.forEach(vm.filesToInclude, (file) => {
if (file.dirToInclude) {
if (!file.unpackDirName) {
// use same name if no name is provided
file.unpackDirName = file.dirToInclude.replace(/^.*[\\\/]/, '');
}
const absPath = path.resolve(vm.projectDir.path(), file.dirToInclude);
if (vm.Message.showDebug()) vm.$log.debug('RESOLVED PATH: ', absPath, ' unpack DIR: ', file.unpackDirName);
archive.glob('**/*', {
cwd: absPath
}, {
prefix: 'lib/' + file.unpackDirName
});
}
});
archive.finalize();
}
return deferred.promise;
}
// export data common to both manual and algorithmic workflows
exportCommon() {
const vm = this;
// these are all empty for manual / initialized for algorithmic
vm.osa.analysis.output_variables = [];
vm.osa.analysis.problem = {};
vm.osa.analysis.problem.workflow = [];
vm.osa.analysis.problem.algorithm = {objective_functions: []};
vm.osa.analysis.seed = {};
vm.osa.analysis.seed.file_type = 'OSM';
vm.osa.analysis.seed.path = './seeds/' + vm.defaultSeed;
vm.osa.analysis.weather_file = {};
vm.osa.analysis.weather_file.file_type = 'EPW';
vm.osa.analysis.weather_file.path = './weather/' + vm.defaultWeatherFile;
vm.osa.analysis.file_format_version = 1;
// add CLI args to OSA
vm.osa.analysis.cli_debug = vm.cliDebug;
vm.osa.analysis.cli_verbose = vm.cliVerbose;
// add Server Download Args
vm.osa.analysis.download_reports = vm.downloadReports;
vm.osa.analysis.download_osw = vm.downloadOSW;
vm.osa.analysis.download_osm = vm.downloadOSM;
vm.osa.analysis.download_zip = vm.downloadZIP;
// add timeout args to OSA
vm.osa.analysis.run_workflow_timeout = vm.timeoutWorkflow;
vm.osa.analysis.upload_results_timeout = vm.timeoutUploadResults;
vm.osa.analysis.initialize_worker_timeout = vm.timeoutInitWorker;
// server scripts (will only work on the cloud, but always put in OSA?)
vm.osa.analysis.server_scripts = {};
_.forEach(vm.serverScripts, (script, type) => {
if (script.file) {
vm.osa.analysis.server_scripts[type] = './scripts/' + type + '/' + script.file;
}
});
}
exportManual(selectedOnly = false) {
const vm = this;
if (vm.Message.showDebug()) vm.$log.debug('In Project::exportManual');
if (vm.Message.showDebug()) vm.$log.debug('selectedONly? ', selectedOnly);
//vm.osa.analysis.problem.analysis_type = 'batch_datapoints';
vm.osa.analysis.problem.analysis_type = null;
// go through measures and don't include those that are set to None across all DAs
let selectedDAs = [];
if (!selectedOnly) {
selectedDAs = vm.designAlternatives;
} else {
_.forEach(vm.designAlternatives, (da) => {
const dpMatch = _.find(vm.datapoints, {name: da.name});
// do this for entire workflow or if matching datapoint is selected
if (_.get(dpMatch, 'selected')) {
selectedDAs.push(da);
}
});
}
const included_measures = [];
_.forEach(vm.measures, (measure) => {
let used = false;
_.forEach(selectedDAs, (da) => {
if (da[measure.name] !== 'None') {
used = true;
}
});
if (used) {
included_measures.push(measure.name);
}
});
if (vm.Message.showDebug()) vm.$log.debug('included measures: ', included_measures);
// DESIGN ALTERNATIVES ARRAY
vm.osa.analysis.problem.design_alternatives = [];
_.forEach(vm.designAlternatives, (da) => {
const dpMatch = _.find(vm.datapoints, {name: da.name});
// do this for entire workflow or if matching datapoint is selected
if (!selectedOnly || (_.get(dpMatch, 'selected'))) {
const da_hash = {};
da_hash.name = da.name;
// check validity of DA
if (/[.$\u20AC\xA3]/.test(da_hash.name)){
vm.$log.error('illegal character (.$€£) detected in design alternative name: ', da_hash.name);
vm.osaErrors.push(`illegal character (.$€£) detected in design alternative name: ${da_hash.name}`);
}
da_hash.description = da.description;
// add if other seed
if (da.seedModel != vm.defaultSeed) {
const seed = {};
seed.file_type = 'OSM';
seed.path = './seeds/' + da.seedModel;
da_hash.seed = seed;
}
// add if other weather
if (da.weatherFile != vm.defaultWeatherFile) {
const weather = {};
weather.file_type = 'EPW';
weather.path = './weather/' + da.weatherFile;
da_hash.weather_file = weather;
}
// add option names and descriptions (only for measures that aren't skipped across all DAs)
const options = [];
let measure_count = 0;
_.forEach(vm.measures, (measure) => {
if (included_measures.indexOf(measure.name) != -1) {
const option = {};
option.measure_name = measure.name;
option.workflow_index = measure_count;
// increment count
measure_count += 1;
option.name = da[measure.name];
// check validity of option name
if (/[.$\u20AC\xA3]/.test(option.name)){
vm.$log.error('illegal character (.$€£) detected in option name: ', option.name);
vm.osaErrors.push(`illegal character (.$€£) detected in option name: ${option.name}`);
}
if (option.name == 'None' || !option.name) {
// use measure name/desc if no option
option.name = measure.name;
option.description = measure.description;
}
else {
const opt = _.find(measure.options, {name: option.name});
if (opt)
option.description = opt.description;
else
option.description = measure.description;
}
options.push(option);
}
});
da_hash.options = options;
vm.osa.analysis.problem.design_alternatives.push(da_hash);
}
});
// remove duplicates from osaErrors array
vm.osaErrors = _.uniq(vm.osaErrors);
// MEASURE DETAILS
let measure_count = 0;
let analysis_variables = 0;
let atLeastOneSkip = false;
_.forEach(vm.measures, (measure) => {
// ONLY INCLUDE if measure has options set AND if at least 1 option is added to a DA
let measureAdded = false;
// go through alternatives, also see if need skip
const vars = [];
_.forEach(vm.designAlternatives, (da) => {
const dpMatch = _.find(vm.datapoints, {name: da.name});
// do this for entire workflow or if matching datapoint is selected
if (!selectedOnly || (_.get(dpMatch, 'selected'))) {
if (da[measure.name] == 'None' || _.isUndefined(da[measure.name])) {
vars.push(true);
} else {
vars.push(false);
measureAdded = true; // measure option is added to at least 1 DA
}
}
});
if (vm.Message.showDebug()) vm.$log.debug('Measure: ', measure.name, ', numOfOptions: ', measure.numberOfOptions, ' measure added to at least 1 DA? ', measureAdded);
if (measure.numberOfOptions > 0 && measureAdded) {
const m = {};
m.name = measure.name;
m.display_name = measure.display_name;
m.measure_type = vm.getMeasureType(measure);
m.measure_definition_class_name = measure.className;
//m.measure_definition_measureUID = measure.colDef.measureUID;
const mdir = vm.getMeasureBaseDir(measure);
m.measure_definition_directory = './measures/' + mdir;
m.measure_definition_directory_local = measure.measure_dir;
m.measure_definition_class_name = measure.class_name;
m.measure_definition_display_name = measure.display_name;
m.measure_definition_name = measure.name;
m.measure_definition_name_xml = null;
m.measure_definition_uuid = measure.uid;
m.measure_definition_version_uuid = measure.version_id;
// adding these to support EDAPT reporting
m.uuid = measure.uid;
m.version_uuid = measure.version_id;
m.description = measure.description; // TODO: verify this works in JSON (could have line breaks and other special characters)
m.taxonomy = measure.tags;
// first find out how many options there are
let optionKeys = [];
//if (measure.arguments.length > 0) {
const keys = Object.keys(measure.arguments[0]);
optionKeys = _.filter(keys, (k) => {
return k.indexOf('option_') !== -1;
});
//}
// ARGUMENTS
m.arguments = [];
// This portion only has arguments that don't have the variable box checked
_.forEach(measure.arguments, (arg) => {
if (
(_.isUndefined(arg.specialRowId) || (angular.isDefined(arg.specialRowId) && arg.specialRowId.length === 0)) &&
(_.isUndefined(arg.variable) || arg.variable === false)
) {
if (vm.Message.showDebug()) vm.$log.debug(arg.name, ' is an ARGUMENT, not variable');
const argument = vm.makeArgument(arg);
if ((argument.value === '' || _.isNil(argument.value)) && arg.required) {
vm.$log.error(arg.name, ' value is \'\', this will most likely cause errors on server');
vm.osaErrors.push(`measure '${measure.display_name}' required argument '${arg.name}' value is nil or blank`);
}
if (!arg.required && (argument.value === '' || _.isNil(argument.value))){
// don't send optional incomplete/null arguments
vm.$log.info('Info: Not pushing optional argument ', argument.display_name, ' to json because it is not set.');
}
else if (argument.display_name && argument.display_name_short && argument.name && argument.value_type && !_.isNil(argument.value)) {
// make sure argument is complete
var_count += 1;
m.arguments.push(argument);
if (vm.Message.showDebug()) vm.$log.debug('argument: ', argument);
} else {
vm.$log.error('Not pushing partial argument to json. Fix partial argument: ', argument);
if (!argument.display_name || !argument.display_name_short || !argument.name || !argument.value_type){
vm.osaErrors.push(`measure '${measure.display_name}' argument '${arg.name}' is missing a value for display_name, display_name_short, name, or value_type`);
}
}
}
});
// VARIABLES
let var_count = 0;
m.variables = [];
// need a __SKIP__ argument
if (_.includes(vars, true)) {
atLeastOneSkip = true;
const v = vm.makeSkip(measure);
const valArr = [];
_.forEach(vars, (skip) => {
valArr.push({value: skip, weight: 1 / vars.length});
});
v.uncertainty_description.attributes.push({name: 'discrete', values_and_weights: valArr});
v.workflow_index = var_count;
var_count += 1;
m.variables.push(v);
}
let DAlength = null;
if (selectedOnly) {
DAlength = _.filter(vm.datapoints, {selected: true}).length;
} else {
DAlength = vm.designAlternatives.length;
}
// Variable arguments
_.forEach(measure.arguments, (arg) => {
if (((_.isUndefined(arg.specialRowId)) || (angular.isDefined(arg.specialRowId) && arg.specialRowId.length === 0)) && (arg.variable === true)) {
if (vm.Message.showDebug()) vm.$log.debug('Project::exportManual variable: ', arg.name);
// see what arg is set to in each design alternative
const valArr = [];
let option_id;
// update total analysis variable count
analysis_variables += 1;
_.forEach(vm.designAlternatives, (da) => {
const dpMatch = _.find(vm.datapoints, {name: da.name});
// do this for entire workflow or if matching datapoint is selected
if (!selectedOnly || (dpMatch && dpMatch.selected)) {
if (vm.Message.showDebug()) vm.$log.debug('Project::exportManual da: ', da);
if (da[measure.name] == 'None') {
if (vm.Message.showDebug()) vm.$log.debug('value: None');
// when set to 'None', sub a value of the right type
if (vm.Message.showDebug()) vm.$log.debug('default_value for this arg: ', arg.default_value);
let the_value = arg.default_value;
if (_.isNil(the_value)) {
// if no default value, use first option value, otherwise set to None
the_value = !_.isNil(arg.option_1) ? arg.option_1 : 'None';
if (vm.Message.showDebug()) vm.$log.debug('option1 value for this arg: ', arg.option_1);
}
if (vm.Message.showDebug()) vm.$log.debug('!! value for argument: ', arg.name, ' was set to: ', the_value);
valArr.push({value: the_value, weight: 1 / DAlength});
} else {
const option_name = da[measure.name];
if (vm.Message.showDebug()) vm.$log.debug('arg: ', arg);
if (vm.Message.showDebug()) vm.$log.debug('option_name: ', option_name);
if (vm.Message.showDebug()) vm.$log.debug('MEASURE', measure);
// retrieve the option ID from the option_name in measure.options
_.forEach(measure.options, (option) => {
if (option.name == option_name) {
option_id = option.id;
}
});
if (vm.Message.showDebug()) vm.$log.debug('arg[option_id]: ', arg[option_id]);
// check that you have a value here...if not error
if (_.isNil(arg[option_id])) {
vm.$log.error('Option: ', option_name, 'for argument: ', arg.name, ' in measure: ', measure.display_name, ' does not have a value. Analysis will error.');
vm.osaErrors.push(`Measure '${measure.display_name}' argument '${arg.name}' does not have a value for option '${option_name}'`);
}
valArr.push({value: arg[option_id], weight: 1 / DAlength});
}
}
});
const values = _.values(_.pick(arg, optionKeys));
const min = _.min(values),
max = _.max(values);
const mode = function mode(ar) {
const numMapping = {};
let greatestFreq = 0;
let currentMode = 0;
ar.forEach(function findMode(number) {
numMapping[number] = (numMapping[number] || 0) + 1;
if (greatestFreq < numMapping[number]) {
greatestFreq = numMapping[number];
currentMode = number;
}
});
return +currentMode;
};
arg.units = '';
arg.minimum = min;
arg.maximum = max;
arg.mode = mode(values);
// VARIABLE ARGUMENT SECTION
const v = {};
v.argument = vm.makeArgument(arg);
vm.$log.info(arg.choice_display_names);
v.argument.choice_display_names = arg.choice_display_names;
// VARIABLE DETAILS
v.display_name = arg.display_name; // same as arg
v.display_name_short = arg.display_name;
v.variable_type = 'variable'; //this is always 'variable'
v.units = arg.units;
v.minimum = arg.minimum; // TODO: must be alphabetically ordered if string, otherwise standard order (pick from option values mean must be btw min and max, and max > min)
v.maximum = arg.maximum; // TODO: must be alphabetically ordered
v.relation_to_output = null;
v.static_value = v.argument.value;
v.uuid = '';
v.version_uuid = '';
v.variable = true; // this is always true
v.uncertainty_description = {};
v.uncertainty_description.type = 'discrete'; //use "discrete" always for manual. options are triangle, uniform, discrete, and normal.
v.uncertainty_description.attributes = [];
v.uncertainty_description.attributes.push({name: 'discrete', values_and_weights: valArr});
v.uncertainty_description.attributes.push({name: 'lower_bounds', value: arg.minimum}); // minimum
v.uncertainty_description.attributes.push({name: 'upper_bounds', value: arg.maximum}); // maximum
if (valArr.length > 0) {
if (vm.Message.showDebug()) vm.$log.debug('Setting attribute');
v.uncertainty_description.attributes.push({name: 'modes', value: arg.mode}); // TODO: use minimum? or fake-calculate a mode btw min and max and of right type
} else {
if (vm.Message.showDebug()) vm.$log.debug('Skipping attribute');
}
v.uncertainty_description.attributes.push({name: 'delta_x', value: null});
v.uncertainty_description.attributes.push({name: 'stddev', value: null});
v.workflow_index = var_count;
var_count += 1;
m.variables.push(v);
}
});
m.workflow_index = measure_count;
measure_count += 1;
// push measure to OSA
vm.osa.analysis.problem.workflow.push(m);
} // end if measure has options or is used
});
if (analysis_variables == 0 && !atLeastOneSkip){
// error: must have at least one variable to run a PAT analysis
vm.$log.error('You need at least 1 variable set on the analysis tab or 1 measure set to \'None\' in a design alternative in order to run an analysis');
vm.osaErrors.push('You need at least 1 variable set on the analysis tab or 1 measure set to \'None\' in a design alternative in order to run an analysis');
}
}
exportAlgorithmic() {
const vm = this;
if (vm.Message.showDebug()) vm.$log.debug('In Project::exportAlgorithmic');
// ALGORITHM SETTINGS
vm.osa.analysis.problem.analysis_type = vm.samplingMethod.id.toLowerCase();
vm.osa.analysis.problem.algorithm = {};
_.forEach(vm.algorithmSettings, (setting) => {
if (setting.name === 'r2'){
// exception
vm.osa.analysis.problem.algorithm[setting.name] = setting.value;
}
else {
vm.osa.analysis.problem.algorithm[_.snakeCase(setting.name)] = setting.value;
}
});
// ensure # of levels is at least 2 for Morris algorithm
if (vm.samplingMethod.id === 'morris' && vm.osa.analysis.problem.algorithm.levels < 2){
vm.$log.error('This algorithm\'s \'levels\' setting (defined on the analysis tab) needs a value of at least 2 to run successfully');
vm.osaErrors.push('This algorithm\'s \'levels\' setting (defined on the analysis tab) needs a value of at least 2 to run successfully');
}