1PQ2-PUT(1) General Commands Manual PQ2-PUT(1)
2
6 pq2-put - Register one or more datasets in a dataset meta-repository
7 based on ROOT files
8
10 pq2-put [options] datasetfile
11
13 This manual page documents briefly the pq2-put program.
14 pq2-put is a script invoking the pq2 ROOT application to register one
16 or more datasets in a dataset meta-repository based on ROOT files; the
17 repository can be accessed via the local file system or a remote file
18 server daemon or a PROOF facility.
19 More details about the underlying 'pq2' application can be found in the
21 man page pq2(1).
22
24 datasetfile
25 Path to the file with the list of files in the dataset or direc‐
26 tory with the files containing the file lists of the datasets to
27 be registered; in the first case wildcards '*' can be specified
28 in the file name, i.e. '<dir>/fil*' is ok but '<dir>/*/file' is
29 not. In all cases the name of the dataset is the name of the
30 file finally used. The format of the file is described below.
31
33 -h, --help
34 Display help information.
35 -k, --keep
37 Keep the temporary files created during the analysis under
38 $TMPDIR
39 -v Verbose mode
41 -d <datasetfile>, --dataset <datasetfile>
43 Alternative way to define path to the file with the list of
44 files.
45 -o <options>
47 Options for registering datasets; a combination of:
48 O overwrite existing dataset
49 U add information to existing dataset, if any or create a new one
50 T Trust the information already present in the dataset
51 V verify (scan) information in the dataset (can be very slow)
52 --overwrite
54 Alternative to '-o O'.
55 --update
57 Alternative to '-o U'.
58 --trust
60 Alternative to '-o T'.
61 --tree= <default-tree-name
63 Set the name of the default tree name to 'default-tree-name'
64 (option 'T' or --trust only); this allows to skip the tree name
65 specification during Process when more TTree (or derivative)
66 objects are available in the files.
67 --staged
69 Assume all files online or staged (option 'T' or --trust only).
70 -u <serverurl>, --url=<serverurl>
72 URL of the PROOF master or data server providing the informa‐
73 tion; for data servers, it must include the directory. Can also
74 be specified via the environment variables PQ2PROOFURL or
75 PQ2DSSRVURL (see ENVIRONMENT VARIABLES)."
76 -t <dir>, --tmpdir=<dir>
78 Directory for temporary files; defualt is /tmp/<username>.
79
81 The name of the file defining the dataset is the name of the dataset.
82 The files must contain one line per each file in the dataset with the
83 full file URL. If available, additional information can be specified
84 on the same line with the following keywords:
85 sz:<size> size of the file in bytes
87 md5:<md5_ascii> MD5 sum of the file in ASCII form
88 uuid:<uuid> UUID of the file
89 tree:<name>,<entries>,<first>,<last> meta-information about a tree in the file; the should be in the form
90 <subdir>/tree-name;'entries' is the number of entries in the tree;
91 'first' and 'last' define the entry range.
92 obj:<name>,<class>,<entries> meta-information about a generic object in the file; the should be in
93 the form <subdir>/obj-name; 'class' is the object class; 'entries' is
94 the number of occurences for this object.
95 Multiple occurences of 'tree:' or 'obj:' can be specified.
96
98 The following examples show how to register information corresponding
99 to the H1 example of the ROOT tutorials.
100 Minimal information
102 In this example the files are read from the ROOT HTTP server.
103 Detailed information about the content of the files is not
104 available, so only the URLs are given. If the file is called
105 h1-http, we get
106 $ cat h1-http
108 http://root.cern.ch/files/h1/dstarmb.root
109 http://root.cern.ch/files/h1/dstarp1a.root
110 http://root.cern.ch/files/h1/dstarp1b.root
111 http://root.cern.ch/files/h1/dstarp2.root
112 The dataset is registered and verification required:
114 $ pq2-put -o "V" h1-http
115 pq2-put: 1 dataset(s) registered
116 Full information
118 In this example the files are read from the local /data/h1
119 directory. Detailed information about the content of the files
120 is available. If the file is called h1-local, we get
121 $ cat h1-local
122 file:/data/h1/dstarmb.root sz:21330730 md5:0a60055370e16d954f90fb50c2d1a801 tree:h42,21920,0,-1
123 file:/data/h1/dstarp1a.root md5:e2f959b15235214be3c973c3e7a9ff2c sz:71464503 tree:h42,73243
124 file:/data/h1/dstarp1b.root md5:169ea4799661696a25e73257fe8a833d sz:83827959 tree:h42,85597
125 file:/data/h1/dstarp2.root md5:907d10b401a35c0240cfa76bedc31420 sz:100675234 tree:h42,103053
126 The dataset is registered trusting the passed information:
128 $ pq2-put -o T --tree=h42 --staged h1-local
129 pq2-put: 1 dataset(s) registered
130
132 See setup-pq2(1).
133
135 pq2(1), setup-pq2(1), pq2-ls(1), pq2-ls-files(1), pq2-ls-files-
136 server(1), pq2-info-server(1), pq2-ana-dist(1), pq2-verify(1),
137 pq2-rm(1), pq2-cache(1)
138 For more information on the ROOT system, please refer to
140 http://root.cern.ch
141
143 Gerardo Ganis for the ROOT team.
144
146 This library is free software; you can redistribute it and/or modify it
147 under the terms of the GNU Lesser General Public License as published
148 by the Free Software Foundation; either version 2.1 of the License, or
149 (at your option) any later version.
150 This library is distributed in the hope that it will be useful, but
152 WITHOUT ANY WARRANTY; without even the implied warranty of MER‐
153 CHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
154 General Public License for more details.
155 You should have received a copy of the GNU Lesser General Public
157 License along with this library; if not, write to the Free Software
158 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
159 USA
160
162 This manual page was originally written by Gerardo Ganis <ger‐
163 ardo.ganis@cern.ch>, for ROOT version 5.
164ROOT Version 5 PQ2-PUT(1)