-
Notifications
You must be signed in to change notification settings - Fork 1
/
bspace.html
545 lines (544 loc) · 27.4 KB
/
bspace.html
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
<!DOCTYPE html>
<title>NetLogo 6.4.0 User Manual: BehaviorSpace Extension</title>
<link rel="stylesheet" href="../../netlogo-gui/docs/netlogo.css" type="text/css">
<style type="text/css">
p { margin-left: 1.5em ; }
h3 { font-size: 115% ; }
h4 { font-size: 100% ; margin-left: 1.5em ; background: white ; }
</style>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<h1 id="behaviorspace-extension-for-netlogo">BehaviorSpace Extension for
NetLogo</h1>
<p>The BehaviorSpace extension allows you to create and run
BehaviorSpace experiments from NetLogo code. You can use the extension
alone or in combination with the GUI BehaviorSpace tool, and you can run
experiments created in the GUI tool with the extension.</p>
<h2 id="using-the-behaviorspace-extension">Using the BehaviorSpace
Extension</h2>
<p>To use the BehaviorSpace extension in a model, include the following
line at the top of your code:</p>
<pre><code>extensions [bspace]</code></pre>
<p>If you are already using another extension, you can just add
<code>bspace</code> to the list inside the square brackets.</p>
<p>Once the extension is loaded, you can use it to run experiments from
anywhere in the code. Note that experiments created in the code will
persist for the duration of the current NetLogo session if not cleared
with the <code>bspace:clear-experiments</code> command (see <a
href="#bspaceclear-experiments"><code>bspace:clear-experiments</code></a>).</p>
<h2 id="primitives">Primitives</h2>
<h3 id="experiment-management">Experiment Management</h3>
<p><a
href="#bspacecreate-experiment"><code>bspace:create-experiment</code></a>
<a
href="#bspacedelete-experiment"><code>bspace:delete-experiment</code></a>
<a href="#bspacerun-experiment"><code>bspace:run-experiment</code></a>
<a
href="#bspacerename-experiment"><code>bspace:rename-experiment</code></a>
<a
href="#bspaceduplicate-experiment"><code>bspace:duplicate-experiment</code></a>
<a
href="#bspaceimport-experiments"><code>bspace:import-experiments</code></a>
<a
href="#bspaceexport-experiment"><code>bspace:export-experiment</code></a>
<a
href="#bspaceclear-experiments"><code>bspace:clear-experiments</code></a>
<a
href="#bspaceset-current-experiment"><code>bspace:set-current-experiment</code></a>
<a href="#bspaceget-experiments"><code>bspace:get-experiments</code></a>
<a
href="#bspaceget-current-experiment"><code>bspace:get-current-experiment</code></a>
<a href="#bspaceget-parameters"><code>bspace:get-parameters</code></a>
<a
href="#bspaceexperiment-exists"><code>bspace:experiment-exists</code></a>
<a
href="#bspacevalid-experiment-name"><code>bspace:valid-experiment-name</code></a></p>
<h3 id="setting-experiment-parameters">Setting Experiment
Parameters</h3>
<p><a href="#bspaceset-variables"><code>bspace:set-variables</code></a>
<a href="#bspaceset-repetitions"><code>bspace:set-repetitions</code></a>
<a
href="#bspaceset-sequential-run-order"><code>bspace:set-sequential-run-order</code></a>
<a href="#bspaceset-metrics"><code>bspace:set-metrics</code></a> <a
href="#bspaceset-run-metrics-every-step"><code>bspace:set-run-metrics-every-step</code></a>
<a
href="#bspaceset-run-metrics-condition"><code>bspace:set-run-metrics-condition</code></a>
<a
href="#bspaceset-pre-experiment-commands"><code>bspace:set-pre-experiment-commands</code></a>
<a
href="#bspaceset-setup-commands"><code>bspace:set-setup-commands</code></a>
<a href="#bspaceset-go-commands"><code>bspace:set-go-commands</code></a>
<a
href="#bspaceset-stop-condition"><code>bspace:set-stop-condition</code></a>
<a
href="#bspaceset-post-run-commands"><code>bspace:set-post-run-commands</code></a>
<a
href="#bspaceset-post-experiment-commands"><code>bspace:set-post-experiment-commands</code></a>
<a
href="#bspaceset-time-limit"><code>bspace:set-time-limit</code></a></p>
<h3 id="getting-experiment-parameters">Getting Experiment
Parameters</h3>
<p><a href="#bspaceget-variables"><code>bspace:get-variables</code></a>
<a href="#bspaceget-repetitions"><code>bspace:get-repetitions</code></a>
<a
href="#bspaceget-sequential-run-order"><code>bspace:get-sequential-run-order</code></a>
<a href="#bspaceget-metrics"><code>bspace:get-metrics</code></a> <a
href="#bspaceget-run-metrics-every-step"><code>bspace:get-run-metrics-every-step</code></a>
<a
href="#bspaceget-run-metrics-condition"><code>bspace:get-run-metrics-condition</code></a>
<a
href="#bspaceget-pre-experiment-commands"><code>bspace:get-pre-experiment-commands</code></a>
<a
href="#bspaceget-setup-commands"><code>bspace:get-setup-commands</code></a>
<a href="#bspaceget-go-commands"><code>bspace:get-go-commands</code></a>
<a
href="#bspaceget-stop-condition"><code>bspace:get-stop-condition</code></a>
<a
href="#bspaceget-post-run-commands"><code>bspace:get-post-run-commands</code></a>
<a
href="#bspaceget-post-experiment-commands"><code>bspace:get-post-experiment-commands</code></a>
<a
href="#bspaceget-time-limit"><code>bspace:get-time-limit</code></a></p>
<h3 id="setting-experiment-run-conditions">Setting Experiment Run
Conditions</h3>
<p><a
href="#bspaceset-spreadsheet"><code>bspace:set-spreadsheet</code></a> <a
href="#bspaceset-table"><code>bspace:set-table</code></a> <a
href="#bspaceset-stats"><code>bspace:set-stats</code></a> <a
href="#bspaceset-list"><code>bspace:set-lists</code></a> <a
href="#bspaceset-update-view"><code>bspace:set-update-view</code></a> <a
href="#bspaceset-update-plots"><code>bspace:set-update-plots</code></a>
<a
href="#bspaceset-parallel-runs"><code>bspace:set-parallel-runs</code></a></p>
<h3 id="getting-experiment-run-conditions">Getting Experiment Run
Conditions</h3>
<p><a
href="#bspaceget-spreadsheet"><code>bspace:get-spreadsheet</code></a> <a
href="#bspaceget-table"><code>bspace:get-table</code></a> <a
href="#bspaceget-stats"><code>bspace:get-stats</code></a> <a
href="#bspaceget-list"><code>bspace:get-lists</code></a> <a
href="#bspaceget-update-view"><code>bspace:get-update-view</code></a> <a
href="#bspaceget-update-plots"><code>bspace:get-update-plots</code></a>
<a
href="#bspaceget-parallel-runs"><code>bspace:get-parallel-runs</code></a></p>
<h3 id="processing-behaviorspace-output">Processing BehaviorSpace
Output</h3>
<p><a
href="#bspaceget-output-metric"><code>bspace:get-output-metric</code></a></p>
<h3 id="experiment-information">Experiment Information</h3>
<p><a
href="#bspacegoto-behaviorspace-documentation"><code>bspace:goto-behaviorspace-documentation</code></a>
<a
href="#bspacegoto-bspace-extension-documentation"><code>bspace:goto-bspace-extension-documentation</code></a>
<a
href="#bspaceget-default-parallel-runs"><code>bspace:get-default-parallel-runs</code></a>
<a
href="#bspaceget-recommended-max-parallel-runs"><code>bspace:get-recommended-max-parallel-runs</code></a></p>
<h3 id="bspacecreate-experiment">bspace:create-experiment</h3>
<h4 id="bspacecreate-experiment-string-boolean">bspace:create-experiment
<em>string</em> <em>boolean</em></h4>
<p>Create a new experiment specified in the first input. If an
experiment already exists with that name and the second input is true,
that experiment will be overwritten with the default experiment. If an
experiment already exists with that name and the second input is false,
an error will be thrown.</p>
<p>Example:</p>
<pre><code>bspace:create-experiment "my-experiment" true</code></pre>
<h3 id="bspacedelete-experiment">bspace:delete-experiment</h3>
<h4 id="bspacedelete-experiment-string">bspace:delete-experiment
<em>string</em></h4>
<p>Delete the experiment specified in the first input. An error will be
thrown if the specified experiment does not exist.</p>
<p>Example:</p>
<pre><code>bspace:delete-experiment "my-experiment"</code></pre>
<h3 id="bspacerun-experiment">bspace:run-experiment</h3>
<h4 id="bspacerun-experiment-1">bspace:run-experiment</h4>
<p>Run the current working experiment. An error will be thrown if no
current working experiment has been set.</p>
<p>Example:</p>
<pre><code>bspace:run-experiment</code></pre>
<h3 id="bspacerename-experiment">bspace:rename-experiment</h3>
<h4 id="bspacerename-experiment-string">bspace:rename-experiment
<em>string</em></h4>
<p>Rename the current working experiment to the name specified in the
first input. An error will be thrown if no current working experiment
has been set.</p>
<p>Example:</p>
<pre><code>bspace:rename-experiment "another-experiment"</code></pre>
<h3 id="bspaceduplicate-experiment">bspace:duplicate-experiment</h3>
<h4 id="bspaceduplicate-experiment-string">bspace:duplicate-experiment
<em>string</em></h4>
<p>Make a copy of the current working experiment and rename the copy to
the name specified in the first input, then set the current working
experiment to the new experiment. An error will be thrown if no current
working experiment has been set.</p>
<p>Example:</p>
<pre><code>bspace:duplicate-experiment "my-experiment-copy"</code></pre>
<h3 id="bspaceimport-experiments">bspace:import-experiments</h3>
<h4 id="bspaceimport-experiments-string">bspace:import-experiments
<em>string</em></h4>
<p>Import the experiments contained in the file at the specified
location. An error will be thrown for each experiment that has a name
that already exists, but the remaining experiments will be succesfully
imported.</p>
<p>Example:</p>
<pre><code>bspace:import-experiments "/Users/johndoe/Documents/experiments.xml"</code></pre>
<h3 id="bspaceexport-experiment">bspace:export-experiment</h3>
<h4 id="bspaceexport-experiment-string-boolean">bspace:export-experiment
<em>string</em> <em>boolean</em></h4>
<p>Export the current working experiment to the file specified in the
second input. If that file already exists and the second input is true,
it will be overwritten with the specified experiment. If that file
already exists and the second input is false, an error will be
thrown.</p>
<p>Example:</p>
<pre><code>bspace:export-experiment "/Users/johndoe/Documents/my-experiment.xml"</code></pre>
<h3 id="bspaceclear-experiments">bspace:clear-experiments</h3>
<h4 id="bspaceclear-experiments-1">bspace:clear-experiments</h4>
<p>Clear the list of stored experiments that have been created in the
code, and reset all experiments that have been paused after running from
the code.</p>
<p>Example:</p>
<pre><code>bspace:clear-experiments</code></pre>
<h3 id="bspaceset-current-experiment">bspace:set-current-experiment</h3>
<h4 id="bspaceset-current-experient-string">bspace:set-current-experient
<em>string</em></h4>
<p>Set the current working experiment to the name specified in the first
input.</p>
<p>Example:</p>
<pre><code>bspace:set-current-experiment "my-experiment"</code></pre>
<h3 id="bspaceget-experiments">bspace:get-experiments</h3>
<h4 id="bspaceget-experiments-1">bspace:get-experiments</h4>
<p>Report a description of the current experiments, indicating whether
each was created in the GUI or the code.</p>
<h3 id="bspaceget-current-experiment">bspace:get-current-experiment</h3>
<h4
id="bspaceget-current-experiment-1">bspace:get-current-experiment</h4>
<p>Report the name of the current working experiment.</p>
<h3 id="bspaceget-parameters">bspace:get-parameters</h3>
<h4 id="bspaceget-parameters-string">bspace:get-parameters
<em>string</em></h4>
<p>Report the parameter values for the experiment with the name
specified in the first input. An error will be thrown if no experiment
exists with the specified name.</p>
<p>Example:</p>
<pre><code>bspace:get-parameters "my-experiment"</code></pre>
<h3 id="bspaceexperiment-exists">bspace:experiment-exists</h3>
<h4 id="bspaceexperiment-exists-string">bspace:experiment-exists
<em>string</em></h4>
<p>Report whether an experiment exists with the name specified in the
first input.</p>
<p>Example:</p>
<pre><code>bspace:experiment-exists "my-experiment"</code></pre>
<h3 id="bspacevalid-experiment-name">bspace:valid-experiment-name</h3>
<h4 id="bspacevalid-experiment-name-string">bspace:valid-experiment-name
<em>string</em></h4>
<p>Report whether the specified name is a valid experiment name.</p>
<p>Example:</p>
<pre><code>bspace:valid-experiment-name "" ; false
bspace:valid-experiment-name "my-experiment" ; true
bspace:create-experiment "my-experiment" true
bspace:valid-experiment-name "my-experiment" false</code></pre>
<h3 id="bspaceset-variables">bspace:set-variables</h3>
<h4 id="bspaceset-variables-string">bspace:set-variables
<em>string</em></h4>
<p>Set the variables to vary for the current working experiment. An
error will be thrown if no current working experiment has been set.</p>
<p>Example:</p>
<pre><code>bspace:set-variables "[ 'var1' 0 5 20 ]"</code></pre>
<h3 id="bspaceset-repetitions">bspace:set-repetitions</h3>
<h4 id="bspaceset-repetitions-number">bspace:set-repetitions
<em>number</em></h4>
<p>Set the repetitions for the current working experiment. An error will
be thrown if no current working experiment has been set.</p>
<p>Example:</p>
<pre><code>bspace:set-repetitions 3</code></pre>
<h3
id="bspaceset-sequential-run-order">bspace:set-sequential-run-order</h3>
<h4
id="bspaceset-sequential-run-order-boolean">bspace:set-sequential-run-order
<em>boolean</em></h4>
<p>Set whether the current working experiment uses sequential run order.
An error will be thrown if no current working experiment has been
set.</p>
<p>Example:</p>
<pre><code>bspace:set-sequential-run-order true</code></pre>
<h3 id="bspaceset-metrics">bspace:set-metrics</h3>
<h4 id="bspaceset-metrics-list">bspace:set-metrics <em>list</em></h4>
<p>Set the metrics commands for the current working experiment. An error
will be thrown if no current working experiment has been set. The first
input must be a list of string commands.</p>
<p>Example:</p>
<pre><code>bspace:set-metrics [ "count turtles", "count patches" ]</code></pre>
<h3
id="bspaceset-run-metrics-every-step">bspace:set-run-metrics-every-step</h3>
<h4
id="bspaceset-run-metrics-every-step-boolean">bspace:set-run-metrics-every-step
<em>boolean</em></h4>
<p>Set whether the current working experiment runs metrics every step.
An error will be thrown if no current working experiment has been
set.</p>
<p>Example:</p>
<pre><code>bspace:set-run-metrics-every-step false</code></pre>
<h3
id="bspaceset-run-metrics-condition">bspace:set-run-metrics-condition</h3>
<h4
id="bspaceset-run-metrics-condition-reporter-block">bspace:set-run-metrics-condition
<em>reporter block</em></h4>
<p>Set the run metrics condition for the current working experiment. An
error will be thrown if no current working experiment has been set.</p>
<p>Example:</p>
<pre><code>bspace:set-run-metrics-condition [ count turtles < 5 ]</code></pre>
<h3
id="bspaceset-pre-experiment-commands">bspace:set-pre-experiment-commands</h3>
<h4
id="bspaceset-pre-experiment-commands-command-block">bspace:set-pre-experiment-commands
<em>command block</em></h4>
<p>Set the pre-experiment commands for the current working experiment.
An error will be thrown if no current working experiment has been
set.</p>
<p>Example:</p>
<pre><code>bspace:set-pre-experiment-commands [ clear-all ]</code></pre>
<h3 id="bspaceset-setup-commands">bspace:set-setup-commands</h3>
<h4
id="bspaceset-setup-commands-command-block">bspace:set-setup-commands
<em>command block</em></h4>
<p>Set the setup commands for the current working experiment. An error
will be thrown if no current working experiment has been set.</p>
<p>Example:</p>
<pre><code>bspace:set-setup-commands [ clear-all create-turtles 50 ]</code></pre>
<h3 id="bspaceset-go-commands">bspace:set-go-commands</h3>
<h4 id="bspaceset-go-commands-command-block">bspace:set-go-commands
<em>command block</em></h4>
<p>Set the go commands for the current working experiment. An error will
be thrown if no current working experiment has been set.</p>
<p>Example:</p>
<pre><code>bspace:set-go-commands [ myFunction ]</code></pre>
<h3 id="bspaceset-stop-condition">bspace:set-stop-condition</h3>
<h4
id="bspaceset-stop-condition-reporter-block">bspace:set-stop-condition
<em>reporter block</em></h4>
<p>Set the stop condition for the current working experiment. An error
will be thrown if no current working experiment has been set.</p>
<p>Example:</p>
<pre><code>bspace:set-stop-condition [ ticks > 1000 ]</code></pre>
<h3 id="bspaceset-post-run-commands">bspace:set-post-run-commands</h3>
<h4
id="bspaceset-post-run-commands-command-block">bspace:set-post-run-commands
<em>command block</em></h4>
<p>Set the post-run commands for the current working experiment. An
error will be thrown if no current working experiment has been set.</p>
<p>Example:</p>
<pre><code>bspace:set-post-run-commands [ print count turtles ]</code></pre>
<h3
id="bspaceset-post-experiment-commands">bspace:set-post-experiment-commands</h3>
<h4
id="bspaceset-post-experiment-commands-command-block">bspace:set-post-experiment-commands
<em>command block</em></h4>
<p>Set the post-experiment commands for the current working experiment.
An error will be thrown if no current working experiment has been
set.</p>
<p>Example:</p>
<pre><code>bspace:set-post-experiment-commands [ ask turtles [ setxy 0 0 ] ]</code></pre>
<h3 id="bspaceset-time-limit">bspace:set-time-limit</h3>
<h4 id="bspaceset-time-limit-number">bspace:set-time-limit
<em>number</em></h4>
<p>Set the time limit in ticks for the current working experiment. An
error will be thrown if no current working experiment has been set.</p>
<p>Example:</p>
<pre><code>bspace:set-time-limit 1500</code></pre>
<h3 id="bspaceget-variables">bspace:get-variables</h3>
<h4 id="bspaceget-variables-1">bspace:get-variables</h4>
<p>Report the variables for the current working experiment. An error
will be thrown if no current working experiment has been set.</p>
<h3 id="bspaceget-repetitions">bspace:get-repetitions</h3>
<h4 id="bspaceget-repetitions-1">bspace:get-repetitions</h4>
<p>Report the repetitions for the current working experiment. An error
will be thrown if no current working experiment has been set.</p>
<h3
id="bspaceget-sequential-run-order">bspace:get-sequential-run-order</h3>
<h4
id="bspaceget-sequential-run-order-1">bspace:get-sequential-run-order</h4>
<p>Report whether the current working experiment uses sequential run
order. An error will be thrown if no current working experiment has been
set.</p>
<h3 id="bspaceget-metrics">bspace:get-metrics</h3>
<h4 id="bspaceget-metrics-1">bspace:get-metrics</h4>
<p>Report the metrics for the current working experiment. An error will
be thrown if no current working experiment has been set.</p>
<h3
id="bspaceget-run-metrics-every-step">bspace:get-run-metrics-every-step</h3>
<h4
id="bspaceget-run-metrics-every-step-1">bspace:get-run-metrics-every-step</h4>
<p>Report whether the current working experiment runs metrics every
step. An error will be thrown if no current working experiment has been
set.</p>
<h3
id="bspaceget-run-metrics-condition">bspace:get-run-metrics-condition</h3>
<h4
id="bspaceget-run-metrics-condition-1">bspace:get-run-metrics-condition</h4>
<p>Report the run metrics condition for the current working experiment.
An error will be thrown if no current working experiment has been
set.</p>
<h3
id="bspaceget-pre-experiment-commands">bspace:get-pre-experiment-commands</h3>
<h4
id="bspaceget-pre-experiment-commands-1">bspace:get-pre-experiment-commands</h4>
<p>Report the pre-experiment commands for the current working
experiment. An error will be thrown if no current working experiment has
been set.</p>
<h3 id="bspaceget-setup-commands">bspace:get-setup-commands</h3>
<h4 id="bspaceget-setup-commands-1">bspace:get-setup-commands</h4>
<p>Report the setup commands for the current working experiment. An
error will be thrown if no current working experiment has been set.</p>
<h3 id="bspaceget-go-commands">bspace:get-go-commands</h3>
<h4 id="bspaceget-go-commands-1">bspace:get-go-commands</h4>
<p>Report the go commands for the current working experiment. An error
will be thrown if no current working experiment has been set.</p>
<h3 id="bspaceget-stop-condition">bspace:get-stop-condition</h3>
<h4 id="bspaceget-stop-condition-1">bspace:get-stop-condition</h4>
<p>Report the stop condition for the current working experiment. An
error will be thrown if no current working experiment has been set.</p>
<h3 id="bspaceget-post-run-commands">bspace:get-post-run-commands</h3>
<h4 id="bspaceget-post-run-commands-1">bspace:get-post-run-commands</h4>
<p>Report the post-run commands for the current working experiment. An
error will be thrown if no current working experiment has been set.</p>
<h3
id="bspaceget-post-experiment-commands">bspace:get-post-experiment-commands</h3>
<h4
id="bspaceget-post-experiment-commands-1">bspace:get-post-experiment-commands</h4>
<p>Report the post-experiment commands for the current working
experiment. An error will be thrown if no current working experiment has
been set.</p>
<h3 id="bspaceget-time-limit">bspace:get-time-limit</h3>
<h4 id="bspaceget-time-limit-1">bspace:get-time-limit</h4>
<p>Report the time limit for the current working experiment. An error
will be thrown if no current working experiment has been set.</p>
<h3 id="bspaceset-spreadsheet">bspace:set-spreadsheet</h3>
<h4 id="bspaceset-spreadsheet-string">bspace:set-spreadsheet
<em>string</em></h4>
<p>Set the path for the spreadsheet file for the current working
experiment. An error will be thrown if no current working experiment has
been set.</p>
<p>Example:</p>
<pre><code>bspace:set-spreadsheet "/Users/johndoe/Documents/exp-sheet.csv"</code></pre>
<h3 id="bspaceset-table">bspace:set-table</h3>
<h4 id="bspaceset-table-string">bspace:set-table <em>string</em></h4>
<p>Set the path for the table file for the current working experiment.
An error will be thrown if no current working experiment has been
set.</p>
<p>Example:</p>
<pre><code>bspace:set-table "/Users/johndoe/Documents/exp-table.csv"</code></pre>
<h3 id="bspaceset-stats">bspace:set-stats</h3>
<h4 id="bspaceset-stats-string">bspace:set-stats <em>string</em></h4>
<p>Set the path for the stats file for the current working experiment.
An error will be thrown if no current working experiment has been
set.</p>
<p>Example:</p>
<pre><code>bspace:set-stats "/Users/johndoe/Documents/exp-stats.csv"</code></pre>
<h3 id="bspaceset-lists">bspace:set-lists</h3>
<h4 id="bspaceset-lists-string">bspace:set-lists <em>string</em></h4>
<p>Set the path for the lists file for the current working experiment.
An error will be thrown if no current working experiment has been
set.</p>
<p>Example:</p>
<pre><code>bspace:set-lists "/Users/johndoe/Documents/exp-lists.csv"</code></pre>
<h3 id="bspaceset-update-view">bspace:set-update-view</h3>
<h4 id="bspaceset-update-view-boolean">bspace:set-update-view
<em>boolean</em></h4>
<p>Set whether the current working experiment should update the view. An
error will be thrown if no current working experiment has been set.</p>
<p>Example:</p>
<pre><code>bspace:set-update-view true</code></pre>
<h3 id="bspaceset-update-plots">bspace:set-update-plots</h3>
<h4 id="bspaceset-update-view-boolean-1">bspace:set-update-view
<em>boolean</em></h4>
<p>Set whether the current working experiment should update the plots.
An error will be thrown if no current working experiment has been
set.</p>
<p>Example:</p>
<pre><code>bspace:set-update-view false</code></pre>
<h3 id="bspaceset-parallel-runs">bspace:set-parallel-runs</h3>
<h4 id="bspaceset-parallel-runs-number">bspace:set-parallel-runs
<em>number</em></h4>
<p>Set the number of parallel runs for the current working experiment.
An error will be thrown if no current working experiment has been
set.</p>
<p>Example:</p>
<pre><code>bspace:set-parallel-runs 3</code></pre>
<h3 id="bspaceget-spreadsheet">bspace:get-spreadsheet</h3>
<h4 id="bspaceget-spreadsheet-1">bspace:get-spreadsheet</h4>
<p>Report the spreadsheet location for the current working experiment.
An error will be thrown if no current working experiment has been set.
Will report an empty string if no spreadsheet file was specified in the
current working experiment, or the string “-” if the output is directed
to standard output.</p>
<h3 id="bspaceget-table">bspace:get-table</h3>
<h4 id="bspaceget-table-1">bspace:get-table</h4>
<p>Report the table location for the current working experiment. An
error will be thrown if no current working experiment has been set. Will
report an empty string if no table file was specified in the current
working experiment, or the string “-” if the output is directed to
standard output.</p>
<h3 id="bspaceget-stats">bspace:get-stats</h3>
<h4 id="bspaceget-stats-1">bspace:get-stats</h4>
<p>Report the stats location for the current working experiment. An
error will be thrown if no current working experiment has been set. Will
report an empty string if no spreastatsdsheet file was specified in the
current working experiment, or the string “-” if the output is directed
to standard output.</p>
<h3 id="bspaceget-lists">bspace:get-lists</h3>
<h4 id="bspaceget-lists-1">bspace:get-lists</h4>
<p>Report the lists location for the current working experiment. An
error will be thrown if no current working experiment has been set. Will
report an empty string if no lists file was specified in the current
working experiment, or the string “-” if the output is directed to
standard output.</p>
<h3 id="bspaceget-update-view">bspace:get-update-view</h3>
<h4 id="bspaceget-update-view-1">bspace:get-update-view</h4>
<p>Report whether the current working experiment will update the view.
An error will be thrown if no current working experiment has been
set.</p>
<h3 id="bspaceget-update-plots">bspace:get-update-plots</h3>
<h4 id="bspaceget-update-plots-1">bspace:get-update-plots</h4>
<p>Report whether the current working experiment will update the plots.
An error will be thrown if no current working experiment has been
set.</p>
<h3 id="bspaceget-parallel-runs">bspace:get-parallel-runs</h3>
<h4 id="bspaceget-parallel-runs-1">bspace:get-parallel-runs</h4>
<p>Report the number of parallel runs for the current working
experiment. An error will be thrown if no current working experiment has
been set.</p>
<h3 id="bspaceget-output-metric">bspace:get-output-metric</h3>
<h4
id="bspaceget-output-metric-string-string-number">bspace:get-output-metric
<em>string</em> <em>string</em> <em>number</em></h4>
<p>Report the list of values for the metric specified in the second
input for the run number specified in the third input, from the file
specified in the first input. The specified file must be a spreadsheet
output to ensure proper ordering of values. An error will be thrown if
any of the inputs are invalid.</p>
<p>Example:</p>
<pre><code>bspace:get-output-metric "/Users/johndoe/Documents/spreadsheet.csv" "count turtles" 3</code></pre>
<h3
id="bspacegoto-behaviorspace-documentation">bspace:goto-behaviorspace-documentation</h3>
<h4
id="bspacegoto-behaviorspace-documentation-1">bspace:goto-behaviorspace-documentation</h4>
<p>Open the BehaviorSpace documentation page in a browser window.</p>
<h3
id="bspacegoto-bspace-extension-documentation">bspace:goto-bspace-extension-documentation</h3>
<h4
id="bspacegoto-bspace-extension-documentation-1">bspace:goto-bspace-extension-documentation</h4>
<p>Open the bspace extension documentation page in a browser window.</p>
<h3
id="bspaceget-default-parallel-runs">bspace:get-default-parallel-runs</h3>
<h4
id="bspaceget-default-parallel-runs-1">bspace:get-default-parallel-runs</h4>
<p>Report the default number of parallel runs for the current
device.</p>
<h3
id="bspaceget-recommended-max-parallel-runs">bspace:get-recommended-max-parallel-runs</h3>
<h4
id="bspaceget-recommended-max-parallel-runs-1">bspace:get-recommended-max-parallel-runs</h4>
<p>Report the recommended maximum number of parallel runs for the
current device.</p>