Skip to content

Commit

Permalink
Merge pull request #143 from c-dilks/adage-frontend
Browse files Browse the repository at this point in the history
refactor: make `adage` a template class, and build it as an independent library
  • Loading branch information
c-dilks authored Aug 23, 2022
2 parents 9aab956 + 306bf43 commit 34e3321
Show file tree
Hide file tree
Showing 50 changed files with 908 additions and 586 deletions.
11 changes: 7 additions & 4 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,16 @@ jobs:
path: |
# sidis-eic
lib
src/Sidis-eicDict.cxx
# mstwpdf
deps/mstwpdf/*.o
deps/mstwpdf/*.so
src/*Dict.cxx
# delphes
deps/delphes
external
# mstwpdf
deps/mstwpdf/*.o
deps/mstwpdf/*.so
# adage
deps/adage/lib
deps/adage/src/*Dict.cxx
# DELPHES ---------------------------------------------------------------------------

Expand Down
30 changes: 21 additions & 9 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,31 @@ include config.mk
all: deps sidis-eic
all-clean: deps-clean clean
sidis-eic:
ln -sf ${DELPHES_HOME}/external ./
@cd src; make
@echo "\n===== SIDIS-EIC ====="
@ln -sf ${DELPHES_HOME}/external ./
@cd src; $(MAKE)
clean:
@cd src; make clean
@echo "\n===== CLEAN SIDIS-EIC ====="
@cd src; $(MAKE) clean

# dependency targets
deps: delphes mstwpdf
deps-clean: delphes-clean mstwpdf-clean
deps: delphes mstwpdf adage
deps-clean: delphes-clean mstwpdf-clean adage-clean
delphes:
@cd ${DELPHES_HOME}; make
@echo "\n===== DELPHES ====="
@cd ${DELPHES_HOME}; $(MAKE)
delphes-clean:
@cd ${DELPHES_HOME}; make clean
@echo "\n===== CLEAN DELPHES ====="
@cd ${DELPHES_HOME}; $(MAKE) clean
mstwpdf:
@cd ${MSTWPDF_HOME}; make
@echo "\n===== MSTWPDF ====="
@cd ${MSTWPDF_HOME}; $(MAKE)
mstwpdf-clean:
@cd ${MSTWPDF_HOME}; make clean
@echo "\n===== CLEAN MSTWPDF ====="
@cd ${MSTWPDF_HOME}; $(MAKE) clean
adage:
@echo "\n===== ADAGE ====="
@cd ${ADAGE_HOME}; $(MAKE)
adage-clean:
@echo "\n===== CLEAN ADAGE ====="
@cd ${ADAGE_HOME}; $(MAKE) clean
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ fast simulations, including the following features:
etc.); see [Kinematics Documentation](doc/kinematics.md) for more information
- Calculations of SIDIS variables, such as `PhiH` and `qT`, for single
particles, as well as jet variables
- Ability to specify arbitrary multi-dimensional binning schemes and cuts; see
[Adage documentation](doc/adage.md) for more information
- Ability to specify arbitrary multi-dimensional binning schemes and cuts
using [Adage](https://github.com/c-dilks/adage)
- Output data structures include multi-dimensionally binned histogram sets,
tables, and `TTrees`
- An analysis is primarily driven by macros, used to set up the binning and
Expand Down Expand Up @@ -192,7 +192,7 @@ and follow the [README](tutorial/README.md).
histograms
- the `Histos` class is a container for the histograms, and instances of
`Histos` will also be streamed to `root` files, along with the binning
scheme (handled by the `BinSet` class); downstream post processing code
scheme (handled by the Adage `BinSet` class); downstream post processing code
makes use of these streamed objects, rather than the `TObjArray`s
- derived classes are specific to upstream data structures:
- `AnalysisDelphes` for Delphes trees (fast simulations)
Expand All @@ -208,7 +208,7 @@ and follow the [README](tutorial/README.md).

### Bin Specification

- The bins may be specified arbitrarily, using the `BinSet` and `CutDef` classes
- The bins may be specified arbitrarily, using the Adage `BinSet` and `CutDef` classes
- see example `analysis_*C` macros in `tutorial/`
- `CutDef` can store and apply an arbitrary cut for a single variable, such as:
- ranges: `a<x<b` or `|x-a|<b`
Expand All @@ -233,8 +233,8 @@ and follow the [README](tutorial/README.md).
an event with `y=0.1` will appear in all three bins
- Multi-dimensional binning
- Binning in multi-dimensions is allowed, e.g., 3D binning in `x`,`Q2`,`z`
- See [Adage documentation](doc/adage.md) for more information on how multi-dimensional
binning is handled, as well as the [Adage syntax reference](doc/syntax.md)
- See [Adage documentation](deps/adage/README.md) for more information on how multi-dimensional
binning is handled, as well as the [Adage syntax reference](deps/adage/doc/syntax.md)
- Be careful of the curse of dimensionality

### Simple Tree
Expand Down
14 changes: 9 additions & 5 deletions config.mk
Original file line number Diff line number Diff line change
Expand Up @@ -20,18 +20,22 @@ LIBS = $(shell root-config --glibs)
DEPS += -I${DELPHES_HOME} -I${DELPHES_HOME}/external
LIBS += -L${DELPHES_HOME} -lDelphes

# MSTWPDF
DEPS += -I${MSTWPDF_HOME}
LIBS += -L${MSTWPDF_HOME} -lmstwpdf

# Fastjet Centauro
# DELPHES plugin: Fastjet Centauro
INCCENTAURO = 0
ifeq ($(INCCENTAURO),1)
LIBS += -L${DELPHES_HOME}/external/fastjet/plugins/Centauro -lCentauro
DEPS += -I${DELPHES_HOME}/external/fastjet/plugins/Centauro
endif
FLAGS += -DINCCENTAURO=$(INCCENTAURO)

# MSTWPDF
DEPS += -I${MSTWPDF_HOME}
LIBS += -L${MSTWPDF_HOME} -lmstwpdf

# ADAGE
DEPS += -I${ADAGE_HOME}/include
LIBS += -L${ADAGE_HOME}/lib -lAdage

# SIDIS-EIC
ifndef SIDIS_EIC_HOME
$(error "ERROR: run 'source environ.sh' before building")
Expand Down
2 changes: 2 additions & 0 deletions deps/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ while the others must be downloaded separately.
- `delphes_EIC`, from [eic/delphes_EIC](https://github.com/eic/delphes_EIC/tree/master):
Delphes configuration cards for the EIC
- `mstwpdf`, interpolation for MSTW PDFs, not a subrepo
- `adage`, from [c-dilks/adage](https://github.com/c-dilks/adage):
analysis framework for multi-dimensional binning


Subrepo Maintenance
Expand Down
2 changes: 2 additions & 0 deletions deps/adage/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
lib
*Dict.cxx
12 changes: 12 additions & 0 deletions deps/adage/.gitrepo
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
; DO NOT EDIT (unless you know what you are doing)
;
; This subdirectory is a git "subrepo", and this file is maintained by the
; git-subrepo command. See https://github.com/git-commands/git-subrepo#readme
;
[subrepo]
remote = [email protected]:c-dilks/adage.git
branch = main
commit = e98c1aede46dbae02ff721e3e9a1c313162b33c7
parent = 872ac5227b4ab26001e3f2469960b42a0336977c
method = merge
cmdver = 0.4.3
165 changes: 165 additions & 0 deletions deps/adage/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,165 @@
GNU LESSER GENERAL PUBLIC LICENSE
Version 3, 29 June 2007

Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.


This version of the GNU Lesser General Public License incorporates
the terms and conditions of version 3 of the GNU General Public
License, supplemented by the additional permissions listed below.

0. Additional Definitions.

As used herein, "this License" refers to version 3 of the GNU Lesser
General Public License, and the "GNU GPL" refers to version 3 of the GNU
General Public License.

"The Library" refers to a covered work governed by this License,
other than an Application or a Combined Work as defined below.

An "Application" is any work that makes use of an interface provided
by the Library, but which is not otherwise based on the Library.
Defining a subclass of a class defined by the Library is deemed a mode
of using an interface provided by the Library.

A "Combined Work" is a work produced by combining or linking an
Application with the Library. The particular version of the Library
with which the Combined Work was made is also called the "Linked
Version".

The "Minimal Corresponding Source" for a Combined Work means the
Corresponding Source for the Combined Work, excluding any source code
for portions of the Combined Work that, considered in isolation, are
based on the Application, and not on the Linked Version.

The "Corresponding Application Code" for a Combined Work means the
object code and/or source code for the Application, including any data
and utility programs needed for reproducing the Combined Work from the
Application, but excluding the System Libraries of the Combined Work.

1. Exception to Section 3 of the GNU GPL.

You may convey a covered work under sections 3 and 4 of this License
without being bound by section 3 of the GNU GPL.

2. Conveying Modified Versions.

If you modify a copy of the Library, and, in your modifications, a
facility refers to a function or data to be supplied by an Application
that uses the facility (other than as an argument passed when the
facility is invoked), then you may convey a copy of the modified
version:

a) under this License, provided that you make a good faith effort to
ensure that, in the event an Application does not supply the
function or data, the facility still operates, and performs
whatever part of its purpose remains meaningful, or

b) under the GNU GPL, with none of the additional permissions of
this License applicable to that copy.

3. Object Code Incorporating Material from Library Header Files.

The object code form of an Application may incorporate material from
a header file that is part of the Library. You may convey such object
code under terms of your choice, provided that, if the incorporated
material is not limited to numerical parameters, data structure
layouts and accessors, or small macros, inline functions and templates
(ten or fewer lines in length), you do both of the following:

a) Give prominent notice with each copy of the object code that the
Library is used in it and that the Library and its use are
covered by this License.

b) Accompany the object code with a copy of the GNU GPL and this license
document.

4. Combined Works.

You may convey a Combined Work under terms of your choice that,
taken together, effectively do not restrict modification of the
portions of the Library contained in the Combined Work and reverse
engineering for debugging such modifications, if you also do each of
the following:

a) Give prominent notice with each copy of the Combined Work that
the Library is used in it and that the Library and its use are
covered by this License.

b) Accompany the Combined Work with a copy of the GNU GPL and this license
document.

c) For a Combined Work that displays copyright notices during
execution, include the copyright notice for the Library among
these notices, as well as a reference directing the user to the
copies of the GNU GPL and this license document.

d) Do one of the following:

0) Convey the Minimal Corresponding Source under the terms of this
License, and the Corresponding Application Code in a form
suitable for, and under terms that permit, the user to
recombine or relink the Application with a modified version of
the Linked Version to produce a modified Combined Work, in the
manner specified by section 6 of the GNU GPL for conveying
Corresponding Source.

1) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (a) uses at run time
a copy of the Library already present on the user's computer
system, and (b) will operate properly with a modified version
of the Library that is interface-compatible with the Linked
Version.

e) Provide Installation Information, but only if you would otherwise
be required to provide such information under section 6 of the
GNU GPL, and only to the extent that such information is
necessary to install and execute a modified version of the
Combined Work produced by recombining or relinking the
Application with a modified version of the Linked Version. (If
you use option 4d0, the Installation Information must accompany
the Minimal Corresponding Source and Corresponding Application
Code. If you use option 4d1, you must provide the Installation
Information in the manner specified by section 6 of the GNU GPL
for conveying Corresponding Source.)

5. Combined Libraries.

You may place library facilities that are a work based on the
Library side by side in a single library together with other library
facilities that are not Applications and are not covered by this
License, and convey such a combined library under terms of your
choice, if you do both of the following:

a) Accompany the combined library with a copy of the same work based
on the Library, uncombined with any other library facilities,
conveyed under the terms of this License.

b) Give prominent notice with the combined library that part of it
is a work based on the Library, and explaining where to find the
accompanying uncombined form of the same work.

6. Revised Versions of the GNU Lesser General Public License.

The Free Software Foundation may publish revised and/or new versions
of the GNU Lesser General Public License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns.

Each version is given a distinguishing version number. If the
Library as you received it specifies that a certain numbered version
of the GNU Lesser General Public License "or any later version"
applies to it, you have the option of following the terms and
conditions either of that published version or of any later version
published by the Free Software Foundation. If the Library as you
received it does not specify a version number of the GNU Lesser
General Public License, you may choose any version of the GNU Lesser
General Public License ever published by the Free Software Foundation.

If the Library as you received it specifies that a proxy can decide
whether future versions of the GNU Lesser General Public License shall
apply, that proxy's public statement of acceptance of any version is
permanent authorization for you to choose that version for the
Library.
45 changes: 45 additions & 0 deletions deps/adage/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# compiler and flags
CXX = g++
FLAGS = -g -Wno-deprecated -fPIC -fno-inline -Wno-write-strings
FLAGS += -fmax-errors=3
# FLAGS += -O0 # TODO: use optimization?

# ROOT
ROOT_INCLUDES := -I$(shell root-config --incdir)
ROOT_LIBS := $(shell root-config --glibs)

#-----------------------------------------------

# dirs
SRC_DIR := src
INC_DIR := include/adage
LIB_DIR := lib

# targets
ADAGE := Adage
LIB := $(LIB_DIR)/lib$(ADAGE).so
DICT := $(SRC_DIR)/$(ADAGE)Dict.cxx
PCM := $(ADAGE)Dict_rdict.pcm
LINKDEF := include/LinkDef.h

# sources
HEADERS := $(wildcard $(INC_DIR)/*.h)
SOURCES := $(filter-out $(DICT), $(wildcard $(SRC_DIR)/*.cxx)) $(DICT)

#-----------------------------------------------

$(LIB): $(SOURCES) $(HEADERS) $(LINKDEF)
@echo ">>>>> build $(ADAGE) library"
@echo " $(CURDIR)/$@"
$(CXX) $(SOURCES) -shared -o $@ $(FLAGS) -I$(INC_DIR) $(ROOT_INCLUDES) $(ROOT_LIBS)

$(DICT): $(HEADERS) $(LINKDEF)
@echo ">>>>> generate $(ADAGE) dictionary"
@echo " $(CURDIR)/$@"
@mkdir -p $(LIB_DIR)
@cd $(INC_DIR) && rootcling -f $(CURDIR)/$@ $(ROOT_INCLUDES) $(HEADERS:$(INC_DIR)/%=%) $(CURDIR)/$(LINKDEF)
@mv $(SRC_DIR)/$(PCM) $(LIB_DIR)

clean:
@echo ">>>>> clean $(ADAGE)"
$(RM) $(LIB) $(DICT) $(LIB_DIR)/$(PCM)
Loading

0 comments on commit 34e3321

Please sign in to comment.