Skip to content

Latest commit

 

History

History
112 lines (81 loc) · 5.15 KB

README.md

File metadata and controls

112 lines (81 loc) · 5.15 KB
Raw

Welcome to BlueFin

BlueFin is a software package for Best Linear Unbiased Estimate Fisher Information aNalysis.

Download

The central software repository for this package is now hosted on https://github.com/valassi/bluefin.

An older mirror (which may not be up to date) is still kept on https://gitlab.cern.ch/valassi/bluefin.

To download the latest version of the software:

Build

The software is built using CMake.

To build the software, some external packages such as Boost, ROOT and tbb are needed. You have two options:

  1. Set up and build using the 'LCG view' software installed on cvmfs, using the scripts provided for this purpose.
  2. Set up and build using your own preferred Boost, ROOT and tbb installations.

Build against LCG views

This option is supported on SLC6 and CC7 machines with cvmfs installed, such as lxplus6 and lxplus7 at CERN.

Set up the LCG views appropriate to your O/S, build the software and set up its runtime environment:

bash
. setupLCG.sh
make 
eval `make -f ./Makefile setup_sh`

This will create all relevant libraries and binaries in a separate build directory:

  • build.x86_64-slc6-gcc493-opt on slc6, using the LCG view /cvmfs/sft.cern.ch/lcg/views/LCG_72a/x86_64-slc6-gcc49-opt
  • build.x86_64-centos7-gcc1030-opt on centos7, using the LCG view /cvmfs/sft.cern.ch/lcg/views/LCG_101/x86_64-centos7-gcc10-opt

It will also add the build directory to the $PATH and $LD_LIBRARY_PATH environment variables.

Build against specific installations of Boost, ROOT and tbb

The following is an example on centos7, using individual Boost, ROOT and tbb installations in the LCG stack.

You need to use a compiler and a set of compilation options compatible with those used for your chosen installations of ROOT and Boost.

The following example uses ninja instead of GNU make.

bash
. /cvmfs/sft.cern.ch/lcg/contrib/gcc/10.3.0/x86_64-centos7/setup.sh
export PATH=/cvmfs/sft.cern.ch/lcg/contrib/CMake/3.23.1/Linux-x86_64/bin:${PATH}
export PATH=/cvmfs/sft.cern.ch/lcg/contrib/ninja/1.10.0/Linux-x86_64:${PATH}
export LD_LIBRARY_PATH=/cvmfs/sft.cern.ch/lcg/releases/LCG_101/Boost/1.77.0/x86_64-centos7-gcc10-opt/lib:${LD_LIBRARY_PATH}
export LD_LIBRARY_PATH=/cvmfs/sft.cern.ch/lcg/releases/LCG_101/ROOT/6.24.06/x86_64-centos7-gcc10-opt/lib:${LD_LIBRARY_PATH}
export LD_LIBRARY_PATH=/cvmfs/sft.cern.ch/lcg/releases/LCG_101/tbb/2020_U2/x86_64-centos7-gcc10-opt/lib:${LD_LIBRARY_PATH}
export CMAKE_PREFIX_PATH=/cvmfs/sft.cern.ch/lcg/releases/LCG_101/Boost/1.77.0/x86_64-centos7-gcc10-opt:${CMAKE_PREFIX_PATH}
export CMAKE_PREFIX_PATH=/cvmfs/sft.cern.ch/lcg/releases/LCG_101/ROOT/6.24.06/x86_64-centos7-gcc10-opt:${CMAKE_PREFIX_PATH}
export CMAKEFLAGS="-GNinja -DCMAKE_VERBOSE_MAKEFILE=ON -DCMAKE_CXX_FLAGS='-std=c++14 -m64' -DCMAKE_BUILD_TYPE=Release"
export VERBOSE=1
make

BUILDDIR=$(make print-BUILDDIR)
export PATH=${BUILDDIR}:${PATH}
export LD_LIBRARY_PATH=${BUILDDIR}:${LD_LIBRARY_PATH}

The bluefin executable

The package provides a software library, as well as an executable that builds a pdf report from an input data file in text format.

To use the bluefin executable, look at its usage:

  bluefin -h

  Usage: bluefin [options] [<indir>/]<infile>.bfin
    Available options:
      -h           - print help message and exit
      -T           - skip latex
      -q           - quiet latex (omit latex logs from bluefin logs)
                     [noop if -T is specified]
      -o <outdir>  - store/overwrite <infile>.pdf and <infile>_bluefin.log in <outdir>
                     [default: use the input directory <indir>]
      -t <texdir>  - store/overwrite tex and other temporary files in <texdir>
                     [default: use a temporary directory]
                     [noop if -T is specified]
      -c (0..2)    - covariance printout: 0=none, 1=full, 2=all (full and partial)
                     [default: 2=all]
      -M (0..4)    - minimizations: 0=none, 1+=ByGlobFac, 2+=ByErrSrc, 3+=ByOffDiag, 4+=ByOffDiagPerErrSrc
                     [default: 3=all but the experimental ByOffDiagPerErrSrc]

You need to have a reasonably complete installation of pdflatex, such as those available on lxplus6 and lxplus7 at CERN.
On slc6 and centos7, yum install texlive should be enough.

Some examples of using bluefin are in the tests.sh script.

Additional documentation

The ideas behind BlueFin are documented in the following article:

For more details please refer to the documentation on this TRAC site.

  • You may browse the source code of BlueFin on gitlab.
  • Minimal release notes are available in the release.notes file.
  • An input data file example is available in the xsePaper4.bfin file.
  • The corresponding pdf report for this example is available in the xsePaper4.pdf file.

Contact

Please report any problems to Andrea Valassi(at)cern.ch.