ViewVC Help
View File | Revision Log | Show Annotations | Root Listing
root/cvsroot/COMP/CRAB/python/crab_help.py
Revision: 1.52
Committed: Mon Apr 21 16:08:30 2008 UTC (17 years ago) by ewv
Content type: text/x-python
Branch: MAIN
CVS Tags: CRAB_2_2_0_pre12, CRAB_2_2_0_pre11
Changes since 1.51: +38 -42 lines
Log Message:
Merge changes for new OSG bdii

File Contents

# User Rev Content
1 nsmirnov 1.1
2     ###########################################################################
3     #
4     # H E L P F U N C T I O N S
5     #
6     ###########################################################################
7    
8     import common
9    
10     import sys, os, string
11 spiga 1.34
12 nsmirnov 1.1 import tempfile
13    
14     ###########################################################################
15     def usage():
16 slacapra 1.43 print 'in usage()'
17 nsmirnov 1.1 usa_string = common.prog_name + """ [options]
18 slacapra 1.3
19     The most useful general options (use '-h' to get complete help):
20    
21 slacapra 1.26 -create -- Create all the jobs.
22     -submit n -- Submit the first n available jobs. Default is all.
23 slacapra 1.46 -status [range] -- check status of all jobs.
24 slacapra 1.20 -getoutput|-get [range] -- get back the output of all jobs: if range is defined, only of selected jobs
25 ewv 1.44 -publish [dbs_url] -- after the getouput, publish the data user in a local DBS instance
26 slacapra 1.4 -kill [range] -- kill submitted jobs
27 ewv 1.52 -clean -- gracefully cleanup the directory of a task
28 slacapra 1.4 -testJdl [range] -- check if resources exist which are compatible with jdl
29 slacapra 1.27 -list [range] -- show technical job details
30 slacapra 1.4 -postMortem [range] -- provide a file with information useful for post-mortem analysis of the jobs
31 ewv 1.52 -printId [range] -- print the job SID or Task Unique ID while using the server
32 slacapra 1.20 -continue|-c [dir] -- Apply command to task stored in [dir].
33 spiga 1.49 -h [format] -- Detailed help. Formats: man (default), tex, html, txt
34     -cfg fname -- Configuration file name. Default is 'crab.cfg'
35 slacapra 1.4 -debug N -- set the verbosity level to N
36 spiga 1.49 -v -- Print version and exit
37 nsmirnov 1.1
38 slacapra 1.4 "range" has syntax "n,m,l-p" which correspond to [n,m,l,l+1,...,p-1,p] and all possible combination
39    
40 nsmirnov 1.1 Example:
41 slacapra 1.26 crab -create -submit 1
42 nsmirnov 1.1 """
43 slacapra 1.43 print usa_string
44 nsmirnov 1.1 sys.exit(2)
45    
46     ###########################################################################
47     def help(option='man'):
48     help_string = """
49     =pod
50    
51     =head1 NAME
52    
53     B<CRAB>: B<C>ms B<R>emote B<A>nalysis B<B>uilder
54    
55 slacapra 1.3 """+common.prog_name+""" version: """+common.prog_version_str+"""
56 nsmirnov 1.1
57 slacapra 1.19 This tool B<must> be used from an User Interface and the user is supposed to
58 fanzago 1.37 have a valid Grid certificate.
59 nsmirnov 1.1
60     =head1 SYNOPSIS
61    
62 slacapra 1.13 B<"""+common.prog_name+"""> [I<options>] [I<command>]
63 nsmirnov 1.1
64     =head1 DESCRIPTION
65    
66 ewv 1.52 CRAB is a Python program intended to simplify the process of creation and submission of CMS analysis jobs to the Grid environment .
67 nsmirnov 1.1
68 slacapra 1.3 Parameters for CRAB usage and configuration are provided by the user changing the configuration file B<crab.cfg>.
69 nsmirnov 1.1
70 spiga 1.48 CRAB generates scripts and additional data files for each job. The produced scripts are submitted directly to the Grid. CRAB makes use of BossLite to interface to the Grid scheduler, as well as for logging and bookkeeping.
71 nsmirnov 1.1
72 ewv 1.52 CRAB supports any CMSSW based executable, with any modules/libraries, including user provided ones, and deals with the output produced by the executable. CRAB provides an interface to CMS data discovery services (DBS and DLS), which are completely hidden to the final user. It also splits a task (such as analyzing a whole dataset) into smaller jobs, according to user requirements.
73 nsmirnov 1.1
74 slacapra 1.46 CRAB can be used in two ways: StandAlone and with a Server.
75     The StandAlone mode is suited for small task, of the order of O(100) jobs: it submits the jobs directly to the scheduler, and these jobs are under user responsibility.
76 ewv 1.52 In the Server mode, suited for larger tasks, the jobs are prepared locally and then passed to a dedicated CRAB server, which then interacts with the scheduler on behalf of the user, including additional services, such as automatic resubmission, status caching, output retrieval, and more.
77 slacapra 1.46 The CRAB commands are exactly the same in both cases.
78    
79 slacapra 1.13 CRAB web page is available at
80    
81     I<http://cmsdoc.cern.ch/cms/ccs/wm/www/Crab/>
82 slacapra 1.6
83 slacapra 1.19 =head1 HOW TO RUN CRAB FOR THE IMPATIENT USER
84    
85 ewv 1.52 Please, read all the way through in any case!
86 slacapra 1.19
87     Source B<crab.(c)sh> from the CRAB installation area, which have been setup either by you or by someone else for you.
88    
89 ewv 1.52 Modify the CRAB configuration file B<crab.cfg> according to your need: see below for a complete list. A template and commented B<crab.cfg> can be found on B<$CRABDIR/python/crab.cfg>
90 slacapra 1.19
91 ewv 1.44 ~>crab -create
92 slacapra 1.19 create all jobs (no submission!)
93    
94 spiga 1.25 ~>crab -submit 2 -continue [ui_working_dir]
95 slacapra 1.19 submit 2 jobs, the ones already created (-continue)
96    
97 slacapra 1.26 ~>crab -create -submit 2
98 slacapra 1.19 create _and_ submit 2 jobs
99    
100 spiga 1.25 ~>crab -status
101 slacapra 1.19 check the status of all jobs
102    
103 spiga 1.25 ~>crab -getoutput
104 slacapra 1.19 get back the output of all jobs
105    
106 ewv 1.44 ~>crab -publish
107     publish all user outputs in the DBS specified in the crab.cfg (dbs_url_for_publication) or written as argument of this option
108 fanzago 1.42
109 slacapra 1.20 =head1 RUNNING CMSSW WITH CRAB
110 nsmirnov 1.1
111 slacapra 1.3 =over 4
112    
113     =item B<A)>
114    
115 ewv 1.52 Develop your code in your CMSSW working area. Do anything which is needed to run interactively your executable, including the setup of run time environment (I<eval `scramv1 runtime -sh|csh`>), a suitable I<ParameterSet>, etc. It seems silly, but B<be extra sure that you actually did compile your code> I<scramv1 b>.
116 slacapra 1.3
117 ewv 1.44 =item B<B)>
118 slacapra 1.3
119 slacapra 1.20 Source B<crab.(c)sh> from the CRAB installation area, which have been setup either by you or by someone else for you. Modify the CRAB configuration file B<crab.cfg> according to your need: see below for a complete list.
120    
121     The most important parameters are the following (see below for complete description of each parameter):
122    
123     =item B<Mandatory!>
124    
125     =over 6
126    
127     =item B<[CMSSW]> section: datasetpath, pset, splitting parameters, output_file
128    
129     =item B<[USER]> section: output handling parameters, such as return_data, copy_data etc...
130    
131     =back
132    
133     =item B<Run it!>
134    
135 fanzago 1.37 You must have a valid voms-enabled Grid proxy. See CRAB web page for details.
136 slacapra 1.20
137     =back
138    
139 slacapra 1.19 =head1 HOW TO RUN ON CONDOR-G
140    
141     The B<Condor-G> mode for B<CRAB> is a special submission mode next to the standard Resource Broker submission. It is designed to submit jobs directly to a site and not using the Resource Broker.
142    
143 ewv 1.52 Due to the nature of B<Condor-G> submission, the B<Condor-G> mode is restricted to OSG sites within the CMS Grid, currently the 7 US T2: Florida(ufl.edu), Nebraska(unl.edu), San Diego(ucsd.edu), Purdue(purdue.edu), Wisconsin(wisc.edu), Caltech(ultralight.org), MIT(mit.edu).
144 slacapra 1.19
145     =head2 B<Requirements:>
146    
147     =over 2
148    
149     =item installed and running local Condor scheduler
150    
151     (either installed by the local Sysadmin or self-installed using the VDT user interface: http://www.uscms.org/SoftwareComputing/UserComputing/Tutorials/vdt.html)
152    
153     =item locally available LCG or OSG UI installation
154    
155 ewv 1.44 for authentication via Grid certificate proxies ("voms-proxy-init -voms cms" should result in valid proxy)
156 slacapra 1.19
157 ewv 1.52 =item set the environment variable EDG_WL_LOCATION to the edg directory of the local LCG or OSG UI installation
158 slacapra 1.19
159     =back
160    
161     =head2 B<What the Condor-G mode can do:>
162    
163     =over 2
164    
165 ewv 1.52 =item submission directly to multiple OSG sites,
166 slacapra 1.19
167 ewv 1.52 the requested dataset must be published correctly by the site in the local and global services.
168     Previous restrictions on submitting only to a single site have been removed. SE and CE whitelisting
169     and blacklisting work as in the other modes.
170 slacapra 1.19
171     =back
172    
173     =head2 B<What the Condor-G mode cannot do:>
174    
175     =over 2
176    
177     =item submit jobs if no condor scheduler is running on the submission machine
178    
179     =item submit jobs if the local condor installation does not provide Condor-G capabilities
180    
181 ewv 1.52 =item submit jobs to an LCG site
182 slacapra 1.19
183 fanzago 1.37 =item support Grid certificate proxy renewal via the myproxy service
184 slacapra 1.19
185     =back
186    
187     =head2 B<CRAB configuration for Condor-G mode:>
188    
189 ewv 1.52 The CRAB configuration for the Condor-G mode only requires one change in crab.cfg:
190 nsmirnov 1.1
191 slacapra 1.19 =over 2
192 slacapra 1.3
193 slacapra 1.19 =item select condor_g Scheduler:
194 slacapra 1.4
195 slacapra 1.19 scheduler = condor_g
196 slacapra 1.4
197 slacapra 1.19 =back
198 slacapra 1.4
199 ewv 1.52 =head1 COMMANDS
200 slacapra 1.4
201     =over 4
202    
203 slacapra 1.26 =item B<-create>
204 slacapra 1.4
205 slacapra 1.26 Create the jobs: from version 1_3_0 it is only possible to create all jobs.
206 ewv 1.52 The maximum number of jobs depends on dataset and splitting directives. This set of identical jobs accessing the same dataset are defined as a task.
207 slacapra 1.4 This command create a directory with default name is I<crab_0_date_time> (can be changed via ui_working_dir parameter, see below). Inside this directory it is placed whatever is needed to submit your jobs. Also the output of your jobs (once finished) will be place there (see after). Do not cancel by hand this directory: rather use -clean (see).
208     See also I<-continue>.
209    
210 slacapra 1.46 =item B<-submit [range]>
211 slacapra 1.4
212 slacapra 1.46 Submit n jobs: 'n' is either a positive integer or 'all' or a [range]. Default is all.
213 ewv 1.52 If 'n' is passed as argument, the first 'n' suitable jobs will be submitted. Please note that this is behaviour is different from other commands, where -command N means act the command to the job N, and not to the first N jobs. If a [range] is passed, the selected jobs will be submitted.
214 slacapra 1.46 This option must be used in conjunction with -create (to create and submit immediately) or with -continue (which is assumed by default), to submit previously created jobs. Failure to do so will stop CRAB and generate an error message. See also I<-continue>.
215 slacapra 1.4
216     =item B<-continue [dir] | -c [dir]>
217    
218     Apply the action on the task stored on directory [dir]. If the task directory is the standard one (crab_0_date_time), the more recent in time is taken. Any other directory must be specified.
219 slacapra 1.46 Basically all commands (but -create) need -continue, so it is automatically assumed. Of course, the standard task directory is used in this case.
220 slacapra 1.4
221 slacapra 1.26 =item B<-status>
222 nsmirnov 1.1
223 spiga 1.48 Check the status of the jobs, in all states. All the info (e.g. application and wrapper exit codes) will be available only after the output retrieval.
224 nsmirnov 1.1
225 slacapra 1.20 =item B<-getoutput|-get [range]>
226 nsmirnov 1.1
227 slacapra 1.20 Retrieve the output declared by the user via the output sandbox. By default the output will be put in task working dir under I<res> subdirectory. This can be changed via config parameters. B<Be extra sure that you have enough free space>. See I<range> below for syntax.
228 nsmirnov 1.1
229 fanzago 1.42 =item B<-publish [dbs_url]>
230    
231     Publish user output in a local DBS instance after retrieving of output. By default the publish uses the dbs_url_for_publication specified in the crab.cfg file, otherwise you can write it as argument of this option.
232    
233 slacapra 1.4 =item B<-resubmit [range]>
234 nsmirnov 1.1
235 fanzago 1.37 Resubmit jobs which have been previously submitted and have been either I<killed> or are I<aborted>. See I<range> below for syntax.
236     The resubmit option can be used only with CRAB without server. For the server this option will be implemented as soon as possible
237 nsmirnov 1.1
238 slacapra 1.4 =item B<-kill [range]>
239 nsmirnov 1.1
240 slacapra 1.4 Kill (cancel) jobs which have been submitted to the scheduler. A range B<must> be used in all cases, no default value is set.
241 nsmirnov 1.1
242 slacapra 1.4 =item B<-testJdl [range]>
243 nsmirnov 1.1
244 slacapra 1.4 Check if the job can find compatible resources. It's equivalent of doing I<edg-job-list-match> on edg.
245 nsmirnov 1.1
246 slacapra 1.20 =item B<-printId [range]>
247    
248 slacapra 1.46 Just print the job identifier, which can be the SID (Grid job identifier) of the job(s) or the taskId if you are using CRAB with the server or local scheduler Id.
249 slacapra 1.20
250 slacapra 1.4 =item B<-postMortem [range]>
251 nsmirnov 1.1
252 slacapra 1.46 Try to collect more information of the job from the scheduler point of view.
253 nsmirnov 1.1
254 slacapra 1.13 =item B<-list [range]>
255    
256 ewv 1.52 Dump technical information about jobs: for developers only.
257 slacapra 1.13
258 slacapra 1.4 =item B<-clean [dir]>
259 nsmirnov 1.1
260 slacapra 1.26 Clean up (i.e. erase) the task working directory after a check whether there are still running jobs. In case, you are notified and asked to kill them or retrieve their output. B<Warning> this will possibly delete also the output produced by the task (if any)!
261 nsmirnov 1.1
262 slacapra 1.4 =item B<-help [format] | -h [format]>
263 nsmirnov 1.1
264 slacapra 1.4 This help. It can be produced in three different I<format>: I<man> (default), I<tex> and I<html>.
265 nsmirnov 1.1
266 slacapra 1.4 =item B<-v>
267 nsmirnov 1.1
268 slacapra 1.4 Print the version and exit.
269 nsmirnov 1.1
270 slacapra 1.4 =item B<range>
271 nsmirnov 1.1
272 slacapra 1.13 The range to be used in many of the above commands has the following syntax. It is a comma separated list of jobs ranges, each of which may be a job number, or a job range of the form first-last.
273 slacapra 1.4 Example: 1,3-5,8 = {1,3,4,5,8}
274 nsmirnov 1.1
275 ewv 1.44 =back
276 slacapra 1.6
277 slacapra 1.4 =head1 OPTION
278 nsmirnov 1.1
279 slacapra 1.6 =over 4
280    
281 slacapra 1.4 =item B<-cfg [file]>
282 nsmirnov 1.1
283 slacapra 1.4 Configuration file name. Default is B<crab.cfg>.
284 nsmirnov 1.1
285 slacapra 1.4 =item B<-debug [level]>
286 nsmirnov 1.1
287 slacapra 1.13 Set the debug level: high number for high verbosity.
288 nsmirnov 1.1
289 ewv 1.44 =back
290 slacapra 1.6
291 slacapra 1.5 =head1 CONFIGURATION PARAMETERS
292    
293 spiga 1.25 All the parameter describe in this section can be defined in the CRAB configuration file. The configuration file has different sections: [CRAB], [USER], etc. Each parameter must be defined in its proper section. An alternative way to pass a config parameter to CRAB is via command line interface; the syntax is: crab -SECTION.key value . For example I<crab -USER.outputdir MyDirWithFullPath> .
294 slacapra 1.5 The parameters passed to CRAB at the creation step are stored, so they cannot be changed by changing the original crab.cfg . On the other hand the task is protected from any accidental change. If you want to change any parameters, this require the creation of a new task.
295 slacapra 1.6 Mandatory parameters are flagged with a *.
296 slacapra 1.5
297     B<[CRAB]>
298 slacapra 1.6
299 slacapra 1.13 =over 4
300 slacapra 1.5
301 slacapra 1.6 =item B<jobtype *>
302 slacapra 1.5
303 slacapra 1.26 The type of the job to be executed: I<cmssw> jobtypes are supported
304 slacapra 1.6
305     =item B<scheduler *>
306    
307 ewv 1.52 The scheduler to be used: I<glitecoll> is the more efficient grid scheduler and should be used. Other choice are I<glite>, same as I<glitecoll> but without bulk submission (and so slower) or I<condor_g> (see specific paragraph) or I<edg> which is the former Grid scheduler, which will be dismissed in some future
308     From version 210, also local scheduler are supported, for the time being only at CERN. I<LSF> is the standard CERN local scheduler or I<CAF> which is LSF dedicated to CERN Analysis Facilities.
309 slacapra 1.5
310 mcinquil 1.35 =item B<server_name>
311    
312 spiga 1.49 To use the CRAB-server support it is needed to fill this key with server name as <Server_DOMAIN> (e.g. cnaf,fnal). If I<server_name=None> crab works in standalone way.
313 spiga 1.48 The server available to users can be found from CRAB web page.
314 mcinquil 1.35
315 slacapra 1.5 =back
316    
317 slacapra 1.20 B<[CMSSW]>
318    
319     =over 4
320    
321 slacapra 1.22 =item B<datasetpath *>
322 slacapra 1.20
323 slacapra 1.22 the path of processed dataset as defined on the DBS. It comes with the format I</PrimaryDataset/DataTier/Process> . In case no input is needed I<None> must be specified.
324 slacapra 1.20
325 afanfani 1.50 =item B<runselection *>
326 ewv 1.52
327 afanfani 1.50 within a dataset you can restrict to run on a specific run number or run number range. For example runselection=XYZ or runselection=XYZ1-XYZ2 .
328    
329 slacapra 1.22 =item B<pset *>
330 slacapra 1.20
331 slacapra 1.22 the ParameterSet to be used
332 slacapra 1.20
333 slacapra 1.26 =item I<Of the following three parameter exactly two must be used, otherwise CRAB will complain.>
334 slacapra 1.20
335 slacapra 1.22 =item B<total_number_of_events *>
336    
337 slacapra 1.26 the number of events to be processed. To access all available events, use I<-1>. Of course, the latter option is not viable in case of no input. In this case, the total number of events will be used to split the task in jobs, together with I<event_per_job>.
338 slacapra 1.22
339 slacapra 1.26 =item B<events_per_job*>
340 slacapra 1.22
341 slacapra 1.26 number of events to be accessed by each job. Since a job cannot cross the boundary of a fileblock it might be that the actual number of events per job is not exactly what you asked for. It can be used also with No input.
342 slacapra 1.22
343     =item B<number_of_jobs *>
344    
345     Define the number of job to be run for the task. The number of event for each job is computed taking into account the total number of events required as well as the granularity of EventCollections. Can be used also with No input.
346    
347     =item B<output_file *>
348    
349     the output files produced by your application (comma separated list).
350 slacapra 1.20
351 ewv 1.47 =item B<increment_seeds>
352    
353     Specifies a comma separated list of seeds to increment from job to job. The initial value is taken
354     from the CMSSW config file. I<increment_seeds=sourceSeed,g4SimHits> will set sourceSeed=11,12,13 and g4SimHits=21,22,23 on
355     subsequent jobs if the values of the two seeds are 10 and 20 in the CMSSW config file.
356    
357     See also I<preserve_seeds>. Seeds not listed in I<increment_seeds> or I<preserve_seeds> are randomly set for each job.
358    
359     =item B<preserve_seeds>
360    
361     Specifies a comma separated list of seeds to which CRAB will not change from their values in the user's
362     CMSSW config file. I<preserve_seeds=sourceSeed,g4SimHits> will leave the Pythia and GEANT seeds the same for every job.
363    
364     See also I<increment_seeds>. Seeds not listed in I<increment_seeds> or I<preserve_seeds> are randomly set for each job.
365    
366 slacapra 1.23 =item B<pythia_seed>
367    
368 ewv 1.47 This parameter is deprecated. See the documentation for I<increment_seeds> and I<preserve_seeds>.
369 slacapra 1.23
370 slacapra 1.24 =item B<vtx_seed>
371    
372 ewv 1.47 This parameter is deprecated. See the documentation for I<increment_seeds> and I<preserve_seeds>.
373 slacapra 1.24
374 slacapra 1.30 =item B<g4_seed>
375    
376 ewv 1.47 This parameter is deprecated. See the documentation for I<increment_seeds> and I<preserve_seeds>.
377 slacapra 1.30
378     =item B<mix_seed>
379    
380 ewv 1.47 This parameter is deprecated. See the documentation for I<increment_seeds> and I<preserve_seeds>.
381 slacapra 1.30
382     =item B<first_run>
383    
384     First run to be generated in a generation jobs. Relevant only for no-input workflow.
385    
386 slacapra 1.31 =item B<executable>
387 slacapra 1.30
388 slacapra 1.31 The name of the executable to be run on remote WN. The default is cmsrun. The executable is either to be found on the release area of the WN, or has been built on user working area on the UI and is (automatically) shipped to WN. If you want to run a script (which might internally call I<cmsrun>, use B<USER.script_exe> instead.
389 slacapra 1.30
390     =item I<DBS and DLS parameters:>
391    
392 slacapra 1.26 =item B<dbs_url>
393 slacapra 1.6
394 slacapra 1.40 The URL of the DBS query page. For expert only.
395 slacapra 1.13
396     =back
397    
398     B<[USER]>
399    
400     =over 4
401    
402 slacapra 1.6 =item B<additional_input_files>
403    
404 mcinquil 1.35 Any additional input file you want to ship to WN: comma separated list. These are the files which might be needed by your executable: they will be placed in the WN working dir. You don\'t need to specify the I<ParameterSet> you are using, which will be included automatically. Wildcards are allowed.
405 slacapra 1.6
406 slacapra 1.31 =item B<script_exe>
407    
408 ewv 1.52 A user script that will be run on WN (instead of default cmsrun). It\'s up to the user to setup properly the script itself to run on WN enviroment. CRAB guarantees that the CMSSW environment is setup (e.g. scram is in the path) and that the modified pset.cfg will be placed in the working directory, with name CMSSW.cfg . The user must ensure that a job report named crab_fjr.xml will be written. This can be guaranteed by passing the arguments "-j crab_fjr.xml" to cmsRun in the script. The script itself will be added automatically to the input sandbox.
409 slacapra 1.31
410 slacapra 1.6 =item B<ui_working_dir>
411    
412 ewv 1.52 Name of the working directory for the current task. By default, a name I<crab_0_(date)_(time)> will be used. If this card is set, any CRAB command which require I<-continue> need to specify also the name of the working directory. A special syntax is also possible, to reuse the name of the dataset provided before: I<ui_working_dir : %(dataset)s> . In this case, if e.g. the dataset is SingleMuon, the ui_working_dir will be set to SingleMuon as well.
413 slacapra 1.6
414 mcinquil 1.35 =item B<thresholdLevel>
415    
416     This has to be a value between 0 and 100, that indicates the percentage of task completeness (jobs in a ended state are complete, even if failed). The server will notify the user by e-mail (look at the field: B<eMail>) when the task will reach the specified threshold. Works just with the server_mode = 1.
417    
418     =item B<eMail>
419    
420 ewv 1.52 The server will notify the specified e-mail when the task will reaches the specified B<thresholdLevel>. A notification is also sent when the task will reach the 100\% of completeness. This field can also be a list of e-mail: "B<eMail = user1@cern.ch, user2@cern.ch>". Works just with the server_mode = 1.
421 mcinquil 1.35
422 slacapra 1.6 =item B<return_data *>
423    
424 ewv 1.52 The output produced by the executable on WN is returned (via output sandbox) to the UI, by issuing the I<-getoutput> command. B<Warning>: this option should be used only for I<small> output, say less than 10MB, since the sandbox cannot accommodate big files. Depending on Resource Broker used, a size limit on output sandbox can be applied: bigger files will be truncated. To be used in alternative to I<copy_data>.
425 slacapra 1.6
426     =item B<outputdir>
427    
428 ewv 1.52 To be used together with I<return_data>. Directory on user interface where to store the output. Full path is mandatory, "~/" is not allowed: the default location of returned output is ui_working_dir/res .
429 slacapra 1.6
430     =item B<logdir>
431    
432 ewv 1.52 To be used together with I<return_data>. Directory on user interface where to store the standard output and error. Full path is mandatory, "~/" is not allowed: the default location of returned output is ui_working_dir/res .
433 slacapra 1.6
434     =item B<copy_data *>
435    
436 ewv 1.52 The output (only that produced by the executable, not the std-out and err) is copied to a Storage Element of your choice (see below). To be used as an alternative to I<return_data> and recommended in case of large output.
437 slacapra 1.6
438     =item B<storage_element>
439    
440     To be used together with I<copy_data>. Storage Element name.
441    
442     =item B<storage_path>
443    
444     To be used together with I<copy_data>. Path where to put output files on Storage Element. Full path is needed, and the directory must be writeable by all.
445    
446 slacapra 1.46 =item B<copyCommand>
447    
448 ewv 1.52 Only for LSF scheduler: allow to define the command to be used to copy the output to final location. Default is rfcp
449 slacapra 1.46
450 spiga 1.51 =item B<xml_report>
451    
452     To be used to switch off the screen report during the status query, enabling the db serialization in a file. Specifying I<xml_report> = FileName CRAB will serialize the DB into CRAB_WORKING_DIR/share/FileName.
453 slacapra 1.6
454     =back
455    
456 slacapra 1.5 B<[EDG]>
457 nsmirnov 1.1
458 slacapra 1.13 =over 4
459 slacapra 1.6
460 slacapra 1.13 =item B<RB>
461 slacapra 1.6
462 ewv 1.52 Which RB you want to use instead of the default one, as defined in the configuration of your UI. The ones available for CMS are I<CERN> and I<CNAF>. They are actually identical, being a collection of all RB/WMS available for CMS: the configuration files needed to change the broker will be automatically downloaded from CRAB web page and used.
463     You can use any other RB which is available, if you provide the proper configuration files. E.g., for RB XYZ, you should provide I<edg_wl_ui.conf.CMS_XYZ> and I<edg_wl_ui_cmd_var.conf.CMS_XYZ> for EDG RB, or I<glite.conf.CMS_XYZ> for glite WMS. These files are searched for in the current working directory, and, if not found, on crab web page. So, if you put your private configuration files in the working directory, they will be used, even if they are not available on crab web page.
464 slacapra 1.29 Please get in contact with crab team if you wish to provide your RB or WMS as a service to the CMS community.
465 slacapra 1.6
466 slacapra 1.14 =item B<proxy_server>
467    
468     The proxy server to which you delegate the responsibility to renew your proxy once expired. The default is I<myproxy.cern.ch> : change only if you B<really> know what you are doing.
469    
470 slacapra 1.26 =item B<role>
471    
472     The role to be set in the VOMS. See VOMS documentation for more info.
473    
474 slacapra 1.27 =item B<group>
475    
476     The group to be set in the VOMS, See VOMS documentation for more info.
477    
478 slacapra 1.28 =item B<dont_check_proxy>
479    
480 ewv 1.52 If you do not want CRAB to check your proxy. The creation of the proxy (with proper length), its delegation to a myproxyserver is your responsibility.
481 slacapra 1.28
482 slacapra 1.6 =item B<requirements>
483    
484     Any other requirements to be add to JDL. Must be written in compliance with JDL syntax (see LCG user manual for further info). No requirement on Computing element must be set.
485    
486 slacapra 1.27 =item B<additional_jdl_parameters:>
487    
488 spiga 1.48 Any other parameters you want to add to jdl file:semicolon separated list, each
489 ewv 1.44 item B<must> be complete, including the closing ";".
490 spiga 1.48
491     =item B<wms_service>
492    
493     With this field it\'s also possible to specify which WMS you want to use (https://hostname:port/pathcode) where "hostname" is WMS\' name, the "port" generally is 7443 and the "pathcode" should be something like "glite_wms_wmproxy_server".
494 slacapra 1.27
495 slacapra 1.6 =item B<max_cpu_time>
496    
497     Maximum CPU time needed to finish one job. It will be used to select a suitable queue on the CE. Time in minutes.
498    
499     =item B<max_wall_clock_time>
500    
501     Same as previous, but with real time, and not CPU one.
502    
503     =item B<CE_black_list>
504    
505 ewv 1.52 All the CE (Computing Element) whose name contains the following strings (comma separated list) will not be considered for submission. Use the dns domain (e.g. fnal, cern, ifae, fzk, cnaf, lnl,....)
506 slacapra 1.6
507     =item B<CE_white_list>
508    
509 ewv 1.52 Only the CE (Computing Element) whose name contains the following strings (comma separated list) will be considered for submission. Use the dns domain (e.g. fnal, cern, ifae, fzk, cnaf, lnl,....). Please note that if the selected CE(s) does not contain the data you want to access, no submission can take place.
510 slacapra 1.27
511     =item B<SE_black_list>
512    
513 fanzago 1.37 All the SE (Storage Element) whose name contains the following strings (comma separated list) will not be considered for submission.It works only if a datasetpath is specified.
514 slacapra 1.27
515     =item B<SE_white_list>
516    
517 slacapra 1.45 Only the SE (Storage Element) whose name contains the following strings (comma separated list) will be considered for submission.It works only if a datasetpath is specified. Please note that if the selected CE(s) does not contain the data you want to access, no submission can take place.
518 slacapra 1.6
519     =item B<virtual_organization>
520    
521 mcinquil 1.35 You don\'t want to change this: it\'s cms!
522 slacapra 1.6
523     =item B<retry_count>
524    
525 fanzago 1.37 Number of time the Grid will try to resubmit your job in case of Grid related problem.
526 slacapra 1.6
527 slacapra 1.27 =item B<shallow_retry_count>
528    
529 fanzago 1.37 Number of time shallow resubmission the Grid will try: resubmissions are tried B<only> if the job aborted B<before> start. So you are guaranteed that your jobs run strictly once.
530 slacapra 1.27
531 slacapra 1.30 =item B<maxtarballsize>
532    
533     Maximum size of tar-ball in Mb. If bigger, an error will be generated. The actual limit is that on the RB input sandbox. Default is 9.5 Mb (sandbox limit is 10 Mb)
534    
535 slacapra 1.6 =back
536    
537 slacapra 1.46 B<[LSF]>
538    
539     =over 4
540    
541     =item B<queue>
542    
543 ewv 1.52 The LSF queue you want to use: if none, the default one will be used. For CAF, the proper queue will be automatically selected.
544 slacapra 1.46
545     =item B<resource>
546    
547     The resources to be used within a LSF queue. Again, for CAF, the right one is selected.
548    
549    
550     =back
551    
552 nsmirnov 1.1 =head1 FILES
553    
554 slacapra 1.6 I<crab> uses a configuration file I<crab.cfg> which contains configuration parameters. This file is written in the INI-style. The default filename can be changed by the I<-cfg> option.
555 nsmirnov 1.1
556 slacapra 1.6 I<crab> creates by default a working directory 'crab_0_E<lt>dateE<gt>_E<lt>timeE<gt>'
557 nsmirnov 1.1
558     I<crab> saves all command lines in the file I<crab.history>.
559    
560     =head1 HISTORY
561    
562 ewv 1.52 B<CRAB> is a tool for the CMS analysis on the Grid environment. It is based on the ideas from CMSprod, a production tool originally implemented by Nikolai Smirnov.
563 nsmirnov 1.1
564     =head1 AUTHORS
565    
566     """
567     author_string = '\n'
568     for auth in common.prog_authors:
569     #author = auth[0] + ' (' + auth[2] + ')' + ' E<lt>'+auth[1]+'E<gt>,\n'
570     author = auth[0] + ' E<lt>' + auth[1] +'E<gt>,\n'
571     author_string = author_string + author
572     pass
573     help_string = help_string + author_string[:-2] + '.'\
574     """
575    
576     =cut
577 slacapra 1.19 """
578 nsmirnov 1.1
579     pod = tempfile.mktemp()+'.pod'
580     pod_file = open(pod, 'w')
581     pod_file.write(help_string)
582     pod_file.close()
583    
584     if option == 'man':
585     man = tempfile.mktemp()
586     pod2man = 'pod2man --center=" " --release=" " '+pod+' >'+man
587     os.system(pod2man)
588     os.system('man '+man)
589     pass
590     elif option == 'tex':
591     fname = common.prog_name+'-v'+common.prog_version_str
592     tex0 = tempfile.mktemp()+'.tex'
593     pod2tex = 'pod2latex -full -out '+tex0+' '+pod
594     os.system(pod2tex)
595     tex = fname+'.tex'
596     tex_old = open(tex0, 'r')
597     tex_new = open(tex, 'w')
598     for s in tex_old.readlines():
599     if string.find(s, '\\begin{document}') >= 0:
600     tex_new.write('\\title{'+common.prog_name+'\\\\'+
601     '(Version '+common.prog_version_str+')}\n')
602     tex_new.write('\\author{\n')
603     for auth in common.prog_authors:
604     tex_new.write(' '+auth[0]+
605     '\\thanks{'+auth[1]+'} \\\\\n')
606     tex_new.write('}\n')
607     tex_new.write('\\date{}\n')
608     elif string.find(s, '\\tableofcontents') >= 0:
609     tex_new.write('\\maketitle\n')
610     continue
611     elif string.find(s, '\\clearpage') >= 0:
612     continue
613     tex_new.write(s)
614     tex_old.close()
615     tex_new.close()
616     print 'See '+tex
617     pass
618     elif option == 'html':
619     fname = common.prog_name+'-v'+common.prog_version_str+'.html'
620     pod2html = 'pod2html --title='+common.prog_name+\
621     ' --infile='+pod+' --outfile='+fname
622     os.system(pod2html)
623     print 'See '+fname
624     pass
625 slacapra 1.33 elif option == 'txt':
626     fname = common.prog_name+'-v'+common.prog_version_str+'.txt'
627     pod2text = 'pod2text '+pod+' '+fname
628     os.system(pod2text)
629     print 'See '+fname
630     pass
631 nsmirnov 1.1
632     sys.exit(0)