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
|
.. ckon documentation master file, created by
sphinx-quickstart on Thu Jul 4 14:26:45 2013.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
ckon documentation
==================
.. toctree::
:maxdepth: 2
Introduction
------------
*ckon* is a C++ program/tool which automatically takes care of compilation,
dictionary generation and linking of programs and libraries developed for data
analyses within the `CERN ROOT`_ analysis framework. This includes parsing
include headers to figure out which libraries the main programs need to be
linked to. It uses `automake/autoconf`_ to be platform independent and GNU
install compliant. In addition, `m4 macros`_ are automatically downloaded and
the according compiler flags included based on a list of `boost`_ libraries
provided in the config file. For the purpose of YAML database usage, a m4
macro can be downloaded during setup to link against the `yaml-cpp`_ library.
.. _CERN ROOT: http://root.cern.ch
.. _automake/autoconf: http://www.gnu.org/software/autoconf/
.. _m4 macros: http://www.gnu.org/software/autoconf-archive/The-Macros.html#The-Macros
.. _boost: http://www.boost.org/
.. _yaml-cpp: https://code.google.com/p/yaml-cpp/
Authors and Contributors
| Patrick Huck (@tschaume)
| *invaluable contributions*: Hiroshi Masui
| Reference `Talk`_ (LBNL, 2011/11/14)
License & Project Homepage
| *ckon* is published under `MIT License`_.
| Find the project page at http://tschaume.github.com/ckon
Software Requirements
* m4/1.4.6
* autoconf/2.68
* automake/1.11.4
* libtool/2.4
* boost/1.50
* libcurl/7.27.0
.. _Talk: https://speakerdeck.com/tschaume/organize-root-analyses-with-autoconf
.. _MIT License: http://opensource.org/licenses/MIT
Installation
------------
* clone *ckon* via ``git clone git@github.com:tschaume/ckon.git``
* install via ``cd ckon; ./installCkon <install-path>``
* replace ``<install-path>`` with an install path in your $PATH
* see ``./installCkon -h`` for help
* see ``./configure --help`` for configure options in case something goes
wrong
Usage
-----
Generic Options
^^^^^^^^^^^^^^^
Shown below are the generic command line options which can be given to *ckon*.::
Generic Options:
-h [ --help ] show this help
-v [ --verbose ] verbose output
-j arg call make w/ -j <#cores>
--ckon_cmd arg setup | clean | install
The long option ``--ckon_cmd`` is implemented as optional positional option
to run the setup, clean all compilation products (i.e. ``make clean``) and
globally install libraries and programs (i.e. ``make install``):
* ``ckon setup``: run the setup
* ``ckon``: compile
* ``ckon clean``: make clean
* ``ckon install``: make install
* ``ckon dry``: only generates Makefiles, no compilation
Setup
^^^^^
``ckon setup`` generates the files *configure.ac* and *.autom4te.cfg* (both
autoconf specific, no need for modifications) as well as *ckon.cfg*. Modify
the latter to resemble your directory structure and linker options. Simply
remove the lines/options you don't need, thus using the default options.
Configuration
^^^^^^^^^^^^^
The following options can be set on the command line or preferably in
*ckon.cfg*. Optionally, a file named ``ckonignore`` with a list of strings to
be ignored during the build process, can be created in the working directory.
Wildcards are not supported (yet). Instead each path currently processed by
*ckon* will be checked against the strings/lines in ``ckonignore``. If one of
the strings in ``ckonignore`` is contained in the path, the path is
ignored/skipped.::
Configuration:
-s [ --suffix ] arg add suffix + in LinkDef.h (bool)
-y [ --yaml ] arg use yaml
--ckon.src_dir arg source dir
--ckon.exclSuffix arg no + suffix
--ckon.NoRootCint arg no dictionary
--ckon.prog_subdir arg progs subdir
--ckon.build_dir arg build dir
--ckon.install_dir arg install dir
--ckon.cppflags arg add CPPFLAGS
--ckon.boost arg boost libraries
In addition, unregistered options of the form
ldadd.prog_name are allowed to use for adding
LDFLAGS to the linker of specific programs. The
given string/value is added verbatim in LDADD.
Unregistered options are only allowed in ckon.cfg
The unregistered option group ``ldadd`` is allowed. For instance, link the
programs *genCharmContrib* and *dedxCut* versus `Pythia6`_ and `RooFit`_,
respectively, by adding the following to *ckon.cfg*.::
[ldadd]
genCharmContrib=-lPhysics -lEG -lEGPythia6 # link pythia
dedxCut=-lRooFit -lRooFitCore -lMinuit # link roofit
.. _Pythia6: http://home.thep.lu.se/~torbjorn/Pythia.html
.. _RooFit: http://root.cern.ch/drupal/content/roofit
``ckon.boost`` is set during ``ckon setup`` to use and link against specific boost
libraries. Try not to run rootcint (``ckon.NoRootCint``) on the library if
compilation fails.
.. NOTE::
ckon version 0.4 now allows for the automatic download of a ``yaml.m4``
macro during ``ckon setup`` to link against the `yaml-cpp`_ library. Please
submit an `issue`_ if the macro doesn't find the library after you installed
it. This added functionality shouldn't break anything if you choose not to use
YAML during ``ckon setup``.
.. _yaml-cpp: https://code.google.com/p/yaml-cpp/
.. _issue: https://github.com/tschaume/ckon/issues
.. WARNING::
For the recursive header scan to work, make sure that all include directives
for C++ and ROOT headers are enclosed in ``<...>``! Only your local/private
headers should be enclosed in ``"..."``. Otherwise *ckon* will fail
reporting a ``basic_string::_S_create`` error.
Typical Directory Structure
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Put header and source files for each library into a separate folder in
``ckon.src_dir``. Running *ckon* should automagically take the right action
for the current status of your build directory (no need to run ``ckon clean``
before re-compilation). Makefiles and LinkDef’s are generated automatically
based on the contents and timestamps in the ``ckon.src_dir`` directory.
A typical directory structure could look as follows - using the current
defaults for illustration purposes.::
StRoot/
ElectronPid/
BetaPanels.cxx
BetaPanels.h
PureSampleAnalysis.cxx
PureSampleAnalysis.h
SigmaElFitsMaker.cxx
SigmaElFitsMaker.h
SigmaElFitsPlotter.cxx
SigmaElFitsPlotter.h
SigmaElFitsUtils.cxx
SigmaElFitsUtils.h
programs/
README
beta3sig.cc
dedxCut.cc
nsigparamsGP.cc
pureSamp.cc
StBadRdosDb/
StBadRdosDb.cxx
StBadRdosDb.h
database/
dbfiles
genAll.sh
genBadRdosDb.pl
macros/
testStBadRdosDb.C
YamlCfgReader/
YamlCfgReader.cxx
YamlCfgReader.h
config.yml
...
Index and Search
----------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
|
