forked from opencobra/cobratoolbox
-
Notifications
You must be signed in to change notification settings - Fork 0
/
initCobraToolbox.m
748 lines (643 loc) · 26.1 KB
/
initCobraToolbox.m
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
function initCobraToolbox(updateToolbox)
% _____ _____ _____ _____ _____ |
% / ___| / _ \ | _ \ | _ \ / ___ \ | COnstraint-Based Reconstruction and Analysis
% | | | | | | | |_| | | |_| | | |___| | | The COBRA Toolbox - 2017
% | | | | | | | _ { | _ / | ___ | |
% | |___ | |_| | | |_| | | | \ \ | | | | | Documentation:
% \_____| \_____/ |_____/ |_| \_\ |_| |_| | http://opencobra.github.io/cobratoolbox
% |
%
% initCobraToolbox Initialize COnstraint-Based Reconstruction and Analysis Toolbox
%
% Defines default solvers and paths, tests SBML io functionality.
% Function only needs to be called once per installation. Saves paths afer script terminates.
%
% In addition add either of the following into startup.m (generally in MATLAB_DIRECTORY/toolbox/local/startup.m)
%
% initCobraToolbox
% -or-
% changeCobraSolver('gurobi');
% changeCobraSolver('gurobi', 'MILP');
% changeCobraSolver('tomlab_cplex', 'QP');
% changeCobraSolver('tomlab_cplex', 'MIQP');
% changeCbMapOutput('svg');
%
% Maintained by Ronan M.T. Fleming, Sylvain Arreckx, Laurent Heirendt
% define GLOBAL variables
global CBTDIR;
global SOLVERS;
global OPT_PROB_TYPES;
global CBT_LP_SOLVER;
global CBT_MILP_SOLVER;
global CBT_QP_SOLVER;
global CBT_MIQP_SOLVER;
global CBT_NLP_SOLVER;
global GUROBI_PATH;
global ILOG_CPLEX_PATH;
global TOMLAB_PATH;
global MOSEK_PATH;
global WAITBAR_TYPE;
global ENV_VARS;
global gitBashVersion;
global CBT_MISSING_REQUIREMENTS_ERROR_ID;
if ~exist('updateToolbox','var')
updateToolbox = true;
end
% define a base version of gitBash that is tested
gitBashVersion = '2.13.3';
% Set the Requirements Error Message ID:
CBT_MISSING_REQUIREMENTS_ERROR_ID = 'COBRA:RequirementsNotMet';
% default waitbar is of type text
if isempty(WAITBAR_TYPE)
WAITBAR_TYPE = 1;
end
% Linux only - default save path location
defaultSavePathLocation = '~/pathdef.m';
% initialize the cell of solvers
SOLVERS = {};
% declare that the environment variables have not yet been configured
ENV_VARS.STATUS = 0;
% initialize the paths
if exist('GUROBI_PATH', 'var') ~= 1
GUROBI_PATH = '';
end
if exist('ILOG_CPLEX_PATH', 'var') ~= 1
ILOG_CPLEX_PATH = '';
end
if exist('TOMLAB_PATH', 'var') ~= 1
TOMLAB_PATH = '';
end
if exist('MOSEK_PATH', 'var') ~= 1
MOSEK_PATH = '';
end
% print header
if ~isfield(ENV_VARS, 'printLevel') || ENV_VARS.printLevel
docLink = 'http://opencobra.github.io/cobratoolbox';
if usejava('desktop')
docLink = ['<a href=\"', docLink, '\">', docLink, '</a>'];
end
c = clock;
fprintf('\n\n _____ _____ _____ _____ _____ |\n');
fprintf(' / ___| / _ \\ | _ \\ | _ \\ / ___ \\ | COnstraint-Based Reconstruction and Analysis\n');
fprintf([' | | | | | | | |_| | | |_| | | |___| | | The COBRA Toolbox - ' num2str(c(1)) '\n']);
fprintf(' | | | | | | | _ { | _ / | ___ | |\n');
fprintf(' | |___ | |_| | | |_| | | | \\ \\ | | | | | Documentation:\n');
fprintf([' \\_____| \\_____/ |_____/ |_| \\_\\ |_| |_| | ', docLink, '\n']);
fprintf(' | \n\n');
ENV_VARS.printLevel = true;
end
% retrieve the current directory
currentDir = pwd;
% define the root path of The COBRA Toolbox and change to it.
CBTDIR = fileparts(which('initCobraToolbox'));
cd(CBTDIR);
% add the external install folder
addpath(genpath([CBTDIR filesep 'external' filesep 'base' filesep 'install']));
%And the rdir directory
addpath(genpath([CBTDIR filesep 'external' filesep 'base' filesep 'utilities' filesep 'rdir']));
% add the install folder
addpath(genpath([CBTDIR filesep 'src' filesep 'base' filesep 'install']));
% check if git is installed
[installedGit, versionGit] = checkGit();
% set the depth flag if the version of git is higher than 2.10.0
depthFlag = '';
if installedGit && versionGit > 2100
depthFlag = '--depth=1';
end
% change to the root of The COBRA Tooolbox
cd(CBTDIR);
% configure a remote tracking repository
if ENV_VARS.printLevel
fprintf(' > Checking if the repository is tracked using git ... ');
end
% check if the directory is a git-tracked folder
if exist([CBTDIR filesep '.git'], 'dir') ~= 7
% initialize the directory
[status_gitInit, result_gitInit] = system('git init');
if status_gitInit ~= 0
fprintf(result_gitInit);
error(' > This directory is not a git repository.\n');
end
% set the remote origin
[status_setOrigin, result_setOrigin] = system('git remote add origin https://github.com/opencobra/cobratoolbox.git');
if status_setOrigin ~= 0
fprintf(result_setOrigin);
error(' > The remote tracking origin could not be set.');
end
% check curl
[status_curl, result_curl] = checkCurlAndRemote();
if status_curl == 0
% set the remote origin
[status_fetch, result_fetch] = system(['git fetch origin master ' depthFlag]);
if status_fetch ~= 0
fprintf(result_fetch);
error(' > The files could not be fetched.');
end
[status_resetMixed, result_resetMixed] = system('git reset --mixed origin/master');
if status_resetMixed ~= 0
fprintf(result_resetMixed);
error(' > The remote tracking origin could not be set.');
end
end
end
if ENV_VARS.printLevel
fprintf(' Done.\n');
end
% temporary disable ssl verification
[status_setSSLVerify, result_setSSLVerify] = system('git config http.sslVerify false');
if status_setSSLVerify ~= 0
fprintf(strrep(result_setSSLVerify, '\', '\\'));
warning('Your global git configuration could not be changed.');
end
% check curl
[status_curl, result_curl] = checkCurlAndRemote(false);
% check if the URL exists
if exist([CBTDIR filesep 'binary' filesep 'README.md'], 'file') && status_curl ~= 0
fprintf(' > Submodules exist but cannot be updated (remote cannot be reached).\n');
elseif status_curl == 0
if ENV_VARS.printLevel
fprintf(' > Initializing and updating submodules (this may take a while)...');
end
% Clean the test/models folder
[status, result] = system('git submodule status test/models');
if status == 0 && strcmp(result(1), '-')
[status, message, messageid] = rmdir([CBTDIR filesep 'test' filesep 'models'], 's');
end
% Update/initialize submodules
[status_gitSubmodule, result_gitSubmodule] = system(['git submodule update --init --remote --no-fetch ' depthFlag]);
if status_gitSubmodule ~= 0
fprintf(strrep(result_gitSubmodule, '\', '\\'));
error('The submodules could not be initialized.');
end
% reset each submodule
[status_gitReset, result_gitReset] = system('git submodule foreach --recursive git reset --hard');
if status_gitReset ~= 0
fprintf(strrep(result_gitReset, '\', '\\'));
warning('The submodules could not be reset.');
end
if ENV_VARS.printLevel
fprintf(' Done.\n');
end
end
%get the current content of the init Folder
dirContent = getFilesInDir('type','all');
% add the folders of The COBRA Toolbox
folders = {'tutorials', 'papers', 'binary', 'deprecated', 'src', 'test', '.tmp'};
if ENV_VARS.printLevel
fprintf(' > Adding all the files of The COBRA Toolbox ... ')
end
% add the root folder
addpath(CBTDIR);
% add the external folder
addpath(genpath([CBTDIR filesep 'external']));
% add specific subfolders
for k = 1:length(folders)
tmpDir = [CBTDIR, filesep, folders{k}];
if exist(tmpDir, 'dir') == 7
addpath(genpath(tmpDir));
end
end
%Adapt the mac path depending on the mac version.
if ismac
adaptMacPath()
end
% add the docs/source/notes folder
addpath(genpath([CBTDIR filesep 'docs' filesep 'source' filesep 'notes']));
% print a success message
if ENV_VARS.printLevel
fprintf(' Done.\n');
end
% Define default CB map output
if ENV_VARS.printLevel
fprintf(' > Define CB map output...');
end
for CbMapOutput = {'svg', 'matlab'}
CbMapOutputOK = changeCbMapOutput(char(CbMapOutput));
if CbMapOutputOK
break;
end
end
if CbMapOutputOK
if ENV_VARS.printLevel
fprintf(' set to %s.\n', char(CbMapOutput));
end
else
if ENV_VARS.printLevel
fprintf('FAILED.\n');
end
end
% define xml test file
xmlTestModel = 'ecoli_core_model.xml';
xmlTestFile = [getDistributedModelFolder(xmlTestModel) filesep xmlTestModel];
% save the userpath
originalUserPath = path;
% Set global LP solution accuracy tolerance
changeCobraSolverParams('LP', 'optTol', 1e-6);
% Check that SBML toolbox is installed and accessible
if ~exist('TranslateSBML', 'file')
if ENV_VARS.printLevel
warning('libsbml binaries not on Matlab path: COBRA Toolbox will be unable to read/write SBML files');
end
else
% Test the installation with:
try
TranslateSBML(xmlTestFile);
if ENV_VARS.printLevel
fprintf(' > TranslateSBML is installed and working properly.\n');
end
catch
if ENV_VARS.printLevel
warning(' > TranslateSBML is installed but is not working properly.');
fprintf([' > Try running\n >> TranslateSBML(\''', strrep(xmlTestFile, '\', '\\'), '\'');\n in order to debug.\n']);
end
end
end
if ENV_VARS.printLevel
fprintf(' > Configuring solver environment variables ...\n');
configEnvVars(1);
fprintf(' Done.\n');
fprintf(' > Checking available solvers and solver interfaces ...');
end
% define categories of solvers: LP, MILP, QP, MIQP, NLP
OPT_PROB_TYPES = {'LP', 'MILP', 'QP', 'MIQP', 'NLP'};
%Define a set of "use first" solvers, other supported solvers will also be added to the struct.
%This allows to assign them in any order but keep the most commonly used ones on top of the struct.
SOLVERS = struct('gurobi',struct(),...
'ibm_cplex',struct(),...
'tomlab_cplex',struct(),...
'glpk',struct(),...
'mosek',struct(),...
'matlab',struct());
% active support - supported solvers
SOLVERS.cplex_direct.type = {'LP', 'MILP', 'QP', 'MIQP'};
SOLVERS.dqqMinos.type = {'LP'};
SOLVERS.glpk.type = {'LP', 'MILP'};
SOLVERS.gurobi.type = {'LP', 'MILP', 'QP', 'MIQP'};
SOLVERS.ibm_cplex.type = {'LP', 'MILP', 'QP'};
SOLVERS.matlab.type = {'LP', 'NLP'};
SOLVERS.mosek.type = {'LP', 'QP'};
SOLVERS.pdco.type = {'LP', 'QP'};
SOLVERS.quadMinos.type = {'LP'};
SOLVERS.tomlab_cplex.type = {'LP', 'MILP', 'QP', 'MIQP'};
% passive support - solver interfaces
SOLVERS.qpng.type = {'QP'};
SOLVERS.tomlab_snopt.type = {'NLP'};
% legacy solvers
%SOLVERS.gurobi_mex.type = {'LP', 'MILP', 'QP', 'MIQP'};
%SOLVERS.lindo_old.type = {'LP'};
%SOLVERS.lindo_legacy.type = {'LP'};
SOLVERS.lp_solve.type = {'LP'};
%SOLVERS.opti.type = {'LP', 'MILP', 'QP', 'MIQP', 'NLP'};
% definition of category of solvers with active support
SOLVERS.cplex_direct.categ = 'active';
SOLVERS.dqqMinos.categ = 'active';
SOLVERS.glpk.categ = 'active';
SOLVERS.gurobi.categ = 'active';
SOLVERS.ibm_cplex.categ = 'active';
SOLVERS.matlab.categ = 'active';
SOLVERS.mosek.categ = 'active';
SOLVERS.pdco.categ = 'active';
SOLVERS.quadMinos.categ = 'active';
SOLVERS.tomlab_cplex.categ = 'active';
% definition of category of solvers with passive support
SOLVERS.qpng.categ = 'passive';
SOLVERS.tomlab_snopt.categ = 'passive';
% definition of category of solvers with legacy support
%SOLVERS.gurobi_mex.categ = 'legacy';
%SOLVERS.lindo_old.categ = 'legacy';
%SOLVERS.lindo_legacy.categ = 'legacy';
SOLVERS.lp_solve.categ = 'legacy';
%SOLVERS.opti.categ = 'legacy';
% definition of categories of solvers
supportedSolversNames = fieldnames(SOLVERS);
catSolverNames.LP = {}; catSolverNames.MILP = {}; catSolverNames.QP = {}; catSolverNames.MIQP = {}; catSolverNames.NLP = {};
for i = 1:length(supportedSolversNames)
SOLVERS.(supportedSolversNames{i}).installed = false;
SOLVERS.(supportedSolversNames{i}).working = false;
types = SOLVERS.(supportedSolversNames{i}).type;
for j = 1:length(types)
catSolverNames.(types{j}){end + 1} = supportedSolversNames{i};
end
end
% check the installation of the solver
for i = 1:length(supportedSolversNames)
%We will validate all solvers in init. After this, all solvers are
%checked, whether they actually work and the SOLVERS field is set.
[solverOK,solverInstalled] = changeCobraSolver(supportedSolversNames{i},...
SOLVERS.(supportedSolversNames{i}).type{1},...
0, 2);
if solverOK
SOLVERS.(supportedSolversNames{i}).working = true;
end
SOLVERS.(supportedSolversNames{i}).installed = solverInstalled;
end
if ENV_VARS.printLevel
fprintf(' Done.\n');
end
% set the default solver and print out the default variables
if ENV_VARS.printLevel
fprintf(' > Setting default solvers ...');
changeCobraSolver('glpk', 'LP', 0);
changeCobraSolver('glpk', 'MILP', 0);
changeCobraSolver('qpng', 'QP', 0);
changeCobraSolver('matlab', 'NLP', 0);
for k = 1:length(OPT_PROB_TYPES)
varName = horzcat(['CBT_', OPT_PROB_TYPES{k}, '_SOLVER']);
end
fprintf(' Done.\n');
end
% fill the summary table
solverTypeInstalled = zeros(length(OPT_PROB_TYPES), 1);
solverStatus = -1 * ones(length(supportedSolversNames), length(OPT_PROB_TYPES) + 1);
catList = cell(length(supportedSolversNames), 1);
for i = 1:length(supportedSolversNames)
types = SOLVERS.(supportedSolversNames{i}).type;
catList{i} = SOLVERS.(supportedSolversNames{i}).categ;
for j = 1:length(types)
k = find(ismember(OPT_PROB_TYPES, types{j}));
if SOLVERS.(supportedSolversNames{i}).installed
solverStatus(i, k + 1) = 1;
solverTypeInstalled(k) = solverTypeInstalled(k) + 1;
% set the default MIQP solver based on the solvers that are installed
if strcmpi(types{j}, 'MIQP')
changeCobraSolver(supportedSolversNames{i}, types{j}, 0);
end
else
solverStatus(i, k + 1) = 0;
end
end
end
catList{end + 1} = '----------';
catList{end + 1} = '-';
rowNames = [supportedSolversNames; '----------'; 'Total'];
solverStatus(end + 1, :) = ones(1, length(OPT_PROB_TYPES) + 1);
solverStatus(end + 1, 2:end) = solverTypeInstalled';
statusTable = {};
for k = 1:5
statusTable{k} = cellstr(num2str(solverStatus(:, k+1)));
for p = 1:length(solverStatus(:, k+1))
if strcmp(statusTable{k}(p), '-1')
statusTable{k}(p) = {'-'};
end
end
end
% restore the original path
path(originalUserPath);
addpath(originalUserPath);
% saves the current path
try
if ENV_VARS.printLevel
fprintf(' > Saving the MATLAB path ...');
end
if ispc || ismac
savepath;
if ENV_VARS.printLevel
fprintf(' Done.\n');
fprintf(' - The MATLAB path was saved in the default location.\n');
end
else
[~, values] = fileattrib(which('pathdef.m'));
if values.UserWrite
savepath
else
savepath(defaultSavePathLocation);
end
if ENV_VARS.printLevel
fprintf(' Done.\n');
fprintf([' - The MATLAB path was saved as ', defaultSavePathLocation, '.\n']);
end
end
catch
if ENV_VARS.printLevel
fprintf(' > The MATLAB path could not be saved.');
end
end
% print out a summary table
if ENV_VARS.printLevel
colFormat = '\t%-12s \t%-13s \t%5s \t%5s \t%5s \t%5s \t%5s\n';
sep = '\t----------------------------------------------------------------------\n';
fprintf('\n > Summary of available solvers and solver interfaces\n\n');
if ispc
topLineFormat = '\t\t\t\t\tSupport %5s \t%5s \t%5s \t%5s \t%5s\n';
else
topLineFormat = '\t\t\tSupport \t%5s \t%5s \t%5s \t%5s \t%5s\n';
end
fprintf(topLineFormat, OPT_PROB_TYPES{1}, OPT_PROB_TYPES{2}, OPT_PROB_TYPES{3}, OPT_PROB_TYPES{4}, OPT_PROB_TYPES{5})
fprintf(sep);
for i = 1:length(catList)-2
fprintf(colFormat, rowNames{i}, catList{i}, statusTable{1}{i}, statusTable{2}{i}, statusTable{3}{i}, statusTable{4}{i}, statusTable{5}{i})
end
fprintf(sep);
fprintf(colFormat, rowNames{end}, catList{end}, statusTable{1}{end}, statusTable{2}{end}, statusTable{3}{end}, statusTable{4}{end}, statusTable{5}{end})
fprintf('\n + Legend: - = not applicable, 0 = solver not compatible or not installed, 1 = solver installed.\n\n\n')
end
% provide clear instructions and summary
for i = 1:length(OPT_PROB_TYPES)
if sum(solverStatus(:, i + 1) == 1) == 0
if ENV_VARS.printLevel
fprintf(' > You cannot solve %s problems. Consider installing an %s solver.\n', char(OPT_PROB_TYPES(i)), char(OPT_PROB_TYPES(i)));
end
else
if ENV_VARS.printLevel
fprintf(' > You can solve %s problems using: ', char(OPT_PROB_TYPES(i)));
end
k = 1;
for j = 1:length(catSolverNames.(OPT_PROB_TYPES{i}))
if SOLVERS.(catSolverNames.(OPT_PROB_TYPES{i}){j}).working
if k == 1
msg = '''%s'' ';
else
msg = '- ''%s'' ';
end
if ENV_VARS.printLevel
fprintf(msg, catSolverNames.(OPT_PROB_TYPES{i}){j});
end
k = k + 1;
end
end
if ENV_VARS.printLevel
fprintf('\n');
end
end
end
if ENV_VARS.printLevel
fprintf('\n');
end
% use Gurobi (if installed) as the default solver for LP, QP and MILP problems
changeCobraSolver('gurobi', 'ALL', 0);
% check if a new update exists
if ENV_VARS.printLevel && status_curl == 0 && ~isempty(strfind(result_curl, ' 200')) && updateToolbox
updateCobraToolbox(true); % only check
else
if ~updateToolbox && ENV_VARS.printLevel
fprintf('> Checking for available updates ... skipped\n')
end
end
% restore global configuration by unsetting http.sslVerify
[status_setSSLVerify, result_setSSLVerify] = system('git config --unset http.sslVerify');
if status_setSSLVerify ~= 0
fprintf(strrep(result_setSSLVerify, '\', '\\'));
warning('Your global git configuration could not be restored.');
end
% set up the COBRA System path
addCOBRABinaryPathToSystemPath();
% change back to the current directory
cd(currentDir);
% cleanup at the end of the successful run
removeTempFiles(CBTDIR, dirContent);
% clear all temporary variables
% Note: global variables are kept in memory - DO NOT clear all the variables!
if ENV_VARS.printLevel
clearvars
end
end
function [installed, versionGit] = checkGit()
% Checks if git is installed on the system and throws an error if not
%
% USAGE:
% versionGit = checkGit();
%
% OUTPUT:
% installed: boolean to determine whether git is installed or not
% versionGit: version of git installed
%
global ENV_VARS
% set the boolean as false (not installed)
installed = false;
if ENV_VARS.printLevel
fprintf(' > Checking if git is installed ... ')
end
% check if git is properly installed
[status_gitVersion, result_gitVersion] = system('git --version');
% get index of the version string
searchStr = 'git version';
index = strfind(result_gitVersion, searchStr);
if status_gitVersion == 0 && ~isempty(index)
% determine the version of git
versionGitStr = result_gitVersion(length(searchStr)+1:end);
% replace line breaks and white spaces
versionGitStr = regexprep(versionGitStr(1:7),'\s+','');
% replace the dots in the version number
tmp = strrep(versionGitStr, '.', '');
% convert the string of the version number to a number
versionGit = str2num(tmp);
% set the boolean to true
installed = true;
if ENV_VARS.printLevel
fprintf([' Done (version: ' versionGitStr ').\n']);
end
else
if ispc
fprintf('(not installed).\n');
installGitBash();
else
fprintf(result_gitVersion);
fprintf(' > Please follow the guidelines on how to install git: https://opencobra.github.io/cobratoolbox/docs/requirements.html.\n');
error(' > git is not installed.');
end
end
end
function [status_curl, result_curl] = checkCurlAndRemote(throwError)
% Checks if curl is installed on the system, can connect to the opencobra URL, and throws an error if not
%
% USAGE:
% status_curl = checkCurlAndRemote(throwError)
%
% INPUT:
% throwError: boolean variable that specifies if an error is thrown or a message is displayed
%
global ENV_VARS
if nargin < 1
throwError = true;
end
if ENV_VARS.printLevel
fprintf(' > Checking if curl is installed ... ')
end
origLD = getenv('LD_LIBRARY_PATH');
newLD = regexprep(getenv('LD_LIBRARY_PATH'), [matlabroot '/bin/' computer('arch') ':'], '');
% check if curl is properly installed
[status_curl, result_curl] = system('curl --version');
if status_curl == 0 && ~isempty(strfind(result_curl, 'curl')) && ~isempty(strfind(result_curl, 'http'))
if ENV_VARS.printLevel
fprintf(' Done.\n');
end
elseif ((status_curl == 127 || status_curl == 48) && isunix)
% status_curl of 48 is "An unknown option was passed in to libcurl"
% status_curl of 127 is a bash/shell error for "command not found"
% You can get either if there is mismatch between the library
% libcurl and the curl program, which happens with matlab's
% distributed libcurl. In order to avoid library mismatch we
% temporarily fchange LD_LIBRARY_PATH
setenv('LD_LIBRARY_PATH', newLD);
[status_curl, result_curl] = system('curl --version');
setenv('LD_LIBRARY_PATH', origLD);
if status_curl == 0 && ~isempty(strfind(result_curl, 'curl')) && ~isempty(strfind(result_curl, 'http'))
if ENV_VARS.printLevel
fprintf(' Done.\n');
end
else
if throwError
fprintf(result_curl);
fprintf(' > Please follow the guidelines on how to install curl: https://opencobra.github.io/cobratoolbox/docs/requirements.html.\n');
error(' > curl is not installed.');
else
if ENV_VARS.printLevel
fprintf(' (not installed).\n');
end
end
end
else
if throwError
if ispc
fprintf('(not installed).\n');
installGitBash();
else
fprintf(result_curl);
fprintf(' > Please follow the guidelines on how to install curl: https://opencobra.github.io/cobratoolbox/docs/requirements.html.\n');
error(' > curl is not installed.');
end
else
if ENV_VARS.printLevel
fprintf(' (not installed).\n');
end
end
end
if ENV_VARS.printLevel
fprintf(' > Checking if remote can be reached ... ')
end
% check if the remote repository can be reached
[status_curl, result_curl] = system('curl -s -k --head https://github.com/opencobra/cobratoolbox');
% check if the URL exists
if status_curl == 0 && ~isempty(strfind(result_curl, ' 200'))
if ENV_VARS.printLevel
fprintf(' Done.\n');
end
elseif ((status_curl == 127 || status_curl == 48) && isunix)
setenv('LD_LIBRARY_PATH', newLD);
[status_curl, result_curl] = system('curl -s -k --head https://github.com/opencobra/cobratoolbox');
setenv('LD_LIBRARY_PATH', origLD);
if status_curl == 0 && ~isempty(strfind(result_curl, ' 200'))
if ENV_VARS.printLevel
fprintf(' Done.\n');
end
else
if throwError
fprintf(result_curl);
error('The remote repository cannot be reached. Please check your internet connection.');
else
if ENV_VARS.printLevel
fprintf(' (unsuccessful - no internet connection).\n');
end
end
end
else
if throwError
fprintf(result_curl);
error('The remote repository cannot be reached. Please check your internet connection.');
else
if ENV_VARS.printLevel
fprintf(' (unsuccessful - no internet connection).\n');
end
end
end
end