-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdocgen_user.json
More file actions
1802 lines (1802 loc) · 64.1 KB
/
docgen_user.json
File metadata and controls
1802 lines (1802 loc) · 64.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"api": {
"docgen:get_broker": {
"after_user": "\n\nList of available plugins:\n%(available_list)s",
"api_text": "Allows to specify multiple plugins that are composited ",
"append_options": [
{
"desc_line": "Specify compositor class to merge the different broker plugins given in ``%(option_display)s``\n\nList of available broker compositor plugins:\n%(available_multi_list)s",
"opt_line": "``%(option_display)s manager`` = <plugin> (Default: %(compositor)s)"
}
],
"prepend_options": [
{
"desc_line": "%(broker_desc)s",
"opt_line": "``%(broker_prefix)s`` = <value> (Default depends on selected brokers)"
}
],
"short": "<list of %(plugin_plural)s> (Broker prefix: %(broker_prefix)s)"
},
"get": {
"after_user": "",
"api_text": "Configuration value",
"short": "<text>"
},
"get_bool": {
"after_user": "",
"api_text": "Allows to specify a boolean value with true/false, 1/0, yes/no, ...",
"format": "'True' or 'False'",
"short": "<boolean>"
},
"get_choice_yes_no": {
"after_user": "",
"api_text": "Allows to specify a command for later execution",
"short": "<boolean>"
},
"get_command": {
"after_user": "",
"api_text": "Allows to specify a command for later execution",
"append_options": [
{
"desc_line": "Specify the type of command",
"opt_line": "``%(option_display)s type`` = <enum: <enum_values:CommandType>> (Default: 'executable')"
}
],
"short": "<command or path>"
},
"get_composited_plugin": {
"after_user": "\n\nList of available plugins:\n%(available_list)s",
"api_text": "Allows to specify multiple plugins that are composited",
"append_options": [
{
"desc_line": "Specify compositor class to merge the different plugins given in ``%(option_display)s``\n\nList of available compositor plugins:\n%(available_multi_list)s",
"opt_line": "``%(option_display)s manager`` = <plugin> (Default: %(compositor)s)"
}
],
"short": "<list of %(plugin_plural)s>"
},
"get_dict": {
"after_user": "",
"api_text": "Allows to specify a space or newline separated list of values",
"format": "<default value>\n <key_1> => <value_2>\n ...\n <key_n> => <value_n>\n",
"short": "<dictionary>"
},
"get_dn": {
"after_user": "",
"api_text": "Allows to specify a single directory",
"short": "<path>"
},
"get_dn_list": {
"after_user": "",
"api_text": "Allows to specify multiple directories",
"short": "<list of paths>"
},
"get_enum": {
"after_user": "",
"api_text": "",
"format": "<default value>\n <key_1> => <value_2>\n ...\n <key_n> => <value_n>\n",
"short": "<enum: %(enum_values)s>"
},
"get_filter": {
"after_user": "",
"api_text": "Allows to specify a filter expression. The details of the filter setup is provided by the option '<opt> matcher'",
"append_options": [
{
"desc_line": "Specify plugin that is used to filter the list\n\nList of available filters:\n%(available_filter_list)s",
"opt_line": "``%(option_display)s plugin`` = <plugin> (Default: %(default_filter)s)"
},
{
"desc_line": "Specify matcher plugin that is used to match filter expressions\n\nList of available matcher plugins:\n%(available_matcher_list)s",
"opt_line": "``%(option_display)s matcher`` = <plugin> (Default: %(default_matcher)s)"
},
{
"desc_line": "Specify the order of the filtered list",
"opt_line": "``%(option_display)s order`` = <enum: <enum_values:ListOrder>> (Default: <enum:ListOrder:%(default_order)s>)"
}
],
"short": "<filter option>"
},
"get_float": {
"after_user": "",
"api_text": "Allows to specify an floating point value",
"short": "<float>"
},
"get_fn": {
"after_user": "",
"api_text": "Allows to specify a single file",
"short": "<path>"
},
"get_fn_list": {
"after_user": "",
"api_text": "Allows to specify multiple files",
"short": "<list of paths>"
},
"get_int": {
"after_user": "",
"api_text": "Allows to specify an integer value",
"short": "<integer>"
},
"get_list": {
"after_user": "",
"api_text": "Allows to specify a space or newline separated list of values",
"short": "<list of values>"
},
"get_lookup": {
"after_user": "",
"api_text": "Allows to define values that depend on other parameters",
"append_options": [
{
"desc_line": "Specify matcher plugin that is used to match the lookup expressions\n\nList of available matcher plugins:\n%(available_matcher_list)s",
"opt_line": "``%(option_display)s matcher`` = <plugin> (Default: %(default_matcher)s)"
}
],
"format": "<default value>\n <key_1> => <value_2>\n ...\n <key_n> => <value_n>\n",
"short": "<lookup specifier>"
},
"get_matcher": {
"after_user": "",
"api_text": "Allows to specify a matcher expression. The details of the matcher setup is provided by the option '<opt> matcher'",
"append_options": [
{
"desc_line": "Specify matcher plugin that is used to match filter expressions\n\nList of available matcher plugins:\n%(available_matcher_list)s",
"opt_line": "``%(option_display)s matcher`` = <plugin> (Default: %(default_matcher)s)"
}
],
"short": "<filter option>"
},
"get_parameter": {
"after_user": "",
"api_text": "Parameter value",
"short": "<text>"
},
"get_path": {
"after_user": "",
"api_text": "Allows to specify a single path",
"short": "<path>"
},
"get_path_list": {
"after_user": "",
"api_text": "Allows to specify multiple paths",
"short": "<list of paths>"
},
"get_plugin": {
"after_user": "\n\nList of available plugins:\n%(available_list)s",
"api_text": "Allows to specify a single plugin. Plugins can be specified in different ways:\n * grid_control.user_mod.UserTask (fully qualified path) \n * user_mod.UserTask (lookup in grid_control is default) \n * UserTask (short form in case of import by __init__.py)",
"short": "<%(plugin_singular)s>"
},
"get_time": {
"after_user": "",
"api_text": "Allows to specify times / durations",
"format": "hh[:mm[:ss]]",
"short": "<duration %(format)s>"
},
"is_interactive": {
"after_user": "",
"location": "interactive",
"short": "<boolean>"
}
},
"enums": {
"LogLevelEnum": {
"enum_values": "LEVEL 0..50|NOTSET|DEBUG3...DEBUG|INFO3..INFO|DEFAULT|WARNING|ERROR|CRITICAL",
"enum_values_raw": [
"LEVEL 0",
"LEVEL 1",
"LEVEL 2",
"NOTSET",
"DEBUG3",
"DEBUG2",
"DEBUG1",
"DEBUG",
"INFO3",
"INFO2",
"INFO1",
"INFO",
"DEFAULT",
"WARNING",
"ERROR",
"CRITICAL"
]
},
"LumiKeep": {
"enum_desc": "This enums allows to specify how much CMS metadata should be retained",
"enum_value_desc": {
"RunLumi": "Keep both run and lumi information"
}
},
"ResyncMode": {
"enum_alias": {
"<attr:no_changed>": [
"DISABLE",
"COMPLETE",
"IGNORE"
]
},
"enum_desc": "This enums allows to specify how to handle changes in the underlying dataset",
"enum_value_desc": {
"changed": "only jobs with changes in the area are reprocessed",
"complete": "all jobs with affected files need to be reprocessed",
"disable": "disable affected jobs",
"ignore": "ignore changes"
}
}
},
"format": {
"output_default": "(Default: %s)",
"output_desc": "%(user_text)s%(after_user)s",
"output_opt": "``%(option_display)s%(output_altopt)s`` = %(short)s %(output_default)s",
"output_plugin_list": " * %s\n"
},
"location_blacklist": [
"DataTask",
"JobManager",
"LocalWMS",
"ParameterConfig.get",
"ParameterConfig.get_bool",
"RefreshableAccessToken",
"SCRAMTask",
"TaskModule",
"TimedAccessToken",
"WMS"
],
"location_force": [
"UserTask"
],
"location_remap": {
"BaseDataParameterSource": "dataset",
"BasicWMS": "backend",
"CMSSW._get_cmssw_path_list": "CMSSW",
"CancelJobsWithProcess": "backend",
"ChunkedExecutor": "backend",
"Condor._get_dest": "Condor",
"Condor._init_pool_interface_remote": "Condor",
"CondorJDLWriter": "Condor",
"ConfigDataProvider._read_block": "ConfigDataProvider",
"ConfigDataProvider._read_fi": "ConfigDataProvider",
"ConfigFactory": "global",
"DataParameterSource": "dataset",
"DataProvider": "dataset",
"DataTask._setup_repository": "DataTask",
"DefaultPartitionResyncHandler": "dataset",
"DiscoverGliteEndpointsLazy": "GliteWMS",
"GridEngineCheckJobsProcessCreator": "GridEngine",
"HTCondor._initPoolInterfaces": "HTCondor",
"NoVarCheck": "global",
"ParameterConfig._handle_dict": "parameters",
"ParameterConfig._parse_dict": "parameters",
"ParameterConfig._process_parameter_list": "parameters",
"ParameterConfig.get_parameter": "parameters",
"SandboxHelper": "Local",
"ScanProviderBase.__init__._get_active_hash_input": "ScanProviderBase",
"ScanProviderBase.__init__._setup": "ScanProviderBase",
"UserParameterFactory": "parameters",
"_gc_create_workflow": "global",
"_get_cms_cert": "CMS grid proxy",
"_logging_configure_handler": "logging",
"_logging_create_handlers": "logging",
"_setup_work_path": "global",
"logging_setup": "logging"
},
"location_whitelist": [
"global",
"Workflow",
"SimpleJobManager",
"backend",
"UserTask",
"CMSSW",
"CMSSWAdvanced",
"dataset"
],
"manual options": {
"global": [
{
"api": "get_list",
"default": "''",
"example": "-G -c",
"example_text": "Here, -G -c enables the GUI and continuous mode",
"option": "cmdargs",
"user_text": "Automatically added command line arguments"
},
{
"api": "get_list",
"default": "''",
"example": "common.conf",
"force": true,
"location": "global",
"option": "include",
"user_text": "List of additional config files which provide default values. These config files are processed in addition to the files: /etc/grid-control.conf, ~/.grid-control.conf and <GCDIR>/default.conf"
},
{
"api": "get_list",
"default": "''",
"example": "common.conf",
"force": true,
"location": "global",
"option": "include override",
"user_text": "List of additional config files which will override anything in the current config file."
}
]
},
"option_map": {
"<call:output_vn.lstrip('!')>": "<parameter>",
"<call:self._get_varexpr(<name:vn>)>": "<parameter expression>",
"<call:self._get_varexpr(<parameter>)>": "<parameter expression>",
"<name:broker_prefix>": "<broker prefix>",
"<name:datasource_name>": "<datasource>",
"<name:handler_name>": "<handler>",
"<name:idx>": "<index>",
"<name:logger_name>": "<logger name>",
"<name:option_prefix>": "<prefix>",
"<name:output_vn>": "<parameter>",
"<name:prefix>": "<prefix>",
"<name:ref_name>": "<parameter reference>",
"<name:storage_channel>": "<storage channel>",
"<name:storage_type>": "<storage type>",
"<name:varexpr>": "<parameter expression>",
"<name:vn>": "<parameter>"
},
"options": {
"<attr:option>": {
"option_display": "<option name>",
"user_text": "Toggle to switch interactive questions on and off"
},
"<call:output_vn.lstrip('!')>": {
"disable_dupe_check": true,
"user_text": "Specify parameter value"
},
"<call:self._get_var_opt(<name:varexpr>, <name:suffix>)>": {
"default_map": {
"<name:default>": "''"
},
"disable_dupe_check": true,
"option_display": "<name of variable> or <tuple with variable> [<option name for variable>]",
"user_text": "Specify value(s) of variable"
},
"<call:self._get_varexpr(<name:vn>)> key delimeter": {
"user_text": "Specify delimeter to split parameter names"
},
"<call:self._get_varexpr(<name:vn>)> parse dict": {
"user_text": "Toggle parsing parameter value as dictionary when it contains '=>'"
},
"<name:broker_prefix>": {
"disable_dupe_check": true,
"user_text": "Specify broker requirement"
},
"<name:broker_prefix> broker prune": {
"user_text": "Toggle the removal of unused brokers from the broker pipeline"
},
"<name:broker_prefix> entries": {
"user_text": "Specify the number of broker results to store in the job requirements (0: no limit)"
},
"<name:broker_prefix> randomize": {
"user_text": "Toggle the randomization of broker results"
},
"<name:broker_prefix> storage access": {
"user_text": "Specify the lookup dictionary that maps storage requirements into other kinds of requirements"
},
"<name:broker_prefix>:FilterBroker": {
"user_text": "Specify the filter expression to select entries given to the broker"
},
"<name:datasource_name>": {
"short": "<list of [<nickname> : [<provider> :]] <dataset specifier> >",
"user_text": "Specify list of datasets to process (including optional nickname and dataset provider information)"
},
"<name:datasource_name> block sort": {
"user_text": "Toggle sorting of dataset blocks"
},
"<name:datasource_name> check entry consistency": {
"user_text": "Toggle check for consistency between the number of events given in the block and and the files"
},
"<name:datasource_name> check nickname collision": {
"user_text": "Toggle nickname collision checks between datasets"
},
"<name:datasource_name> check nickname consistency": {
"user_text": "Toggle check for consistency of nicknames between blocks in the same dataset"
},
"<name:datasource_name> check unique block": {
"user_text": "Specify how to react to duplicated dataset and blockname combinations"
},
"<name:datasource_name> check unique url": {
"user_text": "Specify how to react to duplicated urls in the dataset"
},
"<name:datasource_name> default query interval": {
"user_text": "Specify the default limit for the dataset query interval"
},
"<name:datasource_name> entries per job:EventBoundarySplitter": {
"example": 5000,
"user_text": "Set granularity of dataset splitter"
},
"<name:datasource_name> entries per job:HybridSplitter": {
"example": 5000,
"user_text": "Set guideline for the granularity of the dataset splitter"
},
"<name:datasource_name> files per job": {
"example": 10,
"user_text": "Set granularity of dataset splitter"
},
"<name:datasource_name> files sort": {
"user_text": "Toggle sorting of dataset files"
},
"<name:datasource_name> ignore urls": {
"user_text": "Specify list of url / data sources to remove from the dataset"
},
"<name:datasource_name> limit entries": {
"user_text": "Specify the number of events after which addition files in the dataset are discarded"
},
"<name:datasource_name> limit urls": {
"user_text": "Specify the number of files after which addition files in the dataset are discarded"
},
"<name:datasource_name> limit urls fraction": {
"user_text": "Specify the fraction of files in the dataset that should be used"
},
"<name:datasource_name> location filter": {
"user_text": "Specify dataset location filter. Dataset without locations have the filter whitelist applied"
},
"<name:datasource_name> location merge mode": {
"user_text": "Specify how the location information should be processed by the dataset block merge procedure"
},
"<name:datasource_name> location sort": {
"user_text": "Toggle sorting of dataset locations"
},
"<name:datasource_name> lumi filter": {
"disable_dupe_check": true,
"user_text": "Specify lumi filter for the dataset (as nickname dependent dictionary)"
},
"<name:datasource_name> lumi filter strictness": {
"user_text": "Specify if the lumi filter requires the run and lumi information (strict) or just the run information (weak)"
},
"<name:datasource_name> lumi keep": {
"default_map": {
"<name:lumi_keep_default>": "<Run/none depending on active/inactive lumi filter>"
},
"user_text": "Specify which lumi metadata to retain"
},
"<name:datasource_name> lumi metadata": {
"default_map": {
"<manual>": "<True/False for active/inactive lumi filter>"
},
"user_text": "Toggle the retrieval of lumi metadata"
},
"<name:datasource_name> metadata merge mode": {
"user_text": "Specify how the metadata information should be processed by the dataset block merge procedure"
},
"<name:datasource_name> nickname expr": {
"user_text": "Specify a python expression (using the variables dataset, block and oldnick) to generate the dataset nickname for the block"
},
"<name:datasource_name> nickname full name": {
"user_text": "Toggle if the nickname should be constructed from the complete dataset name or from the first part"
},
"<name:datasource_name> nickname source": {
"user_text": "Specify nickname plugin that determines the nickname for datasets"
},
"<name:datasource_name> partition cputime factor": {
"user_text": "Specify how the requested cpu time scales with the number of entries in the partition"
},
"<name:datasource_name> partition cputime offset": {
"user_text": "Specify the offset of the requested cpu time"
},
"<name:datasource_name> partition file names delimeter": {
"user_text": "Specify the delimeter used to concatenate the dataset file list"
},
"<name:datasource_name> partition file names format": {
"user_text": "Specify the format of the dataset files given to the job"
},
"<name:datasource_name> partition lfn modifier": {
"user_text": "Specify a LFN prefix or prefix shortcut ('/': reduce to LFN)"
},
"<name:datasource_name> partition lfn modifier dict": {
"user_text": "Specify a dictionary with lfn modifier shortcuts"
},
"<name:datasource_name> partition location check": {
"user_text": "Toggle the deactivation of partitions without storage locations"
},
"<name:datasource_name> partition location filter": {
"user_text": "Specify filter for dataset locations"
},
"<name:datasource_name> partition location preference": {
"user_text": "Specify dataset location preferences"
},
"<name:datasource_name> partition location requirement": {
"user_text": "Add dataset location to job requirements"
},
"<name:datasource_name> partition memory factor": {
"user_text": "Specify how the requested memory scales with the number of entries in the partition"
},
"<name:datasource_name> partition memory offset": {
"user_text": "Specify the offset of the requested memory"
},
"<name:datasource_name> partition metadata": {
"user_text": "Specify list of dataset metadata to forward to the job environment"
},
"<name:datasource_name> partition processor": {
"user_text": "Specify list of plugins that process partitions"
},
"<name:datasource_name> partition processor prune": {
"user_text": "Toggle the removal of unused partition processors from the partition processing pipeline"
},
"<name:datasource_name> partition tfc": {
"user_text": "Specify a dataset location dependent trivial file catalogue with file name prefixes"
},
"<name:datasource_name> partition variable file names": {
"user_text": "Specify variable name containing the list of file names"
},
"<name:datasource_name> partition variable max events": {
"user_text": "Specify variable name containing the number of events to process"
},
"<name:datasource_name> partition variable prefix": {
"default_map": {
"<call:datasource_name.upper()>": "'DATASET'"
},
"user_text": "Specify prefix for variables containing dataset information"
},
"<name:datasource_name> partition variable skip events": {
"user_text": "Specify variable name containing the number of events to skip"
},
"<name:datasource_name> partition walltime factor": {
"user_text": "Specify how the requested wall time scales with the number of entries in the partition"
},
"<name:datasource_name> partition walltime offset": {
"user_text": "Specify the offset of the requested wall time"
},
"<name:datasource_name> processor": {
"user_text": "Specify list of plugins that process datasets before the partitioning"
},
"<name:datasource_name> processor prune": {
"user_text": "Toggle the removal of unused dataset processors from the dataset processing pipeline"
},
"<name:datasource_name> provider": {
"user_text": "Specify the name of the default dataset provider"
},
"<name:datasource_name> refresh": {
"default_map": {
"-1": "disabled (%(default_raw)s)"
},
"user_text": "Specify the interval to check for changes in the used datasets"
},
"<name:datasource_name> remove empty blocks": {
"user_text": "Toggle removal of empty blocks (without files) from the dataset"
},
"<name:datasource_name> remove empty files": {
"user_text": "Toggle removal of empty files (without entries) from the dataset"
},
"<name:datasource_name> run range": {
"user_text": "Specify number of sequential runs that are processed per job"
},
"<name:datasource_name> sort": {
"user_text": "Toggle sorting of datasets"
},
"<name:datasource_name> splitter": {
"short": "<plugin>",
"user_text": "Specify the dataset splitter plugin to partition the dataset"
},
"<name:datasource_name> splitter stack": {
"short": "<list of plugins>",
"user_text": "Specify sequence of dataset splitters. All dataset splitters except for the last one have to be of type 'FileLevelSplitter', splitting only along file boundaries"
},
"<name:datasource_name> target partitions": {
"user_text": "Specify the number of partitions the splitter should aim for"
},
"<name:datasource_name> target partitions per nickname": {
"user_text": "Specify the number of partitions per nickname the splitter should aim for"
},
"<name:logger_name> <name:handler_name> code context": {
"user_text": "Number of code context lines in shown exception logs"
},
"<name:logger_name> <name:handler_name> detail lower limit": {
"user_text": "Logging messages below this log level will use the long form output"
},
"<name:logger_name> <name:handler_name> detail upper limit": {
"user_text": "Logging messages above this log level will use the long form output"
},
"<name:logger_name> <name:handler_name> file stack": {
"user_text": "Level of detail for file stack information shown in exception logs"
},
"<name:logger_name> <name:handler_name> thread stack": {
"user_text": "Level of detail for thread stack information shown in exception logs"
},
"<name:logger_name> <name:handler_name> tree": {
"user_text": "Level of detail for exception tree information shown in exception logs"
},
"<name:logger_name> <name:handler_name> variables": {
"user_text": "Level of detail for variable information shown in exception logs"
},
"<name:logger_name> debug file": {
"default_map": {
"<call:_get_debug_file_candidates()>": "'\"<gc dir>/debug.log\" \"/tmp/gc.debug.<uid>.<pid>\" \"~/gc.debug\"'"
},
"user_text": "Logfile used by debug file logger. In case multiple paths are specified, the first usable path will be used"
},
"<name:logger_name> file": {
"user_text": "Log file used by file logger"
},
"<name:logger_name> handler": {
"user_text": "List of log handlers"
},
"<name:logger_name> level": {
"default_map": {
"<attr:level>": "<depends on the logger>"
},
"user_text": "Logging level of log handlers"
},
"<name:logger_name> propagate": {
"default_map": {
"<call:bool(<attr:propagate>)>": "<depends on the logger>"
},
"user_text": "Toggle log propagation"
},
"<name:option_prefix> case sensitive": {
"user_text": "Toggle case sensitivity for the matcher"
},
"<name:option_prefix> chunk interval": {
"default_map": {
"<name:def_chunk_interval>": "<depends on the process>"
},
"user_text": "Specify the interval between (submit, check, ...) chunks"
},
"<name:option_prefix> chunk size": {
"default_map": {
"<name:def_chunk_size>": "<depends on the process>"
},
"user_text": "Specify the size of (submit, check, ...) chunks"
},
"<name:option_prefix> mode": {
"user_text": "Specify the matcher plugin that is used to match the subexpressions of the filter"
},
"<name:output_vn> empty set": {
"user_text": "Toggle if empty lookup results should be interpreted as an empty set [] or alternatively as an empty string ''"
},
"<name:output_vn> lookup": {
"user_text": "Specify name of the lookup variable"
},
"<name:output_vn> matcher": {
"default_map": {
"<name:name_matcher_default>": "<default matcher given by 'default matcher'>"
},
"user_text": "Specify matcher plugin that is used to match the lookup expressions\n\nList of available matcher plugins:\n%(available_matcher_list)s"
},
"<name:output_vn>:ConstParameterSource": {
"user_text": "Specify the parameter with the constant value"
},
"<name:output_vn>:_get_lookup_args": {
"user_text": "Specify the output variable name where the lookup result is stored"
},
"<name:prefix> arguments": {
"option_display": "[<prefix>] arguments",
"user_text": "Specify arguments for the executable"
},
"<name:prefix> executable": {
"default_map": {
"<name:executable_default>": "<no default> or ''"
},
"disable_dupe_check": true,
"option_display": "[<prefix>] executable",
"user_text": "Path to the executable"
},
"<name:prefix> guard override": {
"default_map": {
"<call:lchain(<call:imap(<manual>, <attr:scanner_list>)>)>": "<taken from the selected info scanners>"
},
"user_text": "Override the list of guard keys that are preventing files from being in the same datasets or block"
},
"<name:prefix> hash keys": {
"user_text": "Specify list of keys that are used to determine the datasets or block assigment of files"
},
"<name:prefix> key select": {
"user_text": "Specify list of dataset or block hashes that are selected for this data source"
},
"<name:prefix> name pattern": {
"user_text": "Specify the name pattern for the dataset or block (using variables that are common to all files in the dataset or block)"
},
"<name:prefix> send executable": {
"option_display": "[<prefix>] send executable",
"user_text": "Toggle to control if the specified executable should be send together with the job"
},
"<name:ref_name> format": {
"user_text": "Specify format of referenced CSV file"
},
"<name:ref_name> source": {
"user_text": "Specify filename of referenced CSV file"
},
"<name:ref_name> type": {
"default_map": {
"<name:ref_type_default>": "<'data' when datasource is defined, 'csv' otherwise>"
},
"user_text": "Specify reference type"
},
"<name:storage_channel> files": {
"user_text": "Specify the files that are transferred over this storage channel"
},
"<name:storage_channel> force": {
"user_text": "Force overwriting of files transferred over this storage channel"
},
"<name:storage_channel> min size": {
"default_map": {
"-1": "disabled (%(default_raw)s)"
},
"user_text": "output files below this file size (in MB) trigger a job failure"
},
"<name:storage_channel> path:LocalSBStorageManager": {
"default_map": {
"<call:config.get_work_path('sandbox')>": "<workdir>/sandbox"
},
"user_text": "Specify the default transport URL(s) that are used to transfer files over this type of storage channel"
},
"<name:storage_channel> path:SEStorageManager": {
"user_text": "Specify the default transport URL(s) that are used to transfer files over this type of storage channel"
},
"<name:storage_channel> pattern": {
"user_text": "Specify the pattern that is used to translate local to remote file names"
},
"<name:storage_channel> retry": {
"user_text": "Specify number of transfer retries"
},
"<name:storage_channel> timeout": {
"user_text": "Specify the transfer timeout for files over this storage channel"
},
"<name:storage_type> path": {
"user_text": "Specify the default transport URL(s) that are used to transfer files over this type of storage channel"
},
"<name:url>": {
"option_display": "<dataset URL>",
"short": "<int> [<metadata in JSON format>]",
"user_text": "The option name corresponds to the URL of the dataset file. The value consists of the number of entry and some optional file metadata"
},
"<name:varexpr>": {
"user_text": "Specify parameter value"
},
"<name:varexpr> default": {
"disable_dupe_check": true,
"user_text": "Specify default value for the output variable"
},
"<name:varexpr> delimeter:DefaultTupleParser": {
"user_text": "Specify delimeter to split tuples"
},
"<name:varexpr> delimeter:SplitParameterParser": {
"user_text": "Specify delimeter to split parameter value"
},
"<name:varexpr> source": {
"disable_dupe_check": true,
"user_text": "Specify name of input variable"
},
"<name:varexpr> type": {
"user_text": "Specify parameter tuple parser\n\nList of available parameter tuple parser plugins:\n%(available_parameter_tuple_parser)s"
},
"<name:varexpr> version": {
"default_map": {
"<call:self._get_version(<name:value>)>": "<version of repository given by parameter>"
},
"disable_dupe_check": true,
"user_text": "Override the result returned by the version control system"
},
"<name:vn>": {
"user_text": "Specify parameter value"
},
"<name:vn> repeat": {
"user_text": "Specify how often the parameter values should be repeated"
},
"<name:vn> repeat idx <name:idx>": {
"user_text": "Specify how often the given parameter value should be repeated"
},
"<name:vn> type": {
"disable_dupe_check": true,
"user_text": "Specify parameter value parser\n\nList of available parameter value parser plugins:\n%(available_parameter_parser)s"
},
"abort report": {
"user_text": "Specify report plugin to display in case of job cancellations"
},
"access refresh": {
"user_text": "Specify the lifetime threshold at which the access token is renewed"
},
"access token:BasicWMS": {
"user_text": "Specify access token plugins that are necessary for job submission"
},
"access token:InactiveWMS": {
"user_text": "Specify access token plugins that are necessary for job submission"
},
"account": {
"user_text": "Specify fairshare account"
},
"action": {
"example": "check submit",
"user_text": "Specify the actions and the order in which grid-control should perform them"
},
"activity fold fraction": {
"user_text": "Start folding activities when the number of activities reach this fraction of the display height"
},
"activity height max": {
"user_text": "Specify the maximum height of the activity gui element"
},
"activity height min": {
"user_text": "Specify the minimal height of the activity gui element"
},
"activity interval": {
"user_text": "Specify interval to display the "
},
"activity max length": {
"user_text": "Specify maximum number of activities to display"
},
"activity stream": {
"user_text": "Specify activity stream class that displays the current activity tree on the gui"
},
"activity stream stderr": {
"user_text": "Specify activity stream class that displays the current activity tree on stderr"
},
"activity stream stdout": {
"user_text": "Specify activity stream class that displays the current activity tree on stdout"
},
"allow phedex": {
"user_text": "Allow phedex queries to retrieve dataset location information"
},
"append info": {
"user_text": "List of classAds to manually add to the job submission file"
},
"append opts": {
"user_text": "List of jdl lines to manually add to the job submission file"
},
"application": {
"disable_dupe_check": true,
"user_text": "Specify the name of the application that is reported to dashboard"
},
"area files": {
"user_text": "List of files that should be taken from the CMSSW project area for running the job"
},
"area files basename": {
"user_text": "Toggle between using the relative path or just the file base name to match area files"
},
"arguments": {
"user_text": "Arguments that will be passed to the *cmsRun* call"
},
"backend": {
"user_text": "Select the backend to use for job submission"
},
"blacklist nodes": {
"user_text": "Nodes to blacklist (for temporary reasons), e.g. ``blacklist nodes = bird9998.desy.de bird9999.desy.de``"
},
"cancel": {
"short": "<job selector>",
"user_text": "The unfinished jobs selected by this expression are cancelled"
},
"cancel jobs": {
"user_text": "Toggle interactivity of job deletion requests"
},
"cancel timeout": {
"user_text": "Specify timeout of the process that is used to cancel jobs"
},
"ce": {
"user_text": "Specify CE for job submission"
},
"check promiscuous": {
"user_text": "Toggle the indiscriminate logging of the job status tool output"
},
"check timeout": {
"user_text": "Specify timeout of the process that is used to check the job status"
},
"chunks check": {
"user_text": "Specify maximal number of jobs to check in each job cycle"
},
"chunks enabled": {
"user_text": "Toggle to control if only a chunk of jobs are processed each job cycle"
},
"chunks retrieve": {
"user_text": "Specify maximal number of jobs to retrieve in each job cycle"
},
"chunks submit": {
"user_text": "Specify maximal number of jobs to submit in each job cycle"
},
"classad data": {
"user_text": "List of classAds to manually add to the job submission file"
},
"config": {
"user_text": "Specify the config file with grid settings"
},
"config file:CMSSW": {
"default_map": {
"<call:self._get_config_file_default()>": "<no default> or '' if prolog / epilog script is given"
},
"user_text": "List of config files that will be sequentially processed by *cmsRun* calls"
},
"config file:CMSSWAdvanced": {
"default_map": {
"": "<no default> or '' if prolog / epilog script is given"
},
"user_text": "List of config files that will be sequentially processed by *cmsRun* calls"
},
"config id": {
"call": {
"_get_name()": "<config file name w/o extension> or 'unnamed'"
},
"user_text": "Identifier for the current configuration"
},
"constants": {
"user_text": "Specify the list of constant names that is queried for values"
},
"continuous": {
"user_text": "Enable continuous running mode"
},
"cpu time": {
"default_map": {
"<attr:wall_time>": "<wall time>"
},
"user_text": "Requested cpu time"
},
"cpus": {
"user_text": "Requested number of cpus per node"
},
"das instance": {
"user_text": "Specify url to the DAS instance that is used to query the datasets"
},
"dashboard timeout": {
"user_text": "Specify the timeout for dashboard interactions"
},
"dataprovider thread max": {
"user_text": "Specify the maximum number of threads used for dataset query"
},
"dataprovider thread timeout": {
"user_text": "Specify the timeout for the dataset query to fail"
},
"dataset hash": {
"disabled": true
},
"dataset name assignment": {
"user_text": "Toggle interactive question about issues with the bijectivity of the dataset / block name assignments in the scan provider"
},
"datasource names": {
"user_text": "Specify list of data sources that will be created for use in the parameter space definition"
},
"dbs instance": {
"default_map": {
"''": "'prod/global'"
},
"user_text": "Specify the default dbs instance (by url or instance identifier) to use for dataset queries"
},
"debug mode": {
"user_text": "Toggle debug mode (detailed exception output on stdout)"
},
"default lookup": {
"user_text": "Specify the default lookup variable"
},
"default matcher": {
"user_text": "Specify the default matcher plugin that is used to match the lookup expressions\n\nList of available matcher plugins:\n%(available_matcher_list)s"
},
"defect tries": {
"example": 4,
"user_text": "Threshold for dropping jobs causing status retrieval errors (disable check with 0)"
},
"delay output": {
"user_text": "Toggle between direct output of stdout/stderr to the sandbox or indirect output to local tmp during job execution"
},
"delimeter block key": {
"short": "<delimeter>:<start>:<end>",
"user_text": "Specify the the delimeter and range to derive a block key"
},
"delimeter block modifier": {
"user_text": "Specify a python expression to modify the delimeter block key - using the variable 'value'"
},
"delimeter dataset key": {
"short": "<delimeter>:<start>:<end>",
"user_text": "Specify the the delimeter and range to derive a dataset key"
},
"delimeter dataset modifier": {
"user_text": "Specify a python expression to modify the delimeter dataset key - using the variable 'value'"
},
"delimeter match": {
"short": "<delimeter>:<count>",
"user_text": "Specify the the delimeter and number of delimeters that have to be in the dataset file"
},
"depends": {
"user_text": "List of environment setup scripts that the jobs depend on"
},
"discover sites": {
"user_text": "Toggle the automatic discovery of matching CEs"
},
"discover wms": {
"user_text": "Toggle the automatic discovery of WMS endpoints"
},
"discovery": {
"user_text": "Toggle discovery only mode (without DBS consistency checks)"
},
"discovery timeout": {
"disable_dupe_check": true,
"user_text": "Specify timeout of the process that is used to discover backend featues"