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
{sierra_research-1.3.1.data → sierra_research-1.3.6.data}/data/share/man/man7/sierra-usage.7
RENAMED
@@ -1,8 +1,5 @@
|
|
1
1
|
.\" Man page generated from reStructuredText.
|
2
2
|
.
|
3
|
-
.TH "SIERRA-USAGE" "7" "Jan 25, 2023" "1.3.1" "SIERRA"
|
4
|
-
.SH NAME
|
5
|
-
sierra-usage \- How to use SIERRA. This covers all non-command line interface aspects.
|
6
3
|
.
|
7
4
|
.nr rst2man-indent-level 0
|
8
5
|
.
|
@@ -30,8 +27,11 @@ 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-USAGE" "7" "Apr 01, 2024" "1.3.6" "SIERRA"
|
31
|
+
.SH NAME
|
32
|
+
sierra-usage \- How to use SIERRA. This covers all non-command line interface aspects.
|
33
33
|
.sp
|
34
|
-
This covers everything which is (mostly) Platform independent and is not
|
34
|
+
This covers everything which is (mostly) \fI\%Platform\fP independent and is not
|
35
35
|
the command line interface.
|
36
36
|
.SH SIERRA PIPELINE
|
37
37
|
.sp
|
@@ -46,21 +46,21 @@ express this as a research query on the command line, and then parses your query
|
|
46
46
|
to make changes to a template input file to generate launch commands and
|
47
47
|
experimental inputs to operationalize it. Switching from targeting platform A
|
48
48
|
(e.g., ARGoS) to platform B (e.g., ROS1+Gazebo) is as easy as changing a single
|
49
|
-
command line argument. SIERRA handles the
|
49
|
+
command line argument. SIERRA handles the \(dqbackend\(dq aspects of defining
|
50
50
|
experimental inputs allowing you to focus on their \fIcontent\fP, rather than the
|
51
51
|
mechanics of how to turn the content into something that can be executed. See
|
52
52
|
also:
|
53
53
|
.INDENT 0.0
|
54
54
|
.IP \(bu 2
|
55
|
-
|
55
|
+
\fI\%SIERRA Support Matrix\fP
|
56
56
|
.IP \(bu 2
|
57
|
-
|
57
|
+
\fI\%Command Line Interface\fP
|
58
58
|
.UNINDENT
|
59
59
|
.sp
|
60
60
|
Part of default pipeline.
|
61
61
|
.SS Stage 2: Experiment Execution
|
62
62
|
.sp
|
63
|
-
SIERRA runs a previously generated Batch Experiment\&. Exactly which batch
|
63
|
+
SIERRA runs a previously generated \fI\%Batch Experiment\fP\&. Exactly which batch
|
64
64
|
experiment SIERRA runs is determined by:
|
65
65
|
.INDENT 0.0
|
66
66
|
.IP \(bu 2
|
@@ -82,11 +82,11 @@ to stage 1, switching between execution environments is as easy as changing a
|
|
82
82
|
single command line argument. See also:
|
83
83
|
.INDENT 0.0
|
84
84
|
.IP \(bu 2
|
85
|
-
|
85
|
+
\fI\%Execution Environment Plugins\fP
|
86
86
|
.IP \(bu 2
|
87
|
-
|
87
|
+
\fI\%Platform Plugins\fP
|
88
88
|
.IP \(bu 2
|
89
|
-
|
89
|
+
\fI\%SIERRA Support Matrix\fP
|
90
90
|
.UNINDENT
|
91
91
|
.sp
|
92
92
|
Part of default pipeline.
|
@@ -100,11 +100,11 @@ includes one or more of:
|
|
100
100
|
.INDENT 0.0
|
101
101
|
.IP \(bu 2
|
102
102
|
Computing statistics over/about experimental data for stage 4 for use in graph
|
103
|
-
generation in stage 4. See
|
103
|
+
generation in stage 4. See \fI\%Command Line Interface\fP documentation for
|
104
104
|
\fB\-\-dist\-stats\fP for details.
|
105
105
|
.IP \(bu 2
|
106
106
|
Creating images from project CSV files for rendering in stage 4. See
|
107
|
-
|
107
|
+
\fI\%Project Rendering\fP for details.
|
108
108
|
.UNINDENT
|
109
109
|
.sp
|
110
110
|
Part of default pipeline.
|
@@ -128,8 +128,8 @@ SIERRA also has a rich model framework allowing you to run arbitrary models,
|
|
128
128
|
generate data, and plot it on the same figure as empirical results,
|
129
129
|
automatically. See ln\-sierra\-tutorials\-project\-models for details.
|
130
130
|
.sp
|
131
|
-
For some examples, see the
|
132
|
-
\fI\%2022 AAMAS Demo\fP <\fBhttps://www-users.cse.umn.edu/~harwe006/showcase/aamas-2022-demo\fP>\&. See
|
131
|
+
For some examples, see the \(dqGenerating Deliverables\(dq section of
|
132
|
+
\fI\%2022 AAMAS Demo\fP <\fBhttps://www-users.cse.umn.edu/~harwe006/showcase/aamas-2022-demo\fP>\&. See \fI\%Rendering\fP for details about
|
133
133
|
rendering capabilities.
|
134
134
|
.sp
|
135
135
|
Part of default pipeline.
|
@@ -142,19 +142,19 @@ can be used to compare:
|
|
142
142
|
.INDENT 0.0
|
143
143
|
.IP \(bu 2
|
144
144
|
Different agent control algorithms which have all been run in the same
|
145
|
-
\fB\-\-scenario\fP\&. See
|
145
|
+
\fB\-\-scenario\fP\&. See \fI\%Intra\-Scenario Comparison\fP for details.
|
146
146
|
.IP \(bu 2
|
147
147
|
A single \fB\-\-controller\fP across multiple scenarios. See
|
148
|
-
|
148
|
+
\fI\%Inter\-Scenario Comparison\fP for details.
|
149
149
|
.UNINDENT
|
150
150
|
.sp
|
151
151
|
Not part of default pipeline.
|
152
152
|
.SH PIPELINE STAGE 5
|
153
153
|
.sp
|
154
|
-
The main idea of this pipeline stage is to
|
155
|
-
Summary .csv files present in different Batch Experiments into a Inter\-Batch .csv file, and then use that file to
|
156
|
-
generate graphs. Any Summary .csv that is present in multiple
|
157
|
-
Batch Experiments can be used during stage 5! This
|
154
|
+
The main idea of this pipeline stage is to \(dqcollate\(dq the results of one or more
|
155
|
+
\fI\%Summary .csv\fP files present in different \fI\%Batch Experiments\fP into a \fI\%Inter\-Batch .csv\fP file, and then use that file to
|
156
|
+
generate graphs. Any \fI\%Summary .csv\fP that is present in multiple
|
157
|
+
\fI\%Batch Experiments\fP can be used during stage 5! This
|
158
158
|
gives this pipeline stage tremendous flexibility as a camera\-ready graph
|
159
159
|
generation tool.
|
160
160
|
.sp
|
@@ -166,7 +166,7 @@ SIERRA invocation), because the options are quite different, but you don\(aqt
|
|
166
166
|
.INDENT 0.0
|
167
167
|
.INDENT 3.5
|
168
168
|
You \fIcannot\fP use this stage before successfully running stage 4
|
169
|
-
for each of the Batch Experiments you
|
169
|
+
for each of the \fI\%Batch Experiments\fP you
|
170
170
|
want to include on the final graph.
|
171
171
|
.UNINDENT
|
172
172
|
.UNINDENT
|
@@ -180,7 +180,7 @@ controllers in a single scenario (for example) could result in
|
|
180
180
|
linegraphs containing 3,6,9,..., lines with duplicated data. In
|
181
181
|
general, you want to delete the directories generated by stage 5
|
182
182
|
between successive runs. See
|
183
|
-
|
183
|
+
\fI\%SIERRA Runtime Directory Tree\fP for details on what
|
184
184
|
directories are generated.
|
185
185
|
.UNINDENT
|
186
186
|
.UNINDENT
|
@@ -188,7 +188,7 @@ directories are generated.
|
|
188
188
|
.sp
|
189
189
|
Intra\-scenario comparison compares the of experiments using one or more
|
190
190
|
controllers on the same \fB\-\-scenario\fP\&. To use it, you need to pass the
|
191
|
-
following options to SIERRA (see
|
191
|
+
following options to SIERRA (see \fI\%Command Line Interface\fP for documentation):
|
192
192
|
.INDENT 0.0
|
193
193
|
.IP \(bu 2
|
194
194
|
\fB\-\-scenario\-comparison\fP
|
@@ -208,7 +208,7 @@ ln\-sierra\-tutorials\-project\-stage5\-config\-intra\&.
|
|
208
208
|
.sp
|
209
209
|
Inter\-scenario comparison compares the same \fB\-\-controller\fP across multiple
|
210
210
|
\fB\-\-scenarios\fP\&. To use it, you need to pass the following options to SIERRA
|
211
|
-
when running stage 5 (see
|
211
|
+
when running stage 5 (see \fI\%Command Line Interface\fP for documentation):
|
212
212
|
.INDENT 0.0
|
213
213
|
.IP \(bu 2
|
214
214
|
\fB\-\-controller\-comparison\fP
|
@@ -297,18 +297,18 @@ for a previously used project on subsequent runs.
|
|
297
297
|
project root, which is \fBNOT\fP deleted on subsequent runs.
|
298
298
|
.INDENT 2.0
|
299
299
|
.IP \(bu 2
|
300
|
-
\fBmytemplate\-SS.12x6\fP \- The directory for the Batch Experiment
|
300
|
+
\fBmytemplate\-SS.12x6\fP \- The directory for the \fI\%Batch Experiment\fP
|
301
301
|
is named from a combination of the template input file used
|
302
302
|
(\fB\-\-template\-input\-file\fP) and the scenario (\fB\-\-scenario\fP).
|
303
303
|
.INDENT 2.0
|
304
304
|
.IP \(bu 2
|
305
|
-
\fBexp\-inputs\fP \- Root directory for Experimental
|
305
|
+
\fBexp\-inputs\fP \- Root directory for \fI\%Experimental\fP
|
306
306
|
inputs; each experiment in the batch gets their own directory in here.
|
307
307
|
.INDENT 2.0
|
308
308
|
.IP \(bu 2
|
309
309
|
\fBexp0\fP \- Within the input directory for each experiment in the
|
310
310
|
batch (there are 4 such directories in this example), there will be
|
311
|
-
an input file for each Experimental Run in the experiment,
|
311
|
+
an input file for each \fI\%Experimental Run\fP in the experiment,
|
312
312
|
as well as a \fBcommands.txt\fP used by GNU parallel to run them all
|
313
313
|
in parallel. The leaf of the \fB\-\-template\-input\-file\fP, sans
|
314
314
|
extension, has the experimental run # appended to it
|
@@ -401,7 +401,7 @@ during stage3 for use during stage4.
|
|
401
401
|
.IP \(bu 2
|
402
402
|
\fB\&...\fP
|
403
403
|
.IP \(bu 2
|
404
|
-
\fBcollated\fP \- Contains Collated .csv files. During
|
404
|
+
\fBcollated\fP \- Contains \fI\%Collated .csv\fP files. During
|
405
405
|
stage4, SIERRA will draw specific columns from .csv files under
|
406
406
|
\fBstatistics\fP according to configuration, and collate them under
|
407
407
|
here for graph generation of \fIinter\fP\-experiment graphs.
|
@@ -416,13 +416,13 @@ HPC clusters.
|
|
416
416
|
outputs which have been converted to graphs) which can be patched
|
417
417
|
together in stage 4 to generated videos. Each experiment will get its
|
418
418
|
own directory under here, with unique sub\-directories for each
|
419
|
-
different type of Experimental Run data captured for
|
420
|
-
imagizing. See
|
419
|
+
different type of \fI\%Experimental Run\fP data captured for
|
420
|
+
imagizing. See \fI\%Project Rendering\fP for more details.
|
421
421
|
.IP \(bu 2
|
422
422
|
\fBvideos\fP \- Root directory for holding rendered videos generated
|
423
423
|
during stage 4 from either captured simulator frames for imagized
|
424
424
|
project files. Each experiment will get its own directory under here,
|
425
|
-
with See
|
425
|
+
with See \fI\%Rendering\fP for more details.
|
426
426
|
.IP \(bu 2
|
427
427
|
\fBmodels\fP \- During stage4, the dataframes generated by all executed
|
428
428
|
models are stored under this directory. Each experiment in the batch
|
@@ -467,7 +467,7 @@ First, the experiment tree for \fIscenario comparison\fP:
|
|
467
467
|
\-\-scenario\-comparison\e
|
468
468
|
\-\-batch\-criteria population_size.Log8\e
|
469
469
|
\-\-scenarios\-list=RN.16x16x2,PL.16x16x2\e
|
470
|
-
\-\-sierra\-root=$HOME/exp
|
470
|
+
\-\-sierra\-root=$HOME/exp\(dq
|
471
471
|
.ft P
|
472
472
|
.fi
|
473
473
|
.UNINDENT
|
@@ -501,7 +501,7 @@ Second, the experiment tree for \fIcontroller comparison\fP
|
|
501
501
|
\-\-controller\-comparison\e
|
502
502
|
\-\-batch\-criteria population_size.Log8\e
|
503
503
|
\-\-controllers\-list d0.CRW,d0.DPO\e
|
504
|
-
\-\-sierra\-root=$HOME/exp
|
504
|
+
\-\-sierra\-root=$HOME/exp\(dq
|
505
505
|
.ft P
|
506
506
|
.fi
|
507
507
|
.UNINDENT
|
@@ -531,26 +531,26 @@ depending on what you are doing.
|
|
531
531
|
.INDENT 0.0
|
532
532
|
.IP \(bu 2
|
533
533
|
\fBparallel\fP \- GNU parallel. Used during stage 2 when running
|
534
|
-
experiments (ARGoS, ROS1+Gazebo, ROS1+Robot platforms).
|
534
|
+
experiments (\fI\%ARGoS\fP, \fI\%ROS1+Gazebo\fP, \fI\%ROS1+Robot\fP platforms).
|
535
535
|
.IP \(bu 2
|
536
536
|
\fBffmpeg\fP \- Used during stage 3 if imagizing is run. See
|
537
|
-
|
537
|
+
\fI\%Platform Visual Capture\fP\&.
|
538
538
|
.IP \(bu 2
|
539
539
|
\fBXvfb\fP \- Used during stage 1 when generating simulation inputs, and
|
540
|
-
during stage 2 when running experiments for the ARGoS
|
541
|
-
Platform\&. See also
|
540
|
+
during stage 2 when running experiments for the \fI\%ARGoS\fP
|
541
|
+
\fI\%Platform\fP\&. See also \fI\%Platform Visual Capture\fP\&.
|
542
542
|
.IP \(bu 2
|
543
543
|
\fBparallel\-ssh\fP \- Used during stage 1 when generating experiments
|
544
|
-
experiments (ROS1+Robot platform).
|
544
|
+
experiments (\fI\%ROS1+Robot\fP platform).
|
545
545
|
.IP \(bu 2
|
546
546
|
\fBparallel\-rsync\fP \- Used during stage 1 when generating experiments
|
547
|
-
experiments (ROS1+Robot platform).
|
547
|
+
experiments (\fI\%ROS1+Robot\fP platform).
|
548
548
|
.UNINDENT
|
549
549
|
.SH ENVIRONMENT VARIABLES
|
550
550
|
.INDENT 0.0
|
551
551
|
.TP
|
552
552
|
.B SIERRA_PLUGIN_PATH
|
553
|
-
Used for locating plugins\&. The directory \fIcontaining\fP a
|
553
|
+
Used for locating \fI\%plugins\fP\&. The directory \fIcontaining\fP a
|
554
554
|
plugin directory outside the SIERRA source tree must be on
|
555
555
|
\fBSIERRA_PLUGIN_PATH\fP\&. Paths are added to \fBPYTHONPATH\fP as needed to load
|
556
556
|
plugins correctly. For example, if you have a different version of the
|
@@ -559,7 +559,7 @@ containing the plugin in \fB$HOME/plugins\fP, then you need to add
|
|
559
559
|
\fB$HOME/plugins\fP to your \fBSIERRA_PLUGIN_PATH\fP to so that SIERRA will find
|
560
560
|
it. This variable is used in stages 1\-5.
|
561
561
|
.sp
|
562
|
-
Used for locating projects; all projects specifiable with
|
562
|
+
Used for locating \fI\%projects\fP; all projects specifiable with
|
563
563
|
\fB\-\-project\fP are directories found within the directories on this path. For
|
564
564
|
example, if you have a project \fB$HOME/git/projects/myproject\fP, then
|
565
565
|
\fB$HOME/git\fP must be on \fBSIERRA_PLUGIN_PATH\fP in order for you to be able
|
@@ -581,9 +581,9 @@ Must be set to contain the library directory where you installed/built ARGoS,
|
|
581
581
|
as well as the library directory for your project \fB\&.so\fP\&. Checked to be
|
582
582
|
non\-empty before running stage 2 for all \fB\-\-exec\-env\fP plugins. SIERRA does
|
583
583
|
\fInot\fP modify this variable, so it needs to be setup properly prior to
|
584
|
-
invoking SIERRA (i.e., the directory containing the Project \fB\&.so\fP
|
584
|
+
invoking SIERRA (i.e., the directory containing the \fI\%Project\fP \fB\&.so\fP
|
585
585
|
file needs to be on it). SIERRA can\(aqt know, in general, where the location of
|
586
|
-
the C++ code corresponding to the loaded Project is.
|
586
|
+
the C++ code corresponding to the loaded \fI\%Project\fP is.
|
587
587
|
.UNINDENT
|
588
588
|
.INDENT 0.0
|
589
589
|
.TP
|
@@ -617,7 +617,7 @@ defined and \fB\-\-nodefile\fP is not passed SIERRA will throw an error.
|
|
617
617
|
.TP
|
618
618
|
.B PARALLEL
|
619
619
|
When running on some execution environments, such as \fBhpc.slurm,hpc.pbs\fP,
|
620
|
-
any and all environment variables needed by your Project should be
|
620
|
+
any and all environment variables needed by your \fI\%Project\fP should be
|
621
621
|
exported via the \fBPARALLEL\fP environment variable before invoking SIERRA,
|
622
622
|
because GNU parallel does not export the environment of the node it is
|
623
623
|
launched from to slave nodes (or even on the local machine). Something like:
|
@@ -626,7 +626,7 @@ launched from to slave nodes (or even on the local machine). Something like:
|
|
626
626
|
.sp
|
627
627
|
.nf
|
628
628
|
.ft C
|
629
|
-
export PARALLEL
|
629
|
+
export PARALLEL=\(dq\-\-workdir . \e
|
630
630
|
\-\-env PATH \e
|
631
631
|
\-\-env LD_LIBRARY_PATH \e
|
632
632
|
\-\-env LOADEDMODULES \e
|
@@ -644,19 +644,19 @@ export PARALLEL="\-\-workdir . \e
|
|
644
644
|
\-\-env OMP_THREAD_LIMIT \e
|
645
645
|
\-\-env OMP_WAIT_POLICY \e
|
646
646
|
\-\-env SIERRA_ARCH \e
|
647
|
-
\-\-env SIERRA_PLUGIN_PATH
|
647
|
+
\-\-env SIERRA_PLUGIN_PATH\(dq
|
648
648
|
.ft P
|
649
649
|
.fi
|
650
650
|
.UNINDENT
|
651
651
|
.UNINDENT
|
652
652
|
.sp
|
653
653
|
Don\(aqt forget to include \fI\%ARGOS_PLUGIN_PATH\fP,
|
654
|
-
\fI\%ROS_PACKAGE_PATH\fP, etc., depending on your chosen Platform\&.
|
654
|
+
\fI\%ROS_PACKAGE_PATH\fP, etc., depending on your chosen \fI\%Platform\fP\&.
|
655
655
|
.UNINDENT
|
656
656
|
.INDENT 0.0
|
657
657
|
.TP
|
658
658
|
.B PARALLEL_SHELL
|
659
|
-
SIERRA sets up the Experiment execution environments by running one
|
659
|
+
SIERRA sets up the \fI\%Experiment\fP execution environments by running one
|
660
660
|
or more shell commands in a subprocess (treated as a \fBshell\fP, which means
|
661
661
|
that \fBparallel\fP can\(aqt determine \fBSHELL\fP, and therefore defaults to
|
662
662
|
\fB/bin/sh\fP, which is not what users expect. SIERRA explicitly sets
|
@@ -673,7 +673,7 @@ script).
|
|
673
673
|
.UNINDENT
|
674
674
|
.SH CONFIGURABLE SIERRA VARIABLES
|
675
675
|
.sp
|
676
|
-
Non
|
676
|
+
Non\-\fI\%Batch Criteria\fP variables which you can use to configure
|
677
677
|
simulations. All batch criteria are variables, but not all variables are batch
|
678
678
|
criteria.
|
679
679
|
.INDENT 0.0
|
@@ -682,9 +682,9 @@ criteria.
|
|
682
682
|
.UNINDENT
|
683
683
|
.SS Experiment Setup
|
684
684
|
.sp
|
685
|
-
Configure Experiment time: length, controller cadence (Tick
|
686
|
-
duration/timestep), and how many datapoints to capture per Experimental
|
687
|
-
Run\&.
|
685
|
+
Configure \fI\%Experiment\fP time: length, controller cadence (\fI\%Tick\fP
|
686
|
+
duration/timestep), and how many datapoints to capture per \fI\%Experimental
|
687
|
+
Run\fP\&.
|
688
688
|
.SS Cmdline Syntax
|
689
689
|
.sp
|
690
690
|
\fBT{duration}[.K{ticks_per_sec}][.N{n_datapoints}\fP
|
@@ -694,11 +694,11 @@ Run\&.
|
|
694
694
|
.IP \(bu 2
|
695
695
|
\fBticks_per_sec\fP \- How many times each controller will be run per second.
|
696
696
|
.IP \(bu 2
|
697
|
-
\fBn_datapoints\fP \- # datapoints per Experimental Run to be captured;
|
697
|
+
\fBn_datapoints\fP \- # datapoints per \fI\%Experimental Run\fP to be captured;
|
698
698
|
the capture interval (if configurable) should be adjusted in
|
699
|
-
Project\-derived class from the platform
|
699
|
+
\fI\%Project\fP\-derived class from the platform \(dqExperiment setup class\(dq
|
700
700
|
(e.g., \fBsierra.plugins.platform.argos.variables.exp_setup.ExpSetup\fP for
|
701
|
-
ARGoS).
|
701
|
+
\fI\%ARGoS\fP).
|
702
702
|
.UNINDENT
|
703
703
|
.SS Examples
|
704
704
|
.INDENT 0.0
|
@@ -1,8 +1,5 @@
|
|
1
1
|
.\" Man page generated from reStructuredText.
|
2
2
|
.
|
3
|
-
.TH "SIERRA" "7" "Jan 25, 2023" "1.3.1" "SIERRA"
|
4
|
-
.SH NAME
|
5
|
-
sierra \- reSearch pIpEline for Reproducability, Reusability, and Automation.
|
6
3
|
.
|
7
4
|
.nr rst2man-indent-level 0
|
8
5
|
.
|
@@ -30,9 +27,12 @@ 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" "7" "Apr 01, 2024" "1.3.6" "SIERRA"
|
31
|
+
.SH NAME
|
32
|
+
sierra \- reSearch pIpEline for Reproducability, Reusability, and Automation.
|
33
33
|
.SH SYNOPSIS
|
34
34
|
.sp
|
35
|
-
This the
|
35
|
+
This the \(dqmain menu\(dq of the SIERRA reference manual, which captures most, but
|
36
36
|
not all of its documentation. For the full experience, look at the online docs
|
37
37
|
at \fI\%https://sierra.readthedocs.io/en/master\fP\&.
|
38
38
|
.SH COMPONENTS
|
@@ -65,7 +65,7 @@ execution before proceeding to the next step. SIERRA should rarely crash with a
|
|
65
65
|
cryptic interpreter error message/exception, but if it does, please report it so
|
66
66
|
I can fix it and/or create a better error message.
|
67
67
|
.sp
|
68
|
-
Errors should be reported to \fI\%https://github.com
|
68
|
+
Errors should be reported to \fI\%https://github.com/jharwell/sierra\fP\&.
|
69
69
|
.SH RETURN VALUE
|
70
70
|
.sp
|
71
71
|
SIERRA will always return 0, unless it crashes with an exception or a failed
|
@@ -1,6 +1,6 @@
|
|
1
1
|
Metadata-Version: 2.1
|
2
2
|
Name: sierra-research
|
3
|
-
Version: 1.3.
|
3
|
+
Version: 1.3.6
|
4
4
|
Summary: Automation framework for the scientific method in AI research
|
5
5
|
Home-page: https://github.com/jharwell/sierra
|
6
6
|
Author: John Harwell
|
@@ -35,12 +35,13 @@ Requires-Dist: coloredlogs
|
|
35
35
|
Requires-Dist: implements
|
36
36
|
Requires-Dist: retry
|
37
37
|
Provides-Extra: devel
|
38
|
-
Requires-Dist: pylint
|
38
|
+
Requires-Dist: pylint ==2.14.5 ; extra == 'devel'
|
39
39
|
Requires-Dist: pytype ; extra == 'devel'
|
40
40
|
Requires-Dist: pydocstyle ; extra == 'devel'
|
41
41
|
Requires-Dist: xenon ; extra == 'devel'
|
42
42
|
Requires-Dist: flake8 ; extra == 'devel'
|
43
43
|
Requires-Dist: nox ; extra == 'devel'
|
44
|
+
Requires-Dist: psutil ; extra == 'devel'
|
44
45
|
Requires-Dist: pytest ; extra == 'devel'
|
45
46
|
Requires-Dist: pytest-cov ; extra == 'devel'
|
46
47
|
Requires-Dist: mypy ; extra == 'devel'
|
@@ -51,8 +52,8 @@ Requires-Dist: mypy-runner ; extra == 'devel'
|
|
51
52
|
Requires-Dist: build ; extra == 'devel'
|
52
53
|
Requires-Dist: twine ; extra == 'devel'
|
53
54
|
Requires-Dist: setuptools ; extra == 'devel'
|
54
|
-
Requires-Dist: sphinx ; extra == 'devel'
|
55
|
-
Requires-Dist: docutils
|
55
|
+
Requires-Dist: sphinx ==5.0.2 ; extra == 'devel'
|
56
|
+
Requires-Dist: docutils ==0.18.1 ; extra == 'devel'
|
56
57
|
Requires-Dist: sphinx-rtd-theme ; extra == 'devel'
|
57
58
|
Requires-Dist: sphinx-argparse ; extra == 'devel'
|
58
59
|
Requires-Dist: sphinx-tabs ; extra == 'devel'
|
@@ -74,8 +75,8 @@ SIERRA (reSearch pIpEline for Reproducibility, Reusability, and Automation)
|
|
74
75
|
.. |supported-pythons| image:: https://img.shields.io/pypi/pyversions/sierra-research.svg
|
75
76
|
:target: https://pypi.python.org/pypi/sierra-research/
|
76
77
|
|
77
|
-
.. |linux-supported| image:: https://
|
78
|
-
.. |osx-supported| image:: https://
|
78
|
+
.. |linux-supported| image:: https://img.shields.io/badge/os-Linux-crimson
|
79
|
+
.. |osx-supported| image:: https://img.shields.io/badge/os-OSX-crimson
|
79
80
|
|
80
81
|
.. |ci-integration-master| image:: https://github.com/jharwell/sierra/actions/workflows/integration-all.yml/badge.svg?branch=master
|
81
82
|
.. |ci-analysis-master| image:: https://github.com/jharwell/sierra/actions/workflows/static-analysis.yml/badge.svg?branch=master
|
@@ -1,19 +1,19 @@
|
|
1
1
|
sierra/__init__.py,sha256=LrL9-6GqsT0Lvo6jb54x4m-DL1NywTXG8JKSrYis7Xo,186
|
2
|
-
sierra/main.py,sha256=
|
3
|
-
sierra/version.py,sha256=
|
2
|
+
sierra/main.py,sha256=K46LsG16cSqTMfNiT3vSSF3SLh5BjAUPVqPjZ6A2Oxs,6618
|
3
|
+
sierra/version.py,sha256=1DltYoYdHXaHmjq1Ls8zc6SRe9FsSFUWsC4fE8J1yI8,243
|
4
4
|
sierra/core/__init__.py,sha256=IwACyV8LoLuIx3TBzC6WdcRTq9D-0GO7nguLxY64QbI,188
|
5
5
|
sierra/core/cmdline.py,sha256=j9eAStCFolUyzvUSzqeRE1BNgtxDTgaYqDiaTTYFUBQ,58191
|
6
|
-
sierra/core/config.py,sha256=
|
6
|
+
sierra/core/config.py,sha256=zezJgparLsD4HtgfzPvlxmwBX-6X3Ntdq2kkMlxvFQs,4562
|
7
7
|
sierra/core/logging.py,sha256=jq_bryJDLeMfzsRsWkDpQI20HvOJqd3b14Ank9a-1DI,985
|
8
8
|
sierra/core/platform.py,sha256=jOlm4PVPNp9EPjtckaYR66t5p6A4fQwBxmjZoFCHz-o,17359
|
9
9
|
sierra/core/plugin.py,sha256=Bc4n1_Q5VvorAsbwt76K6cZmSrU-f0m2tNyQSWXYsOE,3500
|
10
10
|
sierra/core/plugin_manager.py,sha256=PB5AmPpjcl9ct-F8_x_tVwRioOLjHD0Vp66rQtkLrVc,12535
|
11
11
|
sierra/core/root_dirpath_generator.py,sha256=pEJd_9a_eWSWLHPDv4fd-HWnbB0MPZG9c_ukXe3xl3k,8173
|
12
|
-
sierra/core/startup.py,sha256=
|
12
|
+
sierra/core/startup.py,sha256=raE4kgNarzcDIDlgw2cHFenH3_qJJehEq4kBCE4Rnpk,5422
|
13
13
|
sierra/core/stat_kernels.py,sha256=wBTWEXw2XvdSfxghNlhUbKkn1XjgTP7_d0OBM6lUvWE,6030
|
14
14
|
sierra/core/storage.py,sha256=VJ5IqNM_grOMYH5vq6bI5EO4muySERaj4TI-Ngzny6w,1300
|
15
15
|
sierra/core/types.py,sha256=R5gW2u9nBPHJJ7HdliFzq999SwvWgYzPGX0tlyWAiWQ,2049
|
16
|
-
sierra/core/utils.py,sha256=
|
16
|
+
sierra/core/utils.py,sha256=KsgUnsG7npKGnkYkcIQqnD_vAmRcrdfnMiU4rcGCn1s,12464
|
17
17
|
sierra/core/vector.py,sha256=wVCoOU7rS7hYpmiOElh0RAF6xlKRuDr7fBD13ykpkys,3843
|
18
18
|
sierra/core/experiment/__init__.py,sha256=6b7RQQobZUX1hRmfmq_bZ3KovuTKeBYNLWwEG_axTxQ,145
|
19
19
|
sierra/core/experiment/bindings.py,sha256=6BSg3Li5D1ZWRxxPSXJYZ8TQlGwIfQupxbLSceTs7Pg,10152
|
@@ -28,27 +28,27 @@ sierra/core/generators/generator_factory.py,sha256=Os_kkW76XEoC5OyoOeGNQFHbRaNP9
|
|
28
28
|
sierra/core/graphs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
29
29
|
sierra/core/graphs/heatmap.py,sha256=ehpdpnsFJiJgfdNQA2FyqwTYrn7f4cu6B3fwJ1jkppc,12218
|
30
30
|
sierra/core/graphs/scatterplot2D.py,sha256=boUvsHbN5dJYyKsrm5eRSvW2T6_xi3fmYFVu-mjhmnY,3685
|
31
|
-
sierra/core/graphs/stacked_line_graph.py,sha256=
|
31
|
+
sierra/core/graphs/stacked_line_graph.py,sha256=pXyCDCP3YOv-A3skl4dCPWNKF8SzQ76Wup80xdClw6I,9125
|
32
32
|
sierra/core/graphs/stacked_surface_graph.py,sha256=XH35cVtoqaF2hRv_TrjlF0F4GsP1DO_Fw35MdEGCai8,8125
|
33
33
|
sierra/core/graphs/summary_line_graph.py,sha256=G7w7_kTXevB5aw4o6BfRE3tTNBYCbfCrlZHfxh7eCa4,13573
|
34
34
|
sierra/core/hpc/__init__.py,sha256=IG0EW-YZRtbyq01-G62wdgzI5hZ9OBqEbC1-QQhJFsI,167
|
35
35
|
sierra/core/hpc/cmdline.py,sha256=wtnI0C__i6eKLrj8O5j5jNreSRBFp75xlkd35NeaciU,5186
|
36
36
|
sierra/core/models/__init__.py,sha256=uAPXNomKYGVVsvnhTSpSrltW0S3TqRj6dOvVvd8SXcc,168
|
37
|
-
sierra/core/models/graphs.py,sha256=
|
37
|
+
sierra/core/models/graphs.py,sha256=sf_W-wv0HW2PspEq8FUNFcOi2esjQS0qMZcqA9tccLk,3330
|
38
38
|
sierra/core/models/interface.py,sha256=ot342yAWY_xNj6JdcK5e3hH1xmc879FDS2n89WnIX3s,6729
|
39
39
|
sierra/core/pipeline/__init__.py,sha256=Ag1cASFvJ805yvo2No1nP5u4tiy0fUrAiKHZpLyaltg,271
|
40
40
|
sierra/core/pipeline/pipeline.py,sha256=ojmV1GXXHhW6vfryboGJpOMjuUr4nD-nJ8vtT36b3tI,7487
|
41
41
|
sierra/core/pipeline/stage1/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
42
42
|
sierra/core/pipeline/stage1/pipeline_stage1.py,sha256=g2z557US9N57I2XEIDJAxJIpO0w0t3N0-ZjqFDk7NJU,3304
|
43
43
|
sierra/core/pipeline/stage2/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
44
|
-
sierra/core/pipeline/stage2/exp_runner.py,sha256=
|
44
|
+
sierra/core/pipeline/stage2/exp_runner.py,sha256=D7wtwdR4vkTYI1oXuMsJ8NiQfhZ9Alhuqkix04KEiz8,10734
|
45
45
|
sierra/core/pipeline/stage2/pipeline_stage2.py,sha256=Z_Ao0bib-zj5MSJ7fGcQiGJ-f5QzQVlIzdEeqMMGNiU,1260
|
46
46
|
sierra/core/pipeline/stage3/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
47
|
-
sierra/core/pipeline/stage3/imagizer.py,sha256=
|
47
|
+
sierra/core/pipeline/stage3/imagizer.py,sha256=BspVVNc7VhCNkt_jGXpFFaSlLr7bvSQiaN1rHXhxoWY,5094
|
48
48
|
sierra/core/pipeline/stage3/pipeline_stage3.py,sha256=lpBugfd-uASYqE1PgOiDIpVI4GcpCPnO6D_AkBIKZW8,4572
|
49
49
|
sierra/core/pipeline/stage3/run_collator.py,sha256=olq8wUiBWv4uK0mX2mo2siClt97vV2pxkfeDa_fTX1M,12585
|
50
50
|
sierra/core/pipeline/stage3/statistics_calculator.py,sha256=uFuGW18LnHUKn9tfm8PveB8PGETbWRwvkzFz0EXCmlg,18186
|
51
|
-
sierra/core/pipeline/stage4/__init__.py,sha256=
|
51
|
+
sierra/core/pipeline/stage4/__init__.py,sha256=ttj4q54PLfuUQfrwH6Pnl7z289sDpQlpU_3jSvJVw5g,80
|
52
52
|
sierra/core/pipeline/stage4/graph_collator.py,sha256=yVeu9Tr0pdq1iGnPO5IUVun3nI1r6-Hnd1rrdMIISPo,12042
|
53
53
|
sierra/core/pipeline/stage4/inter_exp_graph_generator.py,sha256=GWFqivwyteL5qVIR8Ta5oJv-zecHb_RqPAU6EYRSC1k,9591
|
54
54
|
sierra/core/pipeline/stage4/intra_exp_graph_generator.py,sha256=zdpR7l6jUNKJdOKkCrkbLMrYS3MEBOcwPMOOfB8lMyY,13814
|
@@ -118,16 +118,16 @@ sierra/plugins/robot/turtlebot3/plugin.py,sha256=r7TSnboGUI5cCqT_ty1X9KVJ770pMcP
|
|
118
118
|
sierra/plugins/storage/__init__.py,sha256=6b7RQQobZUX1hRmfmq_bZ3KovuTKeBYNLWwEG_axTxQ,145
|
119
119
|
sierra/plugins/storage/csv/__init__.py,sha256=6b7RQQobZUX1hRmfmq_bZ3KovuTKeBYNLWwEG_axTxQ,145
|
120
120
|
sierra/plugins/storage/csv/plugin.py,sha256=EnFIAmeEpAcVUlbuGG3I3sdb9AVO5zg4k2pa2C1dLFM,938
|
121
|
-
sierra_research-1.3.
|
122
|
-
sierra_research-1.3.
|
123
|
-
sierra_research-1.3.
|
124
|
-
sierra_research-1.3.
|
125
|
-
sierra_research-1.3.
|
126
|
-
sierra_research-1.3.
|
127
|
-
sierra_research-1.3.
|
128
|
-
sierra_research-1.3.
|
129
|
-
sierra_research-1.3.
|
130
|
-
sierra_research-1.3.
|
131
|
-
sierra_research-1.3.
|
132
|
-
sierra_research-1.3.
|
133
|
-
sierra_research-1.3.
|
121
|
+
sierra_research-1.3.6.data/data/share/man/man1/sierra-cli.1,sha256=xs9CghWYI3w29zeeCk5aBcth0omqLyB50UqULPb7vLY,54484
|
122
|
+
sierra_research-1.3.6.data/data/share/man/man7/sierra-examples.7,sha256=4bqHRleirUTfjregCbaic_JzASrndk12MRlIuN3htaQ,17969
|
123
|
+
sierra_research-1.3.6.data/data/share/man/man7/sierra-exec-envs.7,sha256=9NzoKY9hptKREts3pZgq0fCJqrLW6CK1QcowRN_ey-c,7789
|
124
|
+
sierra_research-1.3.6.data/data/share/man/man7/sierra-glossary.7,sha256=hsiqUZADQSQS9Dig4n_pP_wC8ibH3_1AqO0c8F8aGFM,10868
|
125
|
+
sierra_research-1.3.6.data/data/share/man/man7/sierra-platforms.7,sha256=yFoLDBl99G_aRD71PYLew5uwglh6FjXSfw-wQ4sv1Ww,13871
|
126
|
+
sierra_research-1.3.6.data/data/share/man/man7/sierra-usage.7,sha256=cUkiTlpDxuLjIcM5QJfR39iX08AGdom8MmJmcqPEOTk,24725
|
127
|
+
sierra_research-1.3.6.data/data/share/man/man7/sierra.7,sha256=sci8lek0-vEbDRce8ZagtMY9pIbU1wUdudD0xiYvqQM,2478
|
128
|
+
sierra_research-1.3.6.dist-info/LICENSE,sha256=syQ7e-OEgTREA-x8XbHp8x4CIj7LR1-_cwicIfKGWcg,1052
|
129
|
+
sierra_research-1.3.6.dist-info/METADATA,sha256=ll2CYzxeFw68RKYke_H_JjnV_9WSnRzmbUATn6M_c9A,16914
|
130
|
+
sierra_research-1.3.6.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
|
131
|
+
sierra_research-1.3.6.dist-info/entry_points.txt,sha256=3FhShoQcDSf17edEyA6qcO1YwGrZ5kuayu2iVG5npXY,48
|
132
|
+
sierra_research-1.3.6.dist-info/top_level.txt,sha256=cDP7dDWAyFL7fK11L89hCUHy9-G267wuHeVLVR4pTX4,7
|
133
|
+
sierra_research-1.3.6.dist-info/RECORD,,
|
File without changes
|
File without changes
|
File without changes
|