-
Notifications
You must be signed in to change notification settings - Fork 32
/
Larch.pm
367 lines (300 loc) · 9.79 KB
/
Larch.pm
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
package Larch;
# require Exporter;
# @ISA = qw(Exporter);
# @EXPORT_OK = qw(dispose larch decode_data get_data get_messages
# get_larch_scalar put_larch_scalar
# get_larch_array put_larch_array
# create_larch_connection shutdown_larch_connection
# get_client_info set_client_info run_selftest);
use strict;
use warnings;
use Cwd;
use Demeter::Here;
use File::Which qw(which);
use RPC::XML::Client;
use Time::HiRes qw(usleep);
use vars qw($larch_is_go $larchconn $larch_exe $larch_port);
$larch_exe = q{};
sub find_larch {
# search for Python exe and larch_server script,
# return command to run larch server
my $osname = lc($^O);
my $pyexec_name = "python";
my $pyscript_dir = "";
if (($osname eq 'mswin32') or ($osname eq 'cygwin')) {
$pyexec_name = "python.exe";
$pyscript_dir = "Scripts";
}
# first look on PATH
my $py_exe = which($pyexec_name);
my $larch_exe = which("larch_server");
if (defined($py_exe) && (-e $py_exe) && defined($larch_exe) && (-e $larch_exe)) {
return $larch_exe;
}
# if larch is not found on PATH, look in typical Python / Anaconda places
# build list of typical Python / Anaconda install directories
my @dirlist = split /;/, $ENV{'PATH'};
if (($osname eq 'mswin32') or ($osname eq 'cygwin')) {
push @dirlist, (File::Spec->catfile($ENV{LOCALAPPDATA}, 'Continuum', 'xraylarch'),
File::Spec->catfile($ENV{LOCALAPPDATA}, 'Continuum', 'Anaconda3'),
File::Spec->catfile($ENV{LOCALAPPDATA}, 'Continuum', 'Anaconda2'),
File::Spec->catfile($ENV{LOCALAPPDATA}, 'Continuum', 'Anaconda'),
File::Spec->catfile($ENV{APPDATA}, 'Continuum', 'xraylarch'),
File::Spec->catfile($ENV{APPDATA}, 'Continuum', 'Anaconda3'),
File::Spec->catfile($ENV{APPDATA}, 'Continuum', 'Anaconda2'),
File::Spec->catfile($ENV{APPDATA}, 'Continuum', 'Anaconda'),
'C:\Python37', 'C:\Python36', 'C:\Python35', 'C:\Python27');
} else {
push @dirlist, (File::Spec->catfile($ENV{HOME}, 'xraylarch', 'bin'),
File::Spec->catfile($ENV{HOME}, 'anaconda3', 'bin'),
File::Spec->catfile($ENV{HOME}, 'anaconda2', 'bin'),
File::Spec->catfile($ENV{HOME}, 'anaconda', 'bin'),
File::Spec->catfile('/', 'anaconda3', 'bin'),
File::Spec->catfile('/', 'anaconda2', 'bin'),
File::Spec->catfile('/', 'anaconda', 'bin'),
);
}
foreach my $d (@dirlist) {
my $py_exe = File::Spec->catfile($d, $pyexec_name);
my $larch_exe = File::Spec->catfile($d, $pyscript_dir, 'larch_server');
if ((-e $py_exe) && (-e $larch_exe)) {
return $larch_exe;
}
}
return $larch_exe;
};
# find and return the next unused larch port, given executable
# (only works on local host...)
# this will avoid multiple clients using the same port
sub get_next_larch_port {
# find next available port to run on
my ($larch_exe) = @_;
my $out = `$larch_exe -n`;
$out =~ s/[^\d.]/ /g ;
my @w = split /\s+/, $out;
return $w[-1];
};
our $proc;
sub start_larch_server {
$larch_port = -1;
$larch_exe = find_larch();
if (defined($larch_exe) and (length $larch_exe > 10)) {
# find next available port to run on
# print STDOUT "Larch exe $larch_exe\n";
$larch_port = get_next_larch_port($larch_exe);
# print STDOUT "Larch port $larch_port\n";
if ($larch_port > 2000) {
my $command = $larch_exe." -p ". $larch_port." start";
print STDOUT "\nStarting Larch server: $command\n" if $ENV{DEMETER_LARCH_VERBOSE};
if ($ENV{DEMETER_LARCH_VERBOSE}) {
$proc = system $command;
} else {
$proc = system(split(" ", $command), q{-q});
};
# verify connnection to server
my $addr = sprintf("http://%s:%d", 'localhost', $larch_port);
my $conn = RPC::XML::Client->new($addr);
usleep(250000);
for (my $i=0; $i<20; $i++) {
if ($conn->simple_request('system.listMethods')) {
my $m = $conn->simple_request('system.listMethods');
last;
}
usleep(250000);
}
}
} else {
print STDOUT "\nCould not find Larch Server" if $ENV{DEMETER_LARCH_VERBOSE};
}
return $larch_port;
};
sub create_larch_connection {
$larch_port = start_larch_server();
return $larch_port if ($larch_port < 0);
sleep(1);
my $addr = sprintf("http://127.0.0.1:%d", $larch_port);
$larchconn = RPC::XML::Client->new($addr);
$larchconn->send_request("larch", "cd('".cwd."')");
$larch_is_go = 1;
return $larchconn;
};
sub shutdown_larch_connection {
print "Request Server to shut down\n" if $ENV{DEMETER_LARCH_VERBOSE};
$larchconn->send_request("shutdown");
};
sub dispose {
my ($text) = @_;
return $larchconn->send_request("larch", $text);
};
sub larch {
my ($text) = @_;
return $larchconn->send_request("larch", $text);
};
sub decode_data {
my ($dat) = @_;
#my %dat;
# print("DECODE: ", ref($dat), "\n");
if (ref($dat) eq 'ARRAY') {
return @$dat;
} elsif (ref($dat) eq 'RPC::XML::nil') {
return undef;
} elsif (ref($dat) eq 'RPC::XML::string') {
return $$dat;
} elsif (ref($dat) eq 'RPC::XML::double') {
return $$dat;
} elsif (ref($dat) eq 'RPC::XML::struct') {
my $class = $dat->{__class__};
#print "STRUCT CLass " , $$class, "\n";
if ($$class eq "HASH") {
return %$dat;
} elsif ($$class eq "Array"){
my $value = $dat->{value};
my $dtype = $dat->{__dtype__}->value;
my $shape = @{$dat->{__shape__}->value};
return $value->value;
} elsif (($$class eq "List") or
($$class eq "Tuple") or
($$class eq "Complex")) {
my $value = $dat->{value};
# print "LIST/TUPLE ", $value, $value->value, "\n";
return $value->value;
} elsif (($$class eq "Dict") or
($$class eq "Group")) {
my %out;
foreach my $key (keys %$dat) {
if ($key ne '__class__') {
$out{$key} = decode_data($$dat{$key});
}
}
return \%out;
} else {
print "cannot decode data, unknown structure class: $$class \n";
}
} else {
return $dat; # print "cannot decode data, unknown data type: ref($dat) \n";
}
}
sub get_messages {
return decode_data($larchconn->send_request("get_messages"));
};
sub set_client_info {
my ($key, $val) = @_;
return $larchconn->send_request("set_client_info", $key, $val);
};
sub get_client_info {
my ($key, $val) = @_;
return $larchconn->send_request("get_client_info");
};
sub get_data {
my ($param) = @_;
return $larchconn->send_request("get_data", $param);
};
sub get_larch_scalar {
my ($param) = @_;
return decode_data(get_data($param));
};
sub put_larch_scalar {
my ($param, $value) = @_;
return dispose("$param = $value");
};
sub get_larch_array {
my ($param) = @_;
my $tmp = decode_data(get_data($param));
if (defined $tmp) {
return @{$tmp} if ref($tmp) eq 'ARRAY';
return %{$tmp} if ref($tmp) eq 'HASH';
};
return ();
};
sub put_larch_array {
my ($param, $aref) = @_;
return q{} if ($#{$aref} < 1);
my $value = '[' . join(',', @$aref) . ']';
return dispose("$param = array($value, dtype=float64)");
};
sub run_selftest {
my $max_outerloop = 20;
my $max_innerloop = 20;
my @messages;
my @array;
my $ret;
for (my $loop=0; $loop<$max_outerloop; $loop++) {
print "# Simple Array Creation: loop: $loop / $max_outerloop \n";
for (my $i=0; $i<$max_innerloop; $i++) {
dispose("x$i = linspace(0, $i+1, 11)");
select(undef, undef, undef, 0.0005);
if ($i % 5 == 0) {
dispose("print 'hello $i ".localtime."' ");
@messages = get_messages();
print "Message # ", @messages;
}
}
print "# Read XAFS Data, run autobk with different inputs\n";
for (my $i=0; $i<$max_innerloop; $i++) {
print "--> LOOP ($loop, $i) / ($max_outerloop, $max_innerloop)\n";
my $rbkg = 0.5 + $i/(1.0*$max_innerloop);
dispose("fc$i = read_ascii('fe3c_rt.xdi')");
dispose("fc$i.mu = fc$i.mutrans");
dispose("autobk(fc$i, rbkg=$rbkg)");
@array = get_larch_array("fc$i.array_labels");
print "Array Labels: ", join(', ', @array), "\n";
@array = get_larch_array("fc$i.chi[:5]");
print "Chi(k): ", join(', ', @array), "\n";
dispose("show(fc$i)");
#dispose("show(fc$i.autobk_details)");
@messages = get_messages();
print "Messages:\n ", @messages, "\n";
}
}
};
## if there is not already a connection,
## start server on next port create connection to it
if (!$larchconn) {
create_larch_connection();
}
END {
#my $action = ($ENV{DEMETER_LARCH_PERSIST}) ? 'status' : 'stop';
my $quiet = ($ENV{DEMETER_LARCH_VERBOSE}) ? q{} : q{-q};
system "$larch_exe $quiet -p $larch_port stop";
}
$larch_is_go;
__END__
=head1 NAME
Larch - Perl interface to Larch
=head1 SYNOPSIS
=head1 DESCRIPTION
This provides a perl interface to accessing data structures in Larch
and sending command strings to Larch via an XML-RPC framework.
=over 4
=item C<dispose>
Send a text string to the server for interpretation by Larch.
=item C<shutdown_server>
stop the Larch Server.
=item C<get_larch_scalar>
Fetch the value of a Larch scalar given a symbol. This can be a
number or a string. Care is taken not return 0 rather than a null
value.
=item C<put_larch_scalar>
Push a scalar to Larch given a symbol name.
=item C<get_larch_array>
Fetch the value of a Larch list given a symbol. In fact, this can
fetch any kind of collection, including a numpy array.
=item C<put_larch_array>
Push a list to Larch given a symbol name.
=back
=head1 CONFIGURATION
See the file F<lib/Demeter/share/ini/larch_server.ini>. The URL and
port used by the server can be configured, as can the length of the
timeout and the on-screen verbosity of the server.
=head1 ENVIRONMENT VARIABLES
=over 4
=item C<DEMETER_LARCH_VERBOSE>
When non-zero, print messages to STDOUT.
=back
=head1 AUTHOR
Bruce Ravel (L<http://bruceravel.github.io/home>)
L<http://bruceravel.github.io/demeter/>
Larch is copyright (c) 2019, Matthew Newville and Tom Trainor
=head1 SEE ALSO
L<Demeter::Get>, L<Ifeffit>
=cut