sierra-research 1.3.1__py3-none-any.whl → 1.3.6__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- sierra/core/config.py +1 -1
- sierra/core/graphs/stacked_line_graph.py +9 -6
- sierra/core/models/graphs.py +0 -1
- sierra/core/pipeline/stage2/exp_runner.py +4 -4
- sierra/core/pipeline/stage3/imagizer.py +2 -1
- sierra/core/pipeline/stage4/__init__.py +2 -0
- sierra/core/startup.py +1 -0
- sierra/core/utils.py +1 -1
- sierra/main.py +1 -1
- sierra/version.py +1 -1
- {sierra_research-1.3.1.data → sierra_research-1.3.6.data}/data/share/man/man1/sierra-cli.1 +134 -134
- {sierra_research-1.3.1.data → sierra_research-1.3.6.data}/data/share/man/man7/sierra-examples.7 +15 -15
- {sierra_research-1.3.1.data → sierra_research-1.3.6.data}/data/share/man/man7/sierra-exec-envs.7 +12 -12
- {sierra_research-1.3.1.data → sierra_research-1.3.6.data}/data/share/man/man7/sierra-glossary.7 +12 -12
- {sierra_research-1.3.1.data → sierra_research-1.3.6.data}/data/share/man/man7/sierra-platforms.7 +31 -31
- {sierra_research-1.3.1.data → sierra_research-1.3.6.data}/data/share/man/man7/sierra-usage.7 +56 -56
- {sierra_research-1.3.1.data → sierra_research-1.3.6.data}/data/share/man/man7/sierra.7 +5 -5
- {sierra_research-1.3.1.dist-info → sierra_research-1.3.6.dist-info}/METADATA +7 -6
- {sierra_research-1.3.1.dist-info → sierra_research-1.3.6.dist-info}/RECORD +23 -23
- {sierra_research-1.3.1.dist-info → sierra_research-1.3.6.dist-info}/WHEEL +1 -1
- {sierra_research-1.3.1.dist-info → sierra_research-1.3.6.dist-info}/LICENSE +0 -0
- {sierra_research-1.3.1.dist-info → sierra_research-1.3.6.dist-info}/entry_points.txt +0 -0
- {sierra_research-1.3.1.dist-info → sierra_research-1.3.6.dist-info}/top_level.txt +0 -0
@@ -1,8 +1,5 @@
|
|
1
1
|
.\" Man page generated from reStructuredText.
|
2
2
|
.
|
3
|
-
.TH "SIERRA-CLI" "1" "Jan 25, 2023" "1.3.1" "SIERRA"
|
4
|
-
.SH NAME
|
5
|
-
sierra-cli \- The SIERRA Command Line Interface (CLI).
|
6
3
|
.
|
7
4
|
.nr rst2man-indent-level 0
|
8
5
|
.
|
@@ -30,10 +27,13 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
30
27
|
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
31
28
|
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
32
29
|
..
|
30
|
+
.TH "SIERRA-CLI" "1" "Apr 01, 2024" "1.3.6" "SIERRA"
|
31
|
+
.SH NAME
|
32
|
+
sierra-cli \- The SIERRA Command Line Interface (CLI).
|
33
33
|
.sp
|
34
34
|
Unless an option says otherwise, it is applicable to all batch criteria. That
|
35
35
|
is, option batch criteria applicability is only documented for options which
|
36
|
-
apply to a subset of the available Batch Criteria\&.
|
36
|
+
apply to a subset of the available \fI\%Batch Criteria\fP\&.
|
37
37
|
.sp
|
38
38
|
If an option is given more than once, the last such occurrence is used.
|
39
39
|
.sp
|
@@ -46,7 +46,7 @@ See also \fBsierra\-examples\fP\&.
|
|
46
46
|
|
47
47
|
.SH SIERRA CORE
|
48
48
|
.sp
|
49
|
-
These options are for all Platforms\&.
|
49
|
+
These options are for all \fI\%Platforms\fP\&.
|
50
50
|
.SS Bootstrap+Multi\-stage Options
|
51
51
|
.INDENT 0.0
|
52
52
|
.INDENT 3.5
|
@@ -77,10 +77,10 @@ usage: sphinx\-build [\-h] [\-\-project PROJECT] [\-\-version]
|
|
77
77
|
Bare\-bones options for bootstrapping SIERRA
|
78
78
|
.INDENT 0.0
|
79
79
|
.TP
|
80
|
-
.B\-\-project
|
80
|
+
.B \-\-project
|
81
81
|
.INDENT 7.0
|
82
82
|
.INDENT 3.5
|
83
|
-
Specify which Project to load.
|
83
|
+
Specify which \fI\%Project\fP to load.
|
84
84
|
.UNINDENT
|
85
85
|
.UNINDENT
|
86
86
|
.sp
|
@@ -91,7 +91,7 @@ Used by stage {1,2,3,4,5}; can be omitted otherwise. If omitted: N/A.
|
|
91
91
|
.UNINDENT
|
92
92
|
.UNINDENT
|
93
93
|
.TP
|
94
|
-
.B\-\-version, \-v
|
94
|
+
.B \-\-version, \-v
|
95
95
|
.INDENT 7.0
|
96
96
|
.INDENT 3.5
|
97
97
|
Display SIERRA version information on stdout and
|
@@ -101,7 +101,7 @@ then exit.
|
|
101
101
|
.sp
|
102
102
|
Default: False
|
103
103
|
.TP
|
104
|
-
.B\-\-log\-level
|
104
|
+
.B \-\-log\-level
|
105
105
|
Possible choices: ERROR, INFO, WARNING, DEBUG, TRACE
|
106
106
|
.INDENT 7.0
|
107
107
|
.INDENT 3.5
|
@@ -117,12 +117,12 @@ Used by stage {1,2,3,4,5}; can be omitted otherwise. If omitted: N/A.
|
|
117
117
|
.UNINDENT
|
118
118
|
.UNINDENT
|
119
119
|
.sp
|
120
|
-
Default:
|
120
|
+
Default: \(dqINFO\(dq
|
121
121
|
.TP
|
122
|
-
.B\-\-platform
|
122
|
+
.B \-\-platform
|
123
123
|
.INDENT 7.0
|
124
124
|
.INDENT 3.5
|
125
|
-
This argument defines the Platform you
|
125
|
+
This argument defines the \fI\%Platform\fP you
|
126
126
|
want to run experiments on.
|
127
127
|
.sp
|
128
128
|
The value of this argument determines the
|
@@ -131,30 +131,30 @@ platforms (e.g., simulator, real robots) will
|
|
131
131
|
have different configuration options.
|
132
132
|
.sp
|
133
133
|
Valid values can be any folder name inside a
|
134
|
-
folder on the \
|
134
|
+
folder on the \fI\%SIERRA_PLUGIN_PATH\fP (with
|
135
135
|
\fB/\fP replaced with \fB\&.\fP as you would expect for
|
136
136
|
using path names to address python packages). The
|
137
137
|
platforms which come with SIERRA are:
|
138
138
|
.INDENT 0.0
|
139
139
|
.IP \(bu 2
|
140
140
|
\fBplatform.argos\fP \- This directs SIERRA to run
|
141
|
-
experiments using the ARGoS
|
141
|
+
experiments using the \fI\%ARGoS\fP
|
142
142
|
simulator. Selecting this platform assumes your
|
143
143
|
code has been developed and configured for
|
144
144
|
ARGoS.
|
145
145
|
.IP \(bu 2
|
146
146
|
\fBplatform.ros1gazebo\fP \- This directs SIERRA to
|
147
|
-
run experiments using the Gazebo
|
148
|
-
simulator and ROS1\&. Selecting this
|
147
|
+
run experiments using the \fI\%Gazebo\fP
|
148
|
+
simulator and \fI\%ROS1\fP\&. Selecting this
|
149
149
|
platform assumes your code has been developed
|
150
150
|
and configured for Gazebo and ROS1.
|
151
151
|
.UNINDENT
|
152
152
|
.UNINDENT
|
153
153
|
.UNINDENT
|
154
154
|
.sp
|
155
|
-
Default:
|
155
|
+
Default: \(dqplatform.argos\(dq
|
156
156
|
.TP
|
157
|
-
.B\-\-skip\-pkg\-checks
|
157
|
+
.B \-\-skip\-pkg\-checks
|
158
158
|
.INDENT 7.0
|
159
159
|
.INDENT 3.5
|
160
160
|
Skip the usual startup package checks. Only do
|
@@ -166,7 +166,7 @@ don\(aqt have installed/can\(aqt install.
|
|
166
166
|
.sp
|
167
167
|
Default: False
|
168
168
|
.TP
|
169
|
-
.B\-\-exec\-env
|
169
|
+
.B \-\-exec\-env
|
170
170
|
.INDENT 7.0
|
171
171
|
.INDENT 3.5
|
172
172
|
This argument defines \fIhow\fP experiments are going
|
@@ -174,7 +174,7 @@ to be run, using the \fB\-\-platform\fP you have
|
|
174
174
|
selected.
|
175
175
|
.sp
|
176
176
|
Valid values can be any folder name inside a
|
177
|
-
folder on the \
|
177
|
+
folder on the \fI\%SIERRA_PLUGIN_PATH\fP (with
|
178
178
|
\fB/\fP replaced with \fB\&.\fP as you would expect for
|
179
179
|
using path names to address python packages). The
|
180
180
|
execution environments which come with SIERRA
|
@@ -183,26 +183,26 @@ are:
|
|
183
183
|
.IP \(bu 2
|
184
184
|
\fBhpc.local\fP \- This directs SIERRA to run
|
185
185
|
experiments on the local machine. See
|
186
|
-
|
186
|
+
\fI\%Local HPC Plugin\fP for a detailed
|
187
187
|
description.
|
188
188
|
.IP \(bu 2
|
189
189
|
\fBhpc.pbs\fP \- The directs SIERRA to run
|
190
190
|
experiments spread across multiple allocated
|
191
191
|
nodes in an HPC computing environment managed
|
192
|
-
by TORQUE\-PBS. See
|
192
|
+
by TORQUE\-PBS. See \fI\%PBS HPC Plugin\fP
|
193
193
|
for a detailed description.
|
194
194
|
.IP \(bu 2
|
195
195
|
\fBhpc.slurm\fP \- The directs SIERRA to run
|
196
196
|
experiments spread across multiple allocated
|
197
197
|
nodes in an HPC computing environment managed
|
198
198
|
by SLURM. See
|
199
|
-
|
199
|
+
\fI\%SLURM HPC Plugin\fP for a
|
200
200
|
detailed description.
|
201
201
|
.IP \(bu 2
|
202
202
|
\fBhpc.adhoc\fP \- This will direct SIERRA to run
|
203
203
|
experiments on an ad\-hoc network of
|
204
204
|
computers. See
|
205
|
-
|
205
|
+
\fI\%Adhoc HPC Plugin\fP for a
|
206
206
|
detailed description.
|
207
207
|
.IP \(bu 2
|
208
208
|
\fBrobot.turtlebot3\fP \- This will direct SIERRA
|
@@ -221,14 +221,14 @@ Used by stage {1,2}; can be omitted otherwise. If omitted: N/A.
|
|
221
221
|
.UNINDENT
|
222
222
|
.UNINDENT
|
223
223
|
.sp
|
224
|
-
Default:
|
224
|
+
Default: \(dqhpc.local\(dq
|
225
225
|
.UNINDENT
|
226
226
|
.SS Multi\-stage options
|
227
227
|
.sp
|
228
228
|
Options which are used in multiple pipeline stages
|
229
229
|
.INDENT 0.0
|
230
230
|
.TP
|
231
|
-
.B\-\-template\-input\-file
|
231
|
+
.B \-\-template\-input\-file
|
232
232
|
.INDENT 7.0
|
233
233
|
.INDENT 3.5
|
234
234
|
The template \fB\&.xml\fP input file for the
|
@@ -248,7 +248,7 @@ Used by stage {1,2,3,4}; can be omitted otherwise. If omitted: N/A.
|
|
248
248
|
.UNINDENT
|
249
249
|
.UNINDENT
|
250
250
|
.TP
|
251
|
-
.B\-\-exp\-overwrite
|
251
|
+
.B \-\-exp\-overwrite
|
252
252
|
.INDENT 7.0
|
253
253
|
.INDENT 3.5
|
254
254
|
When SIERRA calculates the batch experiment
|
@@ -274,7 +274,7 @@ Used by stage {1,2}; can be omitted otherwise. If omitted: N/A.
|
|
274
274
|
.sp
|
275
275
|
Default: False
|
276
276
|
.TP
|
277
|
-
.B\-\-sierra\-root
|
277
|
+
.B \-\-sierra\-root
|
278
278
|
.INDENT 7.0
|
279
279
|
.INDENT 3.5
|
280
280
|
Root directory for all SIERRA generated and
|
@@ -295,9 +295,9 @@ Used by stage {1,2,3,4,5}; can be omitted otherwise. If omitted: N/A.
|
|
295
295
|
.UNINDENT
|
296
296
|
.UNINDENT
|
297
297
|
.sp
|
298
|
-
Default:
|
298
|
+
Default: \(dq<home directory>/exp\(dq
|
299
299
|
.TP
|
300
|
-
.B\-\-batch\-criteria
|
300
|
+
.B \-\-batch\-criteria
|
301
301
|
.INDENT 7.0
|
302
302
|
.INDENT 3.5
|
303
303
|
Definition of criteria(s) to use to define
|
@@ -328,7 +328,7 @@ Used by stage {1,2,3,4,5}; can be omitted otherwise. If omitted: N/A.
|
|
328
328
|
.sp
|
329
329
|
Default: []
|
330
330
|
.TP
|
331
|
-
.B\-\-pipeline
|
331
|
+
.B \-\-pipeline
|
332
332
|
.INDENT 7.0
|
333
333
|
.INDENT 3.5
|
334
334
|
Define which stages of the experimental
|
@@ -365,7 +365,7 @@ run. Not part of default pipeline.
|
|
365
365
|
.sp
|
366
366
|
Default: [1, 2, 3, 4]
|
367
367
|
.TP
|
368
|
-
.B\-\-exp\-range
|
368
|
+
.B \-\-exp\-range
|
369
369
|
.INDENT 7.0
|
370
370
|
.INDENT 3.5
|
371
371
|
Set the experiment numbers from the batch to
|
@@ -395,7 +395,7 @@ Used by stage {2,3,4}; can be omitted otherwise. If omitted: N/A.
|
|
395
395
|
.UNINDENT
|
396
396
|
.UNINDENT
|
397
397
|
.TP
|
398
|
-
.B\-\-platform\-vc
|
398
|
+
.B \-\-platform\-vc
|
399
399
|
.INDENT 7.0
|
400
400
|
.INDENT 3.5
|
401
401
|
For applicable \fB\-\-platforms\fP, enable
|
@@ -408,7 +408,7 @@ frames into videos during stage 4. If the
|
|
408
408
|
selected \fB\-\-platform\fP does not support
|
409
409
|
visual capture, then this option has no
|
410
410
|
effect. See
|
411
|
-
|
411
|
+
\fI\%Platform Visual Capture\fP
|
412
412
|
for full details.
|
413
413
|
.UNINDENT
|
414
414
|
.UNINDENT
|
@@ -422,7 +422,7 @@ Used by stage {1,4}; can be omitted otherwise. If omitted: N/A.
|
|
422
422
|
.sp
|
423
423
|
Default: False
|
424
424
|
.TP
|
425
|
-
.B\-\-processing\-serial
|
425
|
+
.B \-\-processing\-serial
|
426
426
|
.INDENT 7.0
|
427
427
|
.INDENT 3.5
|
428
428
|
If TRUE, then results processing/graph
|
@@ -441,7 +441,7 @@ Used by stage {3,4}; can be omitted otherwise. If omitted: N/A.
|
|
441
441
|
.sp
|
442
442
|
Default: False
|
443
443
|
.TP
|
444
|
-
.B\-\-n\-runs
|
444
|
+
.B \-\-n\-runs
|
445
445
|
.INDENT 7.0
|
446
446
|
.INDENT 3.5
|
447
447
|
The # of experimental runs that will be
|
@@ -464,7 +464,7 @@ Used by stage {1,2}; can be omitted otherwise. If omitted: N/A.
|
|
464
464
|
.UNINDENT
|
465
465
|
.UNINDENT
|
466
466
|
.TP
|
467
|
-
.B\-\-skip\-collate
|
467
|
+
.B \-\-skip\-collate
|
468
468
|
.INDENT 7.0
|
469
469
|
.INDENT 3.5
|
470
470
|
Specify that no collation of data across
|
@@ -487,7 +487,7 @@ Used by stage {3,4}; can be omitted otherwise. If omitted: N/A.
|
|
487
487
|
.sp
|
488
488
|
Default: False
|
489
489
|
.TP
|
490
|
-
.B\-\-plot\-log\-xscale
|
490
|
+
.B \-\-plot\-log\-xscale
|
491
491
|
.INDENT 7.0
|
492
492
|
.INDENT 3.5
|
493
493
|
Place the set of X values used to generate intra\- and
|
@@ -518,7 +518,7 @@ Used by stage {4,5}; can be omitted otherwise. If omitted: N/A.
|
|
518
518
|
.sp
|
519
519
|
Default: False
|
520
520
|
.TP
|
521
|
-
.B\-\-plot\-enumerated\-xscale
|
521
|
+
.B \-\-plot\-enumerated\-xscale
|
522
522
|
.INDENT 7.0
|
523
523
|
.INDENT 3.5
|
524
524
|
Instead of using the values generated by a
|
@@ -550,7 +550,7 @@ Used by stage {4,5}; can be omitted otherwise. If omitted: N/A.
|
|
550
550
|
.sp
|
551
551
|
Default: False
|
552
552
|
.TP
|
553
|
-
.B\-\-plot\-log\-yscale
|
553
|
+
.B \-\-plot\-log\-yscale
|
554
554
|
.INDENT 7.0
|
555
555
|
.INDENT 3.5
|
556
556
|
Place the set of Y values used to generate
|
@@ -583,7 +583,7 @@ Used by stage {4,5}; can be omitted otherwise. If omitted: N/A.
|
|
583
583
|
.sp
|
584
584
|
Default: False
|
585
585
|
.TP
|
586
|
-
.B\-\-plot\-regression\-lines
|
586
|
+
.B \-\-plot\-regression\-lines
|
587
587
|
.INDENT 7.0
|
588
588
|
.INDENT 3.5
|
589
589
|
For all 2D generated scatterplots, plot a
|
@@ -610,7 +610,7 @@ Used by stage {4,5}; can be omitted otherwise. If omitted: N/A.
|
|
610
610
|
.UNINDENT
|
611
611
|
.UNINDENT
|
612
612
|
.TP
|
613
|
-
.B\-\-plot\-primary\-axis
|
613
|
+
.B \-\-plot\-primary\-axis
|
614
614
|
.INDENT 7.0
|
615
615
|
.INDENT 3.5
|
616
616
|
.INDENT 0.0
|
@@ -625,7 +625,7 @@ composed of
|
|
625
625
|
.UNINDENT
|
626
626
|
.INDENT 0.0
|
627
627
|
.IP \(bu 2
|
628
|
-
|
628
|
+
\fI\%Population Size\fP
|
629
629
|
on the X axis (rows)
|
630
630
|
.IP \(bu 2
|
631
631
|
Another batch criteria which does not
|
@@ -673,7 +673,7 @@ Used by stage {4,5}; can be omitted otherwise. If omitted: N/A.
|
|
673
673
|
.UNINDENT
|
674
674
|
.UNINDENT
|
675
675
|
.TP
|
676
|
-
.B\-\-plot\-large\-text
|
676
|
+
.B \-\-plot\-large\-text
|
677
677
|
.INDENT 7.0
|
678
678
|
.INDENT 3.5
|
679
679
|
This option specifies that the title, X/Y
|
@@ -697,7 +697,7 @@ Used by stage {4,5}; can be omitted otherwise. If omitted: N/A.
|
|
697
697
|
.sp
|
698
698
|
Default: False
|
699
699
|
.TP
|
700
|
-
.B\-\-plot\-transpose\-graphs
|
700
|
+
.B \-\-plot\-transpose\-graphs
|
701
701
|
.INDENT 7.0
|
702
702
|
.INDENT 3.5
|
703
703
|
Transpose the X, Y axes in generated
|
@@ -754,13 +754,13 @@ usage: SIERRA [\-\-df\-skip\-verify] [\-\-storage\-medium {storage.csv}]
|
|
754
754
|
.SS Stage3: General options for eprocessing experiment results
|
755
755
|
.INDENT 0.0
|
756
756
|
.TP
|
757
|
-
.B\-\-df\-skip\-verify
|
757
|
+
.B \-\-df\-skip\-verify
|
758
758
|
.INDENT 7.0
|
759
759
|
.INDENT 3.5
|
760
760
|
SIERRA generally assumes/relies on all
|
761
761
|
dataframes with the same name having the same #
|
762
762
|
of columns which are of equivalent length
|
763
|
-
across Experimental Runs (different columns within a dataframe can
|
763
|
+
across \fI\%Experimental Runs\fP (different columns within a dataframe can
|
764
764
|
of course have different lengths). This is
|
765
765
|
strictly verified during stage 3 by default.
|
766
766
|
.sp
|
@@ -786,12 +786,12 @@ Used by stage {3}; can be omitted otherwise. If omitted: N/A.
|
|
786
786
|
.sp
|
787
787
|
Default: False
|
788
788
|
.TP
|
789
|
-
.B\-\-storage\-medium
|
789
|
+
.B \-\-storage\-medium
|
790
790
|
Possible choices: storage.csv
|
791
791
|
.INDENT 7.0
|
792
792
|
.INDENT 3.5
|
793
793
|
Specify the storage medium for
|
794
|
-
Experimental Run outputs, so that
|
794
|
+
\fI\%Experimental Run\fP outputs, so that
|
795
795
|
SIERRA can select an appropriate plugin to read
|
796
796
|
them. Any plugin under \fBplugins/storage\fP can
|
797
797
|
be used, but the ones that come with SIERRA
|
@@ -816,9 +816,9 @@ Used by stage {3}; can be omitted otherwise. If omitted: N/A.
|
|
816
816
|
.UNINDENT
|
817
817
|
.UNINDENT
|
818
818
|
.sp
|
819
|
-
Default:
|
819
|
+
Default: \(dqstorage.csv\(dq
|
820
820
|
.TP
|
821
|
-
.B\-\-dist\-stats
|
821
|
+
.B \-\-dist\-stats
|
822
822
|
Possible choices: none, all, conf95, bw
|
823
823
|
.INDENT 7.0
|
824
824
|
.INDENT 3.5
|
@@ -865,9 +865,9 @@ Used by stage {3,4}; can be omitted otherwise. If omitted: N/A.
|
|
865
865
|
.UNINDENT
|
866
866
|
.UNINDENT
|
867
867
|
.sp
|
868
|
-
Default:
|
868
|
+
Default: \(dqnone\(dq
|
869
869
|
.TP
|
870
|
-
.B\-\-processing\-mem\-limit
|
870
|
+
.B \-\-processing\-mem\-limit
|
871
871
|
.INDENT 7.0
|
872
872
|
.INDENT 3.5
|
873
873
|
Specify, as a percent in [0, 100], how much
|
@@ -888,7 +888,7 @@ Used by stage {3,4}; can be omitted otherwise. If omitted: N/A.
|
|
888
888
|
.sp
|
889
889
|
Default: 90
|
890
890
|
.TP
|
891
|
-
.B\-\-df\-homogenize
|
891
|
+
.B \-\-df\-homogenize
|
892
892
|
.INDENT 7.0
|
893
893
|
.INDENT 3.5
|
894
894
|
SIERRA generally assumes/relies on all
|
@@ -934,7 +934,7 @@ experiment started.
|
|
934
934
|
.UNINDENT
|
935
935
|
.UNINDENT
|
936
936
|
.sp
|
937
|
-
Default:
|
937
|
+
Default: \(dqnone\(dq
|
938
938
|
.UNINDENT
|
939
939
|
.SS Stage4: Deliverable Generation
|
940
940
|
.INDENT 0.0
|
@@ -953,7 +953,7 @@ usage: SIERRA [\-\-exp\-graphs {intra,inter,all,none}] [\-\-project\-no\-LN]
|
|
953
953
|
.SS Stage4: General options for generating graphs
|
954
954
|
.INDENT 0.0
|
955
955
|
.TP
|
956
|
-
.B\-\-exp\-graphs
|
956
|
+
.B \-\-exp\-graphs
|
957
957
|
Possible choices: intra, inter, all, none
|
958
958
|
.INDENT 7.0
|
959
959
|
.INDENT 3.5
|
@@ -993,9 +993,9 @@ Used by stage {4}; can be omitted otherwise. If omitted: N/A.
|
|
993
993
|
.UNINDENT
|
994
994
|
.UNINDENT
|
995
995
|
.sp
|
996
|
-
Default:
|
996
|
+
Default: \(dqall\(dq
|
997
997
|
.TP
|
998
|
-
.B\-\-project\-no\-LN
|
998
|
+
.B \-\-project\-no\-LN
|
999
999
|
.INDENT 7.0
|
1000
1000
|
.INDENT 3.5
|
1001
1001
|
Specify that the intra\-experiment and
|
@@ -1014,7 +1014,7 @@ applicable.
|
|
1014
1014
|
.sp
|
1015
1015
|
Default: False
|
1016
1016
|
.TP
|
1017
|
-
.B\-\-project\-no\-HM
|
1017
|
+
.B \-\-project\-no\-HM
|
1018
1018
|
.INDENT 7.0
|
1019
1019
|
.INDENT 3.5
|
1020
1020
|
Specify that the intra\-experiment heatmaps
|
@@ -1046,7 +1046,7 @@ Default: False
|
|
1046
1046
|
.SS Models
|
1047
1047
|
.INDENT 0.0
|
1048
1048
|
.TP
|
1049
|
-
.B\-\-models\-enable
|
1049
|
+
.B \-\-models\-enable
|
1050
1050
|
.INDENT 7.0
|
1051
1051
|
.INDENT 3.5
|
1052
1052
|
Enable running of all models; otherwise, no models
|
@@ -1061,7 +1061,7 @@ Default: False
|
|
1061
1061
|
.SS Stage4: Rendering (see also stage1 rendering options)
|
1062
1062
|
.INDENT 0.0
|
1063
1063
|
.TP
|
1064
|
-
.B\-\-render\-cmd\-opts
|
1064
|
+
.B \-\-render\-cmd\-opts
|
1065
1065
|
.INDENT 7.0
|
1066
1066
|
.INDENT 3.5
|
1067
1067
|
Specify the: program: \fIffmpeg\fP options to appear
|
@@ -1080,15 +1080,15 @@ Used by stage {4}; can be omitted otherwise. If omitted: N/A.
|
|
1080
1080
|
.UNINDENT
|
1081
1081
|
.UNINDENT
|
1082
1082
|
.sp
|
1083
|
-
Default:
|
1083
|
+
Default: \(dq\-r 10 \-s:v 800x600 \-c:v libx264 \-crf 25 \-filter:v scale=\-2:956 \-pix_fmt yuv420p\(dq
|
1084
1084
|
.TP
|
1085
|
-
.B\-\-project\-imagizing
|
1085
|
+
.B \-\-project\-imagizing
|
1086
1086
|
.INDENT 7.0
|
1087
1087
|
.INDENT 3.5
|
1088
1088
|
Enable generation of image files from CSV files
|
1089
1089
|
captured during stage 2 and averaged during stage
|
1090
1090
|
3 for each experiment. See
|
1091
|
-
|
1091
|
+
\fI\%Project Rendering\fP for
|
1092
1092
|
details and restrictions.
|
1093
1093
|
.UNINDENT
|
1094
1094
|
.UNINDENT
|
@@ -1102,13 +1102,13 @@ Used by stage {3,4}; can be omitted otherwise. If omitted: N/A.
|
|
1102
1102
|
.sp
|
1103
1103
|
Default: False
|
1104
1104
|
.TP
|
1105
|
-
.B\-\-project\-rendering
|
1105
|
+
.B \-\-project\-rendering
|
1106
1106
|
.INDENT 7.0
|
1107
1107
|
.INDENT 3.5
|
1108
1108
|
Enable generation of videos from imagized CSV
|
1109
1109
|
files created as a result of
|
1110
1110
|
\fB\-\-project\-imagizing\fP\&. See
|
1111
|
-
|
1111
|
+
\fI\%Project Rendering\fP for
|
1112
1112
|
details.
|
1113
1113
|
.UNINDENT
|
1114
1114
|
.UNINDENT
|
@@ -1122,7 +1122,7 @@ Used by stage {4}; can be omitted otherwise. If omitted: N/A.
|
|
1122
1122
|
.sp
|
1123
1123
|
Default: False
|
1124
1124
|
.TP
|
1125
|
-
.B\-\-bc\-rendering
|
1125
|
+
.B \-\-bc\-rendering
|
1126
1126
|
.INDENT 7.0
|
1127
1127
|
.INDENT 3.5
|
1128
1128
|
Enable generation of videos from generated
|
@@ -1160,7 +1160,7 @@ usage: SIERRA [\-\-controllers\-list CONTROLLERS_LIST]
|
|
1160
1160
|
.SS Stage5: General options for controller comparison
|
1161
1161
|
.INDENT 0.0
|
1162
1162
|
.TP
|
1163
|
-
.B\-\-controllers\-list
|
1163
|
+
.B \-\-controllers\-list
|
1164
1164
|
.INDENT 7.0
|
1165
1165
|
.INDENT 3.5
|
1166
1166
|
Comma separated list of controllers to compare
|
@@ -1178,7 +1178,7 @@ Used by stage {5}; can be omitted otherwise. If omitted: N/A.
|
|
1178
1178
|
.UNINDENT
|
1179
1179
|
.UNINDENT
|
1180
1180
|
.TP
|
1181
|
-
.B\-\-controllers\-legend
|
1181
|
+
.B \-\-controllers\-legend
|
1182
1182
|
.INDENT 7.0
|
1183
1183
|
.INDENT 3.5
|
1184
1184
|
Comma separated list of names to use on the
|
@@ -1195,7 +1195,7 @@ Used by stage {5}; can be omitted otherwise. If omitted: the raw controller name
|
|
1195
1195
|
.UNINDENT
|
1196
1196
|
.UNINDENT
|
1197
1197
|
.TP
|
1198
|
-
.B\-\-scenarios\-list
|
1198
|
+
.B \-\-scenarios\-list
|
1199
1199
|
.INDENT 7.0
|
1200
1200
|
.INDENT 3.5
|
1201
1201
|
Comma separated list of scenarios to compare
|
@@ -1211,7 +1211,7 @@ Used by stage {5}; can be omitted otherwise. If omitted: N/A.
|
|
1211
1211
|
.UNINDENT
|
1212
1212
|
.UNINDENT
|
1213
1213
|
.TP
|
1214
|
-
.B\-\-scenarios\-legend
|
1214
|
+
.B \-\-scenarios\-legend
|
1215
1215
|
.INDENT 7.0
|
1216
1216
|
.INDENT 3.5
|
1217
1217
|
Comma separated list of names to use on the
|
@@ -1229,7 +1229,7 @@ Used by stage {5}; can be omitted otherwise. If omitted: the raw scenario names
|
|
1229
1229
|
.UNINDENT
|
1230
1230
|
.UNINDENT
|
1231
1231
|
.TP
|
1232
|
-
.B\-\-scenario\-comparison
|
1232
|
+
.B \-\-scenario\-comparison
|
1233
1233
|
.INDENT 7.0
|
1234
1234
|
.INDENT 3.5
|
1235
1235
|
Perform a comparison of \fB\-\-controller\fP across
|
@@ -1248,7 +1248,7 @@ passed.
|
|
1248
1248
|
.sp
|
1249
1249
|
Default: False
|
1250
1250
|
.TP
|
1251
|
-
.B\-\-controller\-comparison
|
1251
|
+
.B \-\-controller\-comparison
|
1252
1252
|
.INDENT 7.0
|
1253
1253
|
.INDENT 3.5
|
1254
1254
|
Perform a comparison of \fB\-\-controllers\-list\fP
|
@@ -1266,7 +1266,7 @@ Used by stage {5}; can be omitted otherwise. Either \fB\-\-scenario\-comparison\
|
|
1266
1266
|
.sp
|
1267
1267
|
Default: False
|
1268
1268
|
.TP
|
1269
|
-
.B\-\-comparison\-type
|
1269
|
+
.B \-\-comparison\-type
|
1270
1270
|
Possible choices: LNraw, HMraw, HMdiff, HMscale, SUraw, SUscale, SUdiff
|
1271
1271
|
.INDENT 7.0
|
1272
1272
|
.INDENT 3.5
|
@@ -1355,7 +1355,7 @@ Used by stage {5}; can be omitted otherwise. If omitted: N/A.
|
|
1355
1355
|
.UNINDENT
|
1356
1356
|
.UNINDENT
|
1357
1357
|
.TP
|
1358
|
-
.B\-\-bc\-univar
|
1358
|
+
.B \-\-bc\-univar
|
1359
1359
|
.INDENT 7.0
|
1360
1360
|
.INDENT 3.5
|
1361
1361
|
Specify that the batch criteria is
|
@@ -1380,7 +1380,7 @@ Used by stage {5}; can be omitted otherwise. If omitted: N/A.
|
|
1380
1380
|
.sp
|
1381
1381
|
Default: False
|
1382
1382
|
.TP
|
1383
|
-
.B\-\-bc\-bivar
|
1383
|
+
.B \-\-bc\-bivar
|
1384
1384
|
.INDENT 7.0
|
1385
1385
|
.INDENT 3.5
|
1386
1386
|
Specify that the batch criteria is
|
@@ -1428,13 +1428,13 @@ usage: SIERRA [\-\-exp\-setup EXP_SETUP] [\-\-physics\-engine\-type2D {dynamics2
|
|
1428
1428
|
.SS Stage1: Experiment generation
|
1429
1429
|
.INDENT 0.0
|
1430
1430
|
.TP
|
1431
|
-
.B\-\-exp\-setup
|
1431
|
+
.B \-\-exp\-setup
|
1432
1432
|
.INDENT 7.0
|
1433
1433
|
.INDENT 3.5
|
1434
|
-
Defines experiment run length, Ticks per second for the experiment
|
1434
|
+
Defines experiment run length, \fI\%Ticks\fP per second for the experiment
|
1435
1435
|
(<experiment> tag), # of datapoints to
|
1436
1436
|
capture/capture interval for each
|
1437
|
-
simulation. See
|
1437
|
+
simulation. See \fI\%Experiment Setup\fP for
|
1438
1438
|
a full description.
|
1439
1439
|
.UNINDENT
|
1440
1440
|
.UNINDENT
|
@@ -1446,12 +1446,12 @@ Used by stage {1}; can be omitted otherwise. If omitted: N/A.
|
|
1446
1446
|
.UNINDENT
|
1447
1447
|
.UNINDENT
|
1448
1448
|
.sp
|
1449
|
-
Default:
|
1449
|
+
Default: \(dqexp_setup.T5000.K5.N50\(dq
|
1450
1450
|
.UNINDENT
|
1451
1451
|
.SS Stage1: Configuring ARGoS physics engines
|
1452
1452
|
.INDENT 0.0
|
1453
1453
|
.TP
|
1454
|
-
.B\-\-physics\-engine\-type2D
|
1454
|
+
.B \-\-physics\-engine\-type2D
|
1455
1455
|
Possible choices: dynamics2d
|
1456
1456
|
.INDENT 7.0
|
1457
1457
|
.INDENT 3.5
|
@@ -1472,9 +1472,9 @@ Used by stage {1}; can be omitted otherwise. If omitted: N/A.
|
|
1472
1472
|
.UNINDENT
|
1473
1473
|
.UNINDENT
|
1474
1474
|
.sp
|
1475
|
-
Default:
|
1475
|
+
Default: \(dqdynamics2d\(dq
|
1476
1476
|
.TP
|
1477
|
-
.B\-\-physics\-engine\-type3D
|
1477
|
+
.B \-\-physics\-engine\-type3D
|
1478
1478
|
Possible choices: dynamics3d
|
1479
1479
|
.INDENT 7.0
|
1480
1480
|
.INDENT 3.5
|
@@ -1496,9 +1496,9 @@ Used by stage {1}; can be omitted otherwise. If omitted: N/A.
|
|
1496
1496
|
.UNINDENT
|
1497
1497
|
.UNINDENT
|
1498
1498
|
.sp
|
1499
|
-
Default:
|
1499
|
+
Default: \(dqdynamics3d\(dq
|
1500
1500
|
.TP
|
1501
|
-
.B\-\-physics\-n\-engines
|
1501
|
+
.B \-\-physics\-n\-engines
|
1502
1502
|
Possible choices: 1, 2, 4, 6, 8, 12, 16, 24
|
1503
1503
|
.INDENT 7.0
|
1504
1504
|
.INDENT 3.5
|
@@ -1510,7 +1510,7 @@ not be the same depending on dimensions
|
|
1510
1510
|
and how many engines are chosen,
|
1511
1511
|
however), extending upward in Z to the
|
1512
1512
|
height specified by \fB\-\-scenario\fP
|
1513
|
-
(i.e., forming a set of
|
1513
|
+
(i.e., forming a set of \(dqsilos\(dq rather
|
1514
1514
|
that equal volumetric extents).
|
1515
1515
|
.sp
|
1516
1516
|
If 2D and 3D physics engines are mixed,
|
@@ -1568,11 +1568,11 @@ Used by stage {1}; can be omitted otherwise. If omitted: N/A.
|
|
1568
1568
|
.UNINDENT
|
1569
1569
|
.UNINDENT
|
1570
1570
|
.TP
|
1571
|
-
.B\-\-physics\-iter\-per\-tick
|
1571
|
+
.B \-\-physics\-iter\-per\-tick
|
1572
1572
|
.INDENT 7.0
|
1573
1573
|
.INDENT 3.5
|
1574
1574
|
The # of iterations all physics engines
|
1575
|
-
should perform per Tick each
|
1575
|
+
should perform per \fI\%Tick\fP each
|
1576
1576
|
time the controller loops are run (the
|
1577
1577
|
# of ticks per second for controller
|
1578
1578
|
control loops is set via
|
@@ -1589,7 +1589,7 @@ Used by stage {1}; can be omitted otherwise. If omitted: N/A.
|
|
1589
1589
|
.sp
|
1590
1590
|
Default: 10
|
1591
1591
|
.TP
|
1592
|
-
.B\-\-physics\-spatial\-hash2D
|
1592
|
+
.B \-\-physics\-spatial\-hash2D
|
1593
1593
|
.INDENT 7.0
|
1594
1594
|
.INDENT 3.5
|
1595
1595
|
Specify that each 2D physics engine
|
@@ -1603,7 +1603,7 @@ Default: False
|
|
1603
1603
|
.SS Stage1: Rendering (see also stage4 rendering options)
|
1604
1604
|
.INDENT 0.0
|
1605
1605
|
.TP
|
1606
|
-
.B\-\-camera\-config
|
1606
|
+
.B \-\-camera\-config
|
1607
1607
|
Possible choices: overhead, sw, sw+interp
|
1608
1608
|
.INDENT 7.0
|
1609
1609
|
.INDENT 3.5
|
@@ -1638,12 +1638,12 @@ Used by stage {1}; can be omitted otherwise. If omitted: N/A.
|
|
1638
1638
|
.UNINDENT
|
1639
1639
|
.UNINDENT
|
1640
1640
|
.sp
|
1641
|
-
Default:
|
1641
|
+
Default: \(dqoverhead\(dq
|
1642
1642
|
.UNINDENT
|
1643
1643
|
.SS Stage1: Configuring robots
|
1644
1644
|
.INDENT 0.0
|
1645
1645
|
.TP
|
1646
|
-
.B\-\-with\-robot\-rab
|
1646
|
+
.B \-\-with\-robot\-rab
|
1647
1647
|
.INDENT 7.0
|
1648
1648
|
.INDENT 3.5
|
1649
1649
|
If passed, do not remove the Range and
|
@@ -1673,7 +1673,7 @@ Used by stage {1}; can be omitted otherwise. If omitted: N/A.
|
|
1673
1673
|
.sp
|
1674
1674
|
Default: False
|
1675
1675
|
.TP
|
1676
|
-
.B\-\-with\-robot\-leds
|
1676
|
+
.B \-\-with\-robot\-leds
|
1677
1677
|
.INDENT 7.0
|
1678
1678
|
.INDENT 3.5
|
1679
1679
|
If passed, do not remove the robot LED
|
@@ -1702,7 +1702,7 @@ Used by stage {1}; can be omitted otherwise. If omitted: N/A.
|
|
1702
1702
|
.sp
|
1703
1703
|
Default: False
|
1704
1704
|
.TP
|
1705
|
-
.B\-\-with\-robot\-battery
|
1705
|
+
.B \-\-with\-robot\-battery
|
1706
1706
|
.INDENT 7.0
|
1707
1707
|
.INDENT 3.5
|
1708
1708
|
If passed, do not remove the robot
|
@@ -1729,7 +1729,7 @@ Used by stage {1}; can be omitted otherwise. If omitted: N/A.
|
|
1729
1729
|
.sp
|
1730
1730
|
Default: False
|
1731
1731
|
.TP
|
1732
|
-
.B\-\-n\-robots
|
1732
|
+
.B \-\-n\-robots
|
1733
1733
|
.INDENT 7.0
|
1734
1734
|
.INDENT 3.5
|
1735
1735
|
The # robots that should be used in the
|
@@ -1765,7 +1765,7 @@ usage: SIERRA [\-\-exec\-jobs\-per\-node EXEC_JOBS_PER_NODE] [\-\-exec\-devnull]
|
|
1765
1765
|
For platforms which are simulators (and can therefore be run in HPC environments).
|
1766
1766
|
.INDENT 0.0
|
1767
1767
|
.TP
|
1768
|
-
.B\-\-exec\-jobs\-per\-node
|
1768
|
+
.B \-\-exec\-jobs\-per\-node
|
1769
1769
|
.INDENT 7.0
|
1770
1770
|
.INDENT 3.5
|
1771
1771
|
Specify the maximum number of parallel jobs to run
|
@@ -1785,7 +1785,7 @@ Used by stage {2}; can be omitted otherwise. If omitted: N/A.
|
|
1785
1785
|
.UNINDENT
|
1786
1786
|
.UNINDENT
|
1787
1787
|
.TP
|
1788
|
-
.B\-\-exec\-devnull
|
1788
|
+
.B \-\-exec\-devnull
|
1789
1789
|
.INDENT 7.0
|
1790
1790
|
.INDENT 3.5
|
1791
1791
|
Redirect ALL output from simulations to
|
@@ -1806,7 +1806,7 @@ Used by stage {1,2}; can be omitted otherwise. If omitted: N/A.
|
|
1806
1806
|
.sp
|
1807
1807
|
Default: True
|
1808
1808
|
.TP
|
1809
|
-
.B\-\-exec\-no\-devnull
|
1809
|
+
.B \-\-exec\-no\-devnull
|
1810
1810
|
.INDENT 7.0
|
1811
1811
|
.INDENT 3.5
|
1812
1812
|
Don\(aqt redirect ALL output from simulations to
|
@@ -1827,7 +1827,7 @@ Used by stage {1,2}; can be omitted otherwise. If omitted: N/A.
|
|
1827
1827
|
.sp
|
1828
1828
|
Default: True
|
1829
1829
|
.TP
|
1830
|
-
.B\-\-exec\-resume
|
1830
|
+
.B \-\-exec\-resume
|
1831
1831
|
.INDENT 7.0
|
1832
1832
|
.INDENT 3.5
|
1833
1833
|
Resume a batch experiment that was
|
@@ -1844,7 +1844,7 @@ Used by stage {2}; can be omitted otherwise. If omitted: N/A.
|
|
1844
1844
|
.sp
|
1845
1845
|
Default: False
|
1846
1846
|
.TP
|
1847
|
-
.B\-\-exec\-strict
|
1847
|
+
.B \-\-exec\-strict
|
1848
1848
|
.INDENT 7.0
|
1849
1849
|
.INDENT 3.5
|
1850
1850
|
If passed, then if any experimental commands fail
|
@@ -1855,7 +1855,7 @@ experiments.
|
|
1855
1855
|
Useful for:
|
1856
1856
|
.INDENT 0.0
|
1857
1857
|
.IP \(bu 2
|
1858
|
-
|
1858
|
+
\(dqCorrectness by construction\(dq experiments, where
|
1859
1859
|
you know if SIERRA doesn\(aqt crash and it makes it
|
1860
1860
|
to the end of your batch experiment then none of
|
1861
1861
|
the individual experiments crashed.
|
@@ -1889,13 +1889,13 @@ usage: SIERRA [\-\-exp\-setup EXP_SETUP] [\-\-robot ROBOT]
|
|
1889
1889
|
.SS Stage1: Experiment generation
|
1890
1890
|
.INDENT 0.0
|
1891
1891
|
.TP
|
1892
|
-
.B\-\-exp\-setup
|
1892
|
+
.B \-\-exp\-setup
|
1893
1893
|
.INDENT 7.0
|
1894
1894
|
.INDENT 3.5
|
1895
1895
|
Defines experiment run length, ticks per
|
1896
1896
|
second for the experiment, # of datapoints
|
1897
1897
|
to capture/capture interval for each
|
1898
|
-
simulation. See
|
1898
|
+
simulation. See \fI\%Experiment Setup\fP for
|
1899
1899
|
a full description.
|
1900
1900
|
.UNINDENT
|
1901
1901
|
.UNINDENT
|
@@ -1907,14 +1907,14 @@ Used by stage {1}; can be omitted otherwise. If omitted: N/A.
|
|
1907
1907
|
.UNINDENT
|
1908
1908
|
.UNINDENT
|
1909
1909
|
.sp
|
1910
|
-
Default:
|
1910
|
+
Default: \(dqexp_setup.T1000.K5.N50\(dq
|
1911
1911
|
.TP
|
1912
|
-
.B\-\-robot
|
1912
|
+
.B \-\-robot
|
1913
1913
|
.INDENT 7.0
|
1914
1914
|
.INDENT 3.5
|
1915
1915
|
The key name of the robot model, which must
|
1916
1916
|
be present in the appropriate section of
|
1917
|
-
\fBmain.yaml\fP for the Project\&. See
|
1917
|
+
\fBmain.yaml\fP for the \fI\%Project\fP\&. See
|
1918
1918
|
ln\-sierra\-tutorials\-project\-main\-config
|
1919
1919
|
for details.
|
1920
1920
|
.UNINDENT
|
@@ -1930,10 +1930,10 @@ Used by stage {1}; can be omitted otherwise. If omitted: N/A.
|
|
1930
1930
|
.SS Stage1: Experiment setup
|
1931
1931
|
.INDENT 0.0
|
1932
1932
|
.TP
|
1933
|
-
.B\-\-robot\-positions
|
1933
|
+
.B \-\-robot\-positions
|
1934
1934
|
.INDENT 7.0
|
1935
1935
|
.INDENT 3.5
|
1936
|
-
A list of space\-separated
|
1936
|
+
A list of space\-separated \(dqX,Y,Z\(dq tuples
|
1937
1937
|
(no quotes) passed on the command line as
|
1938
1938
|
valid starting positions for the robots
|
1939
1939
|
within the world.
|
@@ -1952,14 +1952,14 @@ Default: []
|
|
1952
1952
|
.SS Stage1: Configuring Gazebo physics engines
|
1953
1953
|
.INDENT 0.0
|
1954
1954
|
.TP
|
1955
|
-
.B\-\-physics\-engine\-type
|
1955
|
+
.B \-\-physics\-engine\-type
|
1956
1956
|
Possible choices: ode, bullet, dart, simbody
|
1957
1957
|
.INDENT 7.0
|
1958
1958
|
.INDENT 3.5
|
1959
1959
|
The type of 3D physics engine to use
|
1960
1960
|
for managing spatial extents within the
|
1961
1961
|
arena, choosing one of the types that
|
1962
|
-
Gazebo supports. A single
|
1962
|
+
\fI\%Gazebo\fP supports. A single
|
1963
1963
|
engine instance is used to manage all
|
1964
1964
|
physics in the arena.
|
1965
1965
|
.UNINDENT
|
@@ -1972,9 +1972,9 @@ Used by stage {1}; can be omitted otherwise. If omitted: N/A.
|
|
1972
1972
|
.UNINDENT
|
1973
1973
|
.UNINDENT
|
1974
1974
|
.sp
|
1975
|
-
Default:
|
1975
|
+
Default: \(dqode\(dq
|
1976
1976
|
.TP
|
1977
|
-
.B\-\-physics\-iter\-per\-tick
|
1977
|
+
.B \-\-physics\-iter\-per\-tick
|
1978
1978
|
.INDENT 7.0
|
1979
1979
|
.INDENT 3.5
|
1980
1980
|
The # of iterations all physics engines
|
@@ -1994,11 +1994,11 @@ Used by stage {1}; can be omitted otherwise. If omitted: N/A.
|
|
1994
1994
|
.sp
|
1995
1995
|
Default: 1000
|
1996
1996
|
.TP
|
1997
|
-
.B\-\-physics\-n\-threads
|
1997
|
+
.B \-\-physics\-n\-threads
|
1998
1998
|
.INDENT 7.0
|
1999
1999
|
.INDENT 3.5
|
2000
2000
|
Gazebo can group non\-interacting
|
2001
|
-
entities into computational
|
2001
|
+
entities into computational \(dqislands\(dq
|
2002
2002
|
and do the physics updates for those
|
2003
2003
|
islands in parallel each timestep
|
2004
2004
|
(islands) are recomputed after each
|
@@ -2007,7 +2007,7 @@ the computation of velocity/position
|
|
2007
2007
|
updates with the computation of
|
2008
2008
|
resolving collisions (i.e., the
|
2009
2009
|
timestep impulse results in one entity
|
2010
|
-
|
2010
|
+
\(dqinside\(dq another). You can assign
|
2011
2011
|
multiple threads to a pool for
|
2012
2012
|
cumulative use for these two
|
2013
2013
|
parallelization methods (threads will
|
@@ -2044,14 +2044,14 @@ Used by stage {1}; can be omitted otherwise. If omitted: N/A.
|
|
2044
2044
|
.sp
|
2045
2045
|
Default: 0
|
2046
2046
|
.TP
|
2047
|
-
.B\-\-physics\-ec\-threadpool
|
2047
|
+
.B \-\-physics\-ec\-threadpool
|
2048
2048
|
.INDENT 7.0
|
2049
2049
|
.INDENT 3.5
|
2050
2050
|
Gazebo can parallelize the computation
|
2051
2051
|
of velocity/position updates with the
|
2052
2052
|
computation of resolving collisions
|
2053
2053
|
(i.e., the timestep impulse results in
|
2054
|
-
one entity
|
2054
|
+
one entity \(dqinside\(dq another). You can
|
2055
2055
|
assign multiple threads to a pool for
|
2056
2056
|
cumulative use for this purpose. The
|
2057
2057
|
point at which adding more threads will
|
@@ -2102,7 +2102,7 @@ usage: SIERRA [\-\-exec\-jobs\-per\-node EXEC_JOBS_PER_NODE] [\-\-exec\-devnull]
|
|
2102
2102
|
For platforms which are simulators (and can therefore be run in HPC environments).
|
2103
2103
|
.INDENT 0.0
|
2104
2104
|
.TP
|
2105
|
-
.B\-\-exec\-jobs\-per\-node
|
2105
|
+
.B \-\-exec\-jobs\-per\-node
|
2106
2106
|
.INDENT 7.0
|
2107
2107
|
.INDENT 3.5
|
2108
2108
|
Specify the maximum number of parallel jobs to run
|
@@ -2122,7 +2122,7 @@ Used by stage {2}; can be omitted otherwise. If omitted: N/A.
|
|
2122
2122
|
.UNINDENT
|
2123
2123
|
.UNINDENT
|
2124
2124
|
.TP
|
2125
|
-
.B\-\-exec\-devnull
|
2125
|
+
.B \-\-exec\-devnull
|
2126
2126
|
.INDENT 7.0
|
2127
2127
|
.INDENT 3.5
|
2128
2128
|
Redirect ALL output from simulations to
|
@@ -2143,7 +2143,7 @@ Used by stage {1,2}; can be omitted otherwise. If omitted: N/A.
|
|
2143
2143
|
.sp
|
2144
2144
|
Default: True
|
2145
2145
|
.TP
|
2146
|
-
.B\-\-exec\-no\-devnull
|
2146
|
+
.B \-\-exec\-no\-devnull
|
2147
2147
|
.INDENT 7.0
|
2148
2148
|
.INDENT 3.5
|
2149
2149
|
Don\(aqt redirect ALL output from simulations to
|
@@ -2164,7 +2164,7 @@ Used by stage {1,2}; can be omitted otherwise. If omitted: N/A.
|
|
2164
2164
|
.sp
|
2165
2165
|
Default: True
|
2166
2166
|
.TP
|
2167
|
-
.B\-\-exec\-resume
|
2167
|
+
.B \-\-exec\-resume
|
2168
2168
|
.INDENT 7.0
|
2169
2169
|
.INDENT 3.5
|
2170
2170
|
Resume a batch experiment that was
|
@@ -2181,7 +2181,7 @@ Used by stage {2}; can be omitted otherwise. If omitted: N/A.
|
|
2181
2181
|
.sp
|
2182
2182
|
Default: False
|
2183
2183
|
.TP
|
2184
|
-
.B\-\-exec\-strict
|
2184
|
+
.B \-\-exec\-strict
|
2185
2185
|
.INDENT 7.0
|
2186
2186
|
.INDENT 3.5
|
2187
2187
|
If passed, then if any experimental commands fail
|
@@ -2192,7 +2192,7 @@ experiments.
|
|
2192
2192
|
Useful for:
|
2193
2193
|
.INDENT 0.0
|
2194
2194
|
.IP \(bu 2
|
2195
|
-
|
2195
|
+
\(dqCorrectness by construction\(dq experiments, where
|
2196
2196
|
you know if SIERRA doesn\(aqt crash and it makes it
|
2197
2197
|
to the end of your batch experiment then none of
|
2198
2198
|
the individual experiments crashed.
|
@@ -2221,13 +2221,13 @@ usage: SIERRA [\-\-exp\-setup EXP_SETUP] [\-\-robot ROBOT] [\-\-skip\-sync]
|
|
2221
2221
|
.SS Stage1: Experiment generation
|
2222
2222
|
.INDENT 0.0
|
2223
2223
|
.TP
|
2224
|
-
.B\-\-exp\-setup
|
2224
|
+
.B \-\-exp\-setup
|
2225
2225
|
.INDENT 7.0
|
2226
2226
|
.INDENT 3.5
|
2227
2227
|
Defines experiment run length, ticks per
|
2228
2228
|
second for the experiment, # of datapoints
|
2229
2229
|
to capture/capture interval for each
|
2230
|
-
simulation. See
|
2230
|
+
simulation. See \fI\%Experiment Setup\fP for
|
2231
2231
|
a full description.
|
2232
2232
|
.UNINDENT
|
2233
2233
|
.UNINDENT
|
@@ -2239,14 +2239,14 @@ Used by stage {1}; can be omitted otherwise. If omitted: N/A.
|
|
2239
2239
|
.UNINDENT
|
2240
2240
|
.UNINDENT
|
2241
2241
|
.sp
|
2242
|
-
Default:
|
2242
|
+
Default: \(dqexp_setup.T1000.K5.N50\(dq
|
2243
2243
|
.TP
|
2244
|
-
.B\-\-robot
|
2244
|
+
.B \-\-robot
|
2245
2245
|
.INDENT 7.0
|
2246
2246
|
.INDENT 3.5
|
2247
2247
|
The key name of the robot model, which must
|
2248
2248
|
be present in the appropriate section of
|
2249
|
-
\fBmain.yaml\fP for the Project\&. See
|
2249
|
+
\fBmain.yaml\fP for the \fI\%Project\fP\&. See
|
2250
2250
|
ln\-sierra\-tutorials\-project\-main\-config
|
2251
2251
|
for details.
|
2252
2252
|
.UNINDENT
|
@@ -2262,14 +2262,14 @@ Used by stage {1}; can be omitted otherwise. If omitted: N/A.
|
|
2262
2262
|
.SS Stage1: Experiment generation
|
2263
2263
|
.INDENT 0.0
|
2264
2264
|
.TP
|
2265
|
-
.B\-\-skip\-sync
|
2265
|
+
.B \-\-skip\-sync
|
2266
2266
|
.INDENT 7.0
|
2267
2267
|
.INDENT 3.5
|
2268
2268
|
If passed, then the generated experiment will not
|
2269
2269
|
be synced to robots. This is useful when:
|
2270
2270
|
.INDENT 0.0
|
2271
2271
|
.IP \(bu 2
|
2272
|
-
You are developing your Project and
|
2272
|
+
You are developing your \fI\%Project\fP and
|
2273
2273
|
just want to check locally if the experiment
|
2274
2274
|
is being generated properly.
|
2275
2275
|
.IP \(bu 2
|
@@ -2305,11 +2305,11 @@ usage: SIERRA [\-\-exec\-inter\-run\-pause SECONDS] [\-\-exec\-resume]
|
|
2305
2305
|
.SS Stage2: Experiment executionFor running real robot experiments
|
2306
2306
|
.INDENT 0.0
|
2307
2307
|
.TP
|
2308
|
-
.B\-\-exec\-inter\-run\-pause
|
2308
|
+
.B \-\-exec\-inter\-run\-pause
|
2309
2309
|
.INDENT 7.0
|
2310
2310
|
.INDENT 3.5
|
2311
|
-
How long to pause between Experimental
|
2312
|
-
Runs, giving you time to
|
2311
|
+
How long to pause between \fI\%Experimental
|
2312
|
+
Runs\fP, giving you time to
|
2313
2313
|
reset the environment, move robots, etc.
|
2314
2314
|
.UNINDENT
|
2315
2315
|
.UNINDENT
|
@@ -2323,7 +2323,7 @@ Used by stage {2}; can be omitted otherwise. If omitted: N/A.
|
|
2323
2323
|
.sp
|
2324
2324
|
Default: 60
|
2325
2325
|
.TP
|
2326
|
-
.B\-\-exec\-resume
|
2326
|
+
.B \-\-exec\-resume
|
2327
2327
|
.INDENT 7.0
|
2328
2328
|
.INDENT 3.5
|
2329
2329
|
Resume a batch experiment that was
|