# ============================================================================ #
#                                                                              #
#   Readme                                                                     #
#   ========                                                                   #
#   This is a brief description of the contents of the directory               #
#                                                                              #
#   /afs/cern.ch/user/g/goldfarb/POOL/standalone                               #
#                                                                              #
#   which contains software and tools for installing and running simple        #
#   example POOL database writer and reader executables.  The writer           #
#   instantiates a simple object and writes it to a POOL database.   The       #
#   reader retrieves the object and prints some of its contents.               #
#                                                                              #
#   Requirements                                                               #
#   ==============                                                             #
#   This exercise is "standalone", in that it does not depend on any           #
#   software framework or building environment.  Installation proceeds via     #
#   a Makefile.  It is built in the CERN afs environment and only runs         #
#   for now on lxplus (RedHat 7.3, gcc3.2).  Of course, it depends on POOL     #
#   and SEAL.                                                                  #
#                                                                              #
#   Known Anomolies                                                            #
#   =================                                                          #
#   "gmake runWriter" and "gmake runReader" always rebuild the writer and      #
#   reader executables, for no apparent reason.  Advice from a Makefile        #
#   specialist is welcome.                                                     #
#                                                                              #
#   Future Development                                                         #
#   ====================                                                       #
#   SimpleWriter will evolve to ModularWriter, which will contain              #
#   initialize(), write(), and finalize() methods.  This will allow one        #
#   to open the database at the beginning of a run, loop over the data to      #
#   write, and then terminate at the end of the run.                           #
#                                                                              #
#   Authors                                                                    #
#   =========                                                                  #
#   Steven Goldfarb (Steven.Goldfarb@cern.ch)                                  #
#   Ioannis Papadopoulos (Ioannis.Papadopoulos@cern.ch                         #
#                                                                              #
# ============================================================================ #

This directory
================

/afs/cern.ch/user/g/goldfarb/POOL/standalone
/afs/cern.ch/atlas/project/muon/software/database/goldfarb/POOL/standalone

Under this directory
======================
.
|-- Makefile                               Documented GNU Makefile
|-- MuonConditions                         Package containing user classes
|   |-- MuonConditions                     Headers of user classes
|   |   `-- MdtAlignmentParams.h           A specific example header file
|   |-- dict                               LCG dictionary objects
|   |   |-- MdtAlignmentParams.xml         Generated by lcgdict on header file
|   |   |-- MdtAlignmentParams_dict.cpp    Generated by lcgdict on header file
|   |   `-- classes.xml                    Built by hand (ask LCG expert)
|   |-- rh73_gcc32                         User binaries
|   |   `-- lib                            User libraries
|   |       |-- libMuonConditions.so       Library built from user source
|   |       `-- libMuonConditionsDict.so   Library built from dictionary
|   `-- src                                Source of user classes
|       `-- MdtAlignmentParams.cxx         A specific example class
|-- MuonConditionsApps                     Package containing example writer/reader
|   |-- MuonConditionsApps                 Headers of writer/reader classes
|   |   |-- SimpleReader.h                 Reads a user object from POOL
|   |   `-- SimpleWriter.h                 Writes a user object to POOL
|   |-- rh73_gcc32                         Writer/Reader binaries
|   |   `-- lib                            Writer/Reader libraries/executables
|   |       |-- SimpleReader.exe           Reader executable
|   |       `-- SimpleWriter.exe           Writer executable
|   `-- src                                Writer/Reader source
|       |-- SimpleReader.cxx               An example simple reader
|       `-- SimpleWriter.cxx               An example simple writer
|-- MuonConditionsCatalog.xml              Generated by writer with DB file info
|-- MuonConditionsCatalog.xml.BAK          Backup of above
|-- MuonConditionsData.root                The database file
|-- Readme                                 This file, dummy
`-- setup.sh                               Sets up gcc3.2 environment
                                           (do . setup.sh before using Makefile!)