Project

General

Profile

User guide » History » Version 66

Herbert Greenlee, 01/16/2015 11:11 AM

1 1 Herbert Greenlee
{{toc}}
2 1 Herbert Greenlee
3 1 Herbert Greenlee
h1. Overview
4 1 Herbert Greenlee
5 4 Herbert Greenlee
Larsoft common batch and workflow tools are contained in ups product @larbatch@ (this redmine), which is built and distributed as part of @larsoft@.  Larbatch tools are built on top of Fermilab @jobsub_client@ batch submission tools.  For general information about jobsub_client and the Fermilab batch system, refer to articles on the "jobsub wiki":https://cdcvs.fnal.gov/redmine/projects/jobsub/wiki and the "fife wiki":https://cdcvs.fnal.gov/redmine/projects/fife/wiki/Getting_Started_on_GPCF.
6 3 Herbert Greenlee
7 3 Herbert Greenlee
No other part of larsoft is dependent on @larbatch@, and @larbatch@ is not setup as a dependent of the @larsoft@ umbrella ups product.  Rather, @larbatch@ is intended to be a dependent of experiment-specific ups products (see [[admin_guide|this article]] for instructions on configuring @larbatch@ for a specific experiment.
8 5 Herbert Greenlee
9 9 Herbert Greenlee
After setting up ups product @larbatch@, several executable scripts and python modules are available on the execution path and python path.  Here is a list of the more important ones.
10 9 Herbert Greenlee
11 11 Herbert Greenlee
* "project.py":https://cdcvs.fnal.gov/redmine/projects/larbatch/repository/revisions/develop/entry/scripts/project.py
12 10 Herbert Greenlee
An executable python script that is the the main entry point for user interation.  More information can be found below.  
13 9 Herbert Greenlee
14 11 Herbert Greenlee
* "project_utilities.py":https://cdcvs.fnal.gov/redmine/projects/larbatch/repository/revisions/develop/entry/python/project_utilities.py
15 10 Herbert Greenlee
A python module, imported by @project.py@, that implements some of the workflow functionality.  End users would not normally interact directly with this module.  However, a significant aspect of @project_utilities.py@ is that is supplies hooks for providing experiment-specific implementations of some functionality, as described in an [[admin_guide#Experiment-specific hooks|accompanying article]] on this wiki.
16 10 Herbert Greenlee
17 11 Herbert Greenlee
* "condor_lar.sh":https://cdcvs.fnal.gov/redmine/projects/larbatch/repository/revisions/develop/entry/scripts/condor_lar.sh
18 10 Herbert Greenlee
The main batch script.  @Condor_lar.sh@ is a general purpose script that manages a single invocation of an art framework program (@lar@ executable).  @Condor_lar.sh@ sets up the run-time environment, fetches input data, interacts with sam, and copies output data.  It is not intended that end users will directly invoke @condor_lar.sh@.  However, one can get a general idea of the features and capabilities of @condor_lar.sh@ by viewing the built-in documentation by typing "@condor_lar.sh -h@, or reading the file header. 
19 12 Herbert Greenlee
20 12 Herbert Greenlee
* "condor_start_project.sh":https://cdcvs.fnal.gov/redmine/projects/larbatch/repository/revisions/develop/entry/scripts/condor_start_project.sh
21 12 Herbert Greenlee
Batch script for starting a sam project.
22 12 Herbert Greenlee
23 12 Herbert Greenlee
* "condor_stop_project.sh":https://cdcvs.fnal.gov/redmine/projects/larbatch/repository/revisions/develop/entry/scripts/condor_stop_project.sh
24 12 Herbert Greenlee
Batch script for stopping a sam project.
25 13 Herbert Greenlee
26 17 Herbert Greenlee
h1. Using @project.py@
27 13 Herbert Greenlee
28 26 Herbert Greenlee
@Project.py@ is used in conjunction with a xml format project definition file (see [[user_guide#Project File Structure|below]]).  The concept of a project, as understood by @project.py@, and as defined by the project definition file, is a multistage linear processing chain involving a specified number of batch workers at each stage.
29 13 Herbert Greenlee
30 56 Herbert Greenlee
h2. Internal documentation
31 56 Herbert Greenlee
32 56 Herbert Greenlee
Refer to header of "project.py":https://cdcvs.fnal.gov/redmine/projects/larbatch/repository/revisions/develop/entry/scripts/project.py or type @"project.py --help"@.  Internal documentation is always kept up to date @project.py@ command line options are changed.
33 56 Herbert Greenlee
34 22 Herbert Greenlee
h2. Use cases
35 22 Herbert Greenlee
36 27 Herbert Greenlee
In a typical invocation of @project.py@, one specifies the project file (via option @--xml@), tha stage name (via option @--stage@), and one or more action options.  Here are some use cases for invoking @project.py@.
37 13 Herbert Greenlee
38 13 Herbert Greenlee
* @project.py -h@ or @project.py --help@
39 13 Herbert Greenlee
Print built-in help (lists all available command line options).
40 13 Herbert Greenlee
41 1 Herbert Greenlee
* @project.py -xh@ or @project.py --xmlhelp@
42 28 Herbert Greenlee
Print built-in xml help (lists all available elements that can be included in project definition file).
43 14 Herbert Greenlee
44 29 Herbert Greenlee
* @project.py --xml xml-name --status@
45 14 Herbert Greenlee
Print global summary status of the project.
46 14 Herbert Greenlee
47 29 Herbert Greenlee
* @project.py --xml xml-name --stage stage-name --submit@
48 14 Herbert Greenlee
Submit batch jobs for specified stage.
49 14 Herbert Greenlee
50 29 Herbert Greenlee
* @project.py --xml xml-name --stage stage-name --check@
51 15 Herbert Greenlee
Check results from specified stage (identifies failed jobs).  This action assumes that the art program produces an artroot output file.  
52 14 Herbert Greenlee
53 29 Herbert Greenlee
* @project.py --xml xml-name --stage stage-name --checkana@
54 15 Herbert Greenlee
Check results from specified stage (identifies failed jobs).  This version of the check action skips some checks done by @--check@ that only make sense if the art program produces an artroot output file.  Use this action to check results from an analyzer-only art program.
55 14 Herbert Greenlee
56 29 Herbert Greenlee
* @project.py --xml xml-name --stage stage-name --makeup@
57 14 Herbert Greenlee
Submit makeup jobs for failed jobs, as identified by a previous @--check@ or @--checkana@ action.
58 14 Herbert Greenlee
59 29 Herbert Greenlee
* @project.py --xml xml-name --stage stage-name --clean@
60 14 Herbert Greenlee
Delete output for the specified stage and later stages.  This option can be combined with @--submit@.
61 14 Herbert Greenlee
62 29 Herbert Greenlee
* @project.py --xml xml-name --stage stage-name --declare@
63 14 Herbert Greenlee
Declare successful artroot files to sam.
64 14 Herbert Greenlee
65 29 Herbert Greenlee
* @project.py --xml xml-name --stage stage-name --upload@
66 14 Herbert Greenlee
Upload successful artroot files to enstore.
67 14 Herbert Greenlee
68 29 Herbert Greenlee
* @project.py --xml xml-name --stage stage-name --define@
69 1 Herbert Greenlee
Create sam dataset definition.
70 1 Herbert Greenlee
71 29 Herbert Greenlee
* @project.py --xml xml-name --stage stage-name --audit@
72 1 Herbert Greenlee
Check the completeness and correctness of a processing stage using sam parentage information.  For this action to work, input and output files must be must be declared to sam.
73 1 Herbert Greenlee
74 1 Herbert Greenlee
h1. Project File Structure
75 26 Herbert Greenlee
76 54 Herbert Greenlee
The general structure of the project file is that it is an XML file that contains a single root element of type "@project@" (enclosed in "@<project name=project-name>...</project>@").  Inside the project element, there are additional subelements, including one or moe stage subelements (enclosed in "@<stage name=stage-name>...</stage>@."  Each stage element defines a group of batch jobs that are submitted together by a single invocation of @jobsub_submit@.
77 15 Herbert Greenlee
78 39 Herbert Greenlee
h2. Examples
79 16 Herbert Greenlee
80 39 Herbert Greenlee
Example XML project files used by microboone from ubutil product can be found "here.":https://cdcvs.fnal.gov/redmine/projects/ubutil/repository/revisions/master/show/xml/mcc5.0
81 1 Herbert Greenlee
82 21 Herbert Greenlee
h2. Internal documentation
83 21 Herbert Greenlee
84 55 Herbert Greenlee
Refer to header of "project.py":https://cdcvs.fnal.gov/redmine/projects/larbatch/repository/revisions/develop/entry/scripts/project.py or type @"project.py --xmlhelp"@.  Internal documentation is always kept up to date when XML constructs are added or changed.
85 21 Herbert Greenlee
86 23 Herbert Greenlee
h2. XML header section
87 1 Herbert Greenlee
88 23 Herbert Greenlee
The initial lines of an XML project file should follow a standard pattern.  Here is a typical example header.
89 1 Herbert Greenlee
90 23 Herbert Greenlee
<pre>
91 23 Herbert Greenlee
<?xml version="1.0"?>
92 23 Herbert Greenlee
<!DOCTYPE project [
93 23 Herbert Greenlee
<!ENTITY release "v02_05_01">
94 23 Herbert Greenlee
<!ENTITY file_type "mc">
95 23 Herbert Greenlee
<!ENTITY run_type "physics">
96 23 Herbert Greenlee
<!ENTITY name "prod_eminus_0.1-2.0GeV_isotropic_uboone">
97 23 Herbert Greenlee
<!ENTITY tag "mcc5.0">
98 23 Herbert Greenlee
]>
99 23 Herbert Greenlee
</pre>
100 23 Herbert Greenlee
101 23 Herbert Greenlee
The significance of the header elements are as follows.
102 23 Herbert Greenlee
103 23 Herbert Greenlee
* The XML version
104 33 Herbert Greenlee
Copy the above version line exactly, namely,
105 32 Herbert Greenlee
<pre>
106 32 Herbert Greenlee
<?xml version="1.0"?>
107 32 Herbert Greenlee
</pre>
108 23 Herbert Greenlee
109 24 Herbert Greenlee
* The document type (DOCTYPE keyword).
110 34 Herbert Greenlee
The argument following the DOCTYPE keyword specifies the "root element" of the XML file, and should always be "@project@."
111 24 Herbert Greenlee
112 24 Herbert Greenlee
* Entity definitions
113 40 Herbert Greenlee
Entity definitions, which occur inside the DOCTYPE section, are XML aliases.  Any string that occurs repeatedly inside an XML file is a candidate for being defined as an entity.  Entities can be substituted inside the the body of the XML file by enclosing the entity name inside @&...;@ (e.g. @&release;@).
114 1 Herbert Greenlee
115 41 Herbert Greenlee
h2. Project Element
116 1 Herbert Greenlee
117 41 Herbert Greenlee
Each project definition file should contain a single project element enclosed in "@<project name=project-name>...</project>@."  The name attribute of the project element is required.
118 1 Herbert Greenlee
119 41 Herbert Greenlee
The content of the project element consists of other XML subelements, including the following.
120 41 Herbert Greenlee
* A single subelement with tag "@larsoft@," which defines the run-time environment.
121 41 Herbert Greenlee
* Option subelements.
122 41 Herbert Greenlee
* One or more stage subelements. 
123 1 Herbert Greenlee
124 41 Herbert Greenlee
h3. Larsoft subelement.
125 41 Herbert Greenlee
126 57 Herbert Greenlee
Each project element is required to contain a single subelement with tag "@larsoft@" (enclosed in "@<larsoft>...</larsoft>@."  The larsoft subelement defines the batch run-time environment.  The larsoft subelement may contain simple text subelements, of which there are currently three:
127 42 Herbert Greenlee
128 43 Herbert Greenlee
* @<tag>...</tag>@
129 42 Herbert Greenlee
Larsoft release version.
130 42 Herbert Greenlee
131 43 Herbert Greenlee
* @<qual>...</qual>@
132 42 Herbert Greenlee
Larsoft release qualifier.
133 42 Herbert Greenlee
134 43 Herbert Greenlee
* @<local>...</local>@
135 42 Herbert Greenlee
Path of user's local test release directory or tarball.
136 42 Herbert Greenlee
137 57 Herbert Greenlee
The @local@ subelement is optional.  Here is how a typical larsoft subelement might appear in a project definition file.
138 42 Herbert Greenlee
139 42 Herbert Greenlee
<pre>
140 42 Herbert Greenlee
<larsoft>
141 42 Herbert Greenlee
  <tag>&release;</tag>
142 42 Herbert Greenlee
  <qual>e6:prof</qual>
143 42 Herbert Greenlee
</larsoft>
144 42 Herbert Greenlee
</pre>
145 42 Herbert Greenlee
Note in this example that the larsoft version is defined by an entity "@release@," which should be defined in the DOCTYPE section.
146 41 Herbert Greenlee
147 44 Herbert Greenlee
h3. Project options
148 41 Herbert Greenlee
149 58 Herbert Greenlee
Project options are text subelements of the project element with tags other that "@larsoft@" or "@stage@."  Here are some project options (this is the full list when this wiki was written).  The full list of project options (and all defined XML constructs) can always be found by typing "@project.py --xmlhelp@."
150 41 Herbert Greenlee
151 51 Herbert Greenlee
* @<group>...</group>@
152 46 Herbert Greenlee
Should contain the standard experiment name (for microboone use "@uboone@").  If missing, environment variable @$GROUP@ is used.
153 1 Herbert Greenlee
154 51 Herbert Greenlee
* @<numevents>...</numevents>@
155 45 Herbert Greenlee
Total number of events to process.
156 45 Herbert Greenlee
157 51 Herbert Greenlee
* @<numjobs>...</numjobs>@
158 59 Herbert Greenlee
Number of parallel worker jobs (default 1).  Can be overridden in individual stages.
159 45 Herbert Greenlee
160 51 Herbert Greenlee
* @<os>...</os>@
161 59 Herbert Greenlee
Comma-separated list of allowed batch OSes (e.g. "SL5,SL6").  This option is passed directly to @jobsub_submit@ command line option @--OS@.  Default is @jobsub@ decides.
162 1 Herbert Greenlee
163 51 Herbert Greenlee
* @<resource>...</resource>@
164 59 Herbert Greenlee
Specify @jobsub@ resources (command line option "@--resource-provides=usage_model=@").  Default is "@DEDICATED,OPPORTUNISTIC@".  For OSG specify "@OFFSITE@."  Can be overridden in individual stages.
165 48 Herbert Greenlee
166 51 Herbert Greenlee
* @<server>...</server>@
167 1 Herbert Greenlee
Specify @jobsub@ server.  Expert option, usually not needed.
168 1 Herbert Greenlee
169 51 Herbert Greenlee
* @<site>...</site>@
170 59 Herbert Greenlee
OSG site(s) (comma-separated list).  Use with "@<resource>OFFSITE</resource>@."  Default is @jobsub@ decides, which usually means "any site."
171 1 Herbert Greenlee
172 51 Herbert Greenlee
* @<filetype>...</filetype>@
173 50 Herbert Greenlee
Sam file type (e.g. "data" or "mc").  Default none.
174 1 Herbert Greenlee
175 51 Herbert Greenlee
* @<runtype>...</runtype>@
176 1 Herbert Greenlee
Sam run type (e.g. "physics").  Default none.
177 1 Herbert Greenlee
178 51 Herbert Greenlee
* @<merge>...</merge>@
179 60 Herbert Greenlee
Histogram merging program.  Default "@hadd -T@."  Can be overridden in each stage.
180 1 Herbert Greenlee
181 51 Herbert Greenlee
* @<fcldir>...</fcldir>@
182 1 Herbert Greenlee
Specify additional directories in which to search for top-level fcl job files.  @Project.py@ searches @$FHICL_FILE_PATH@ and the current directory by default.
183 1 Herbert Greenlee
184 1 Herbert Greenlee
h3. Stage Sublements
185 1 Herbert Greenlee
186 52 Herbert Greenlee
Each project element should contain one or more stage subelements enclosed in "@<stage name=stage-name>...</stage>@."  The name attribute of the stage subelement is required, and should be different for each stage.  The stage element should contain stage options in the form of simple text subelements.  Here are the stage options:
187 51 Herbert Greenlee
188 51 Herbert Greenlee
* @<fcl>...</fcl>@
189 51 Herbert Greenlee
Top-level fcl job file (required).  Can be specified as full or relative path.
190 51 Herbert Greenlee
191 51 Herbert Greenlee
* @<outdir>...</outdir>@
192 51 Herbert Greenlee
Output directory full path (required).  The output directory should be accessible interactively on the submitting node and grid-write-accessible via @ifdh cp@ from the batch worker.
193 51 Herbert Greenlee
194 63 Herbert Greenlee
* @<numjobs>...</numjobs>@
195 63 Herbert Greenlee
Number of parallel worker jobs.  If not specified, inherit from project options.
196 63 Herbert Greenlee
197 63 Herbert Greenlee
* @<targetfilesize>...</targetfilesize>@
198 63 Herbert Greenlee
If specified, this option may override the number of workers (option numjobs) in the downward direction to achieve the estimated target file size.
199 63 Herbert Greenlee
200 66 Herbert Greenlee
The following options deal with where this processing stage gets its input data.  Specify no more than one input option.  You can also omit any input opiton, in which case, output data from the previous stage is pipelined to this stage, or there is no input.
201 63 Herbert Greenlee
202 51 Herbert Greenlee
* @<inputfile>...</inputfile>@
203 60 Herbert Greenlee
Specify a single input file full path.
204 60 Herbert Greenlee
205 60 Herbert Greenlee
* @<inputlist>...</inputlist>@
206 62 Herbert Greenlee
Specify input file list (a file containing a list of input files, one per line, full path).
207 1 Herbert Greenlee
208 60 Herbert Greenlee
* @<inputdef>...</inputdef>@
209 1 Herbert Greenlee
Specify input sam dataset definition.
210 66 Herbert Greenlee
211 66 Herbert Greenlee
* @<inputmode>...</inputmode>@
212 66 Herbert Greenlee
Specify input mode, which can be "textfile" or nothing.  Use this option with @<inputfile>...</inputfile>@ or @<inputlist>...</inputlist>@ together with art producer module @TextFileGen@.  @TextFileGen@ should be configured at location physics.producers.generator in the job configuration fcl file.
213 1 Herbert Greenlee
214 65 Herbert Greenlee
The following options allow job customizations by user-written scripts.  The script location should be specified as an absolute or relative path (relative to current directory where @project.py@ is invoked).  Any specified job customization scripts are copied to the work directory and from there are copied to the batch worker.
215 60 Herbert Greenlee
216 1 Herbert Greenlee
* @<initscript>...</initscript>@
217 1 Herbert Greenlee
Worker initialization script (condor_lar.sh --init-script).
218 1 Herbert Greenlee
219 60 Herbert Greenlee
* @<initsource>...</initsource>@
220 60 Herbert Greenlee
Worker initialization source script (condor_lar.sh --init-source).
221 60 Herbert Greenlee
222 63 Herbert Greenlee
* @<endscript>...</endscript>@
223 63 Herbert Greenlee
Worker finalization script (condor_lar.sh --end-script).
224 64 Herbert Greenlee
225 64 Herbert Greenlee
Additional options.
226 63 Herbert Greenlee
227 63 Herbert Greenlee
* @<defname>...</defname>@
228 63 Herbert Greenlee
Sam dataset definition name for output files.
229 60 Herbert Greenlee
230 61 Herbert Greenlee
* @<merge>...</merge>@
231 60 Herbert Greenlee
Histogram merging program.  If not specified, inherit from project options.
232 60 Herbert Greenlee
233 60 Herbert Greenlee
* @<resource>...</resource>@
234 60 Herbert Greenlee
Specify @jobsub@ resources (command line option "@--resource-provides=usage_model=@").  If not specified, inherit from project options.
235 60 Herbert Greenlee
236 60 Herbert Greenlee
* @<lines>...</lines>@
237 60 Herbert Greenlee
Specify arbitrary condor command via @jobsub_submit --lines= (expert option).
238 60 Herbert Greenlee
239 60 Herbert Greenlee
* @<site>...</site>@
240 60 Herbert Greenlee
OSG site(s) (comma-separated list).  If not specified, inherit from project options.