/
plotlysetup_online.m
228 lines (186 loc) · 9.4 KB
/
plotlysetup_online.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
function plotlysetup_online(username, api_key, varargin)
% CALL: plotlysetup_online('username','api_key','kwargs'[optional]);
% WHERE: kwargs are of the form ..,'property,value,'property',value,...
% VALID PROPERTIES [OPTIONAL]: 'stream_ids' -> your stream ids [cell array] (found online)
% 'plotly_domain' -> your desired REST API enpoint [string]
% 'plotly_streaming_domain'-> your desired Stream API endpoint [string]
% [1] adds plotly api to matlabroot/toolboxes. If successful do [2]
% [2] adds plotly api to searchpath via startup.m of matlabroot and/or userpath
% [3] calls saveplotlycredentials (using username, api_key and stream_ids [optional])
% [4] calls saveplotlyconfig with ('plotly_domain'[optional], 'plotly_streaming_domain' [optional])
%DEFAULT OUTPUT
exception.message = '';
exception.identifier = '';
try %check number of inputs
if (nargin<2||nargin>8)
error('plotly:wrongInput',....
['\n\nWhoops! Wrong number of inputs. Please run >> help plotlysetup_online \n',...
'for more information regarding the setup your Plotly API MATLAB \n',...
'Library. Please post a topic on https://community.plotly.com/c/api/matlab/ for more information.']);
end
catch exception %plotlysetup input problem catch...
fprintf(['\n\n' exception.identifier exception.message '\n\n']);
return
end
try
%check to see if plotly is in the searchpath
plotlysetupPath = which('plotlysetup');
plotlyFolderPath = fullfile(fileparts(plotlysetupPath),'plotly');
%if it was not found
if (strcmp(genpath(plotlyFolderPath),''))
error('plotly:notFound',...
['\n\nShoot! It looks like MATLAB is having trouble finding the current version ' ...
'\nof Plotly. Please make sure that the Plotly API folder is in the same ' ...
'\ndirectory as plotlysetup.m. Questions? Ask on https://community.plotly.com/c/api/matlab/\n\n']);
end
%add Plotly API MATLAB Library to search path
addpath(genpath(plotlyFolderPath));
catch exception %plotly file not found problem catch
fprintf(['\n\n' exception.identifier exception.message '\n']);
return
end
if(~is_octave)
try
%embed the api to the matlabroot/toolbox dir.
fprintf('\nAdding Plotly to MATLAB toolbox directory ... ');
%plotly folder in the matlab/toolbox dir.
plotlyToolboxPath = fullfile(matlabroot,'toolbox','plotly');
if(exist(plotlyToolboxPath,'dir')) %check for overwrite...
fprintf(['\n\n[UPDATE]: \n\nHey! We see that a copy of Plotly has previously been added to\n' ...
'your Matlab toolboxes. Would you like us to overwrite it with:\n' plotlyFolderPath ' ? \n'...
'Careful! You may lose data saved to this Plotly directory.\n\n']);
overwrite = input('Overwrite (y/n) ? : ','s');
if(strcmpi(overwrite,'y'));
fprintf('\n[OVERWRITE]:\n\nOverwriting Plotly! ... Done \n');
else
fprintf('\n[NO OVERWRITE]:\n\nDid not overwrite Plotly! ... Done \n');
end
else %toolbox Plotly not yet created
%worked (without interuption)...just a formatting thing!
fprintf('Done\n');
%make the plotlyToolboxPath dir.
status = mkdir(plotlyToolboxPath);
%set status to overwrite
overwrite = 'y';
%check that the folder was created
if (status == 0)
error('plotly:savePlotly', permissionMessage('save the Plotly folder'));
end
end
if(strcmpi(overwrite,'y'))
%move a copy of the Plotly api to matlab root directory
[status, msg, messid] = copyfile(plotlyFolderPath,plotlyToolboxPath);
%check that the plotly api was copied to the matlab root toolbox directory
if (status == 0)
if(~strcmp(messid, 'MATLAB:COPYFILE:SourceAndDestinationSame'))
error('plotly:copyPlotly',permissionMessage('copy the Plotly folder'));
end
end
end
%add it to the searchpath (startup.m will handle this next time!)
addpath(genpath(plotlyToolboxPath),'-end');
%save plotly api searchpath to startup.m files (only do this if we actually were able to store the api in mtlroot/toolbox!)
fprintf('Saving Plotly to MATLAB search path via startup.m ... ');
%check for a startup.m file in matlab rootpath (we want to add one here)
startupFile = [];
startupFileRootPath = fullfile(matlabroot,'toolbox','local','startup.m');
if(~exist(startupFileRootPath,'file'))
startFileID = fopen(startupFileRootPath, 'w');
%startup.m does not exist and startupFilePath is non-writable
if(startFileID == -1)
error('plotly:rootStartupCreation',permissionMessage('write the startup.m script'));
end
startupFile = {startupFileRootPath}; %needed because MATLAB only looks for startup.m when first opened.
end
%check for all startup.m file in searchpath
startupFile = [startupFile; cell(which('startup.m','-all'))];
%write the addpath - plotly api to the startup.m files
[warnings] = addplotlystartup(startupFile);
%worked!
fprintf(' Done\n');
%print any addplotlydstatup warnings;
w = cellfun(@isempty,warnings);
if(find(~w))
%output warnings
exception.warnings = warnings;
fprintf(warnings{find(~w)});
end
catch exception %copying to toolbox/writing to startup.m permission problem catch...
fprintf(['\n\n' exception.identifier exception.message '\n\n']);
end
else %if octave
fprintf('\n\nOctave users: Automatic Plotly API embedding coming soon!\n\n');
end %end check for matlab...
try %save user credentials
fprintf('Saving username/api_key credentials ... ');
%update: as of v.2.1.7, This also signs in the user
saveplotlycredentials(username, api_key);
%worked!
fprintf('Done\n');
catch exception %writing credentials file permission problem catch...
fprintf(['\n\n' exception.identifier exception.message '\n\n']);
end
%----handle varargin----%
try
%check for ..,property,value,.. structure
if mod(numel(varargin),2)~= 0
error('plotly:wrongInputVarargin',....
['\n\nWhoops! Wrong number of varargin inputs. Please run >> help plotlysetup \n',...
'for more information regarding the setup of your Plotly API MATLAB Library. \n',...
'Your stream_ids, plotly_domain, and plotly_streaming domain were not set. \n',...
'Questions? Please post on https://community.plotly.com/c/api/matlab/22.']);
end
for n = 1:2:numel(varargin)
%check for correct property names
if isempty(intersect(varargin{n},{'stream_ids','plotly_domain','plotly_streaming_domain'}))
error('plotly:wrongInputPropertyName',....
['\n\nWhoops! The properperty name: ' varargin{n} ' is invalid. \n',...
'Please run >> help plotlysetup for more information regarding\n',...
'the setup your Plotly API MATLAB Library.']);
end
if strcmp(varargin{n},'stream_ids')
fprintf('Saving stream_ids credentials ... ');
%update: as of v.2.1.7, This also signs in the user
saveplotlycredentials(username, api_key, varargin{n+1});
%worked!
fprintf('Done\n');
end
if strcmp(varargin{n},'plotly_domain')
fprintf('Saving plotly_domain configuration ... ');
%update: as of v.2.1.7, This also signs in the user
saveplotlyconfig(varargin{n+1});
%worked!
fprintf('Done\n');
end
if strcmp(varargin{n},'plotly_streaming_domain')
fprintf('Saving plotly_streaming_domain configuration ... ');
try
config = loadplotlyconfig;
catch
config.plotly_domain = '';
end
%update: as of v.2.1.7, This also signs in the user
saveplotlyconfig(config.plotly_domain,varargin{n+1});
%worked!
fprintf('Done\n');
end
end
catch exception %writing varargin problem catch...
fprintf(['\n\n' exception.identifier exception.message '\n\n']);
end
%greet the people!
fprintf('\nWelcome to Plotly! If you are new to Plotly please enter: >> plotlyhelp to get started!\n\n')
end
%helper message function
function message = permissionMessage(spec)
message = ['\n\nShoot! We tried to ' spec ' to the MATLAB toolbox \n',...
'directory, but were denied write permission. You''ll have to add\n',...
'the Plotly folder to your MATLAB path manually by running: \n\n',...
'>> plotly_path = fullfile(pwd, ''plotly'')\n',...
'>> addpath(genpath(plotly_path))\n\n',...
'You can save your credentials by running:\n\n', ...
'>>saveplotlycredentials(''your_username'', ''your_api_key'')\n\n',...
'You can save your domain configuration by running:\n\n',...
'>>saveplotlyconfig(''your_base_domain'')\n\n',...
'Questions? Ask https://community.plotly.com/c/api/matlab/\n\n'];
end