README.md

GooFit is a massively-parallel framework, written using Thrust for CUDA and OpenMP, for doing maximum-likelihood fits with a familiar syntax.

What's new • Tutorials • API documentation • 2.0 upgrade • 2.1 upgrade • Build recipes • Python

Requirements

• A recent version of CMake is required. The minimum is 3.4, but tested primarily with 3.6 and newer. CMake is incredibly easy to install (see the system install page).
• A ROOT 6 build highly recommended -- GooFit will use the included Minuit2 submodule if ROOT is not found, and the Minuit1 based fitter will not be available.

If using CUDA: (click to expand)

• CMake 3.8+ highly recommended, but not required (yet)
• CUDA 7.0+
• An nVidia GPU supporting compute capability at least 2.0 (3.5+ recommended)

If using OpenMP: (click to expand)

• A compiler supporting OpenMP and C++11 (GCC 4.8+, Clang, and Intel 17 tested, GCC 4.7 not supported)
• Note that TBB is also available as a backend, but it still requires OpenMP to be present.
• On macOS, this backend requires brew install cliutils/apple/libomp or a custom compiler

If using CPP: (click to expand)

• Single threaded builds are available for debugging and development (such as on the default Clang on macOS)

A list of exact commands required for several platforms is available here.

There are also Python Bindings. This requires Python (2 or 3), NumPy, SciKit-Build, and CMake. You can uses pip install -v goofit, or pip install -v -e . inside the repository. You can also direcly force the bindings from a normal build with -DGOOFIT_PYTHON=ON. You can check your install with python -m goofit. You can debug a goofit file named python_script.py with gcc using gdb -ex r --args python python_script.py.

Getting the files

• Clone with git:

git clone git://github.com/GooFit/GooFit.git --recursive
cd GooFit

You can either checkout a tagged version, or stay on the master for the latest and greatest. There are often development branches available, too.

Building

If you just want to get started as fast as possible, running make, make omp, or make cuda in the main directory will make a build directory for you, and will run CMake and make. It is recommended that you instead direcly use the CMake powered build system as discribed below, so that you will have a better understanding of what you are doing and more flexibility.

The build system uses CMake. The procedure is standard for CMake builds:

mkdir build
cd build
cmake ..
make

If you don't have a modern CMake, Kitware provides installers for every OS. You can even get a copy using python: pip install cmake or locally with pip install --user cmake. On a Mac, you can also use any package manager, such as Homebrew: brew install cmake.

If you want to change compiler, set CC and CXX to appropriate defaults before you run CMake either inline or in your environment. You can also set CMAKE_C_COMPILER and CMAKE_CXX_COMPILER directly on the command line with -D. If you want to set the host and device backends, you can set those options. The defaults are:

cmake .. -DGOOFIT_DEVICE=CUDA -DGOOFIT_HOST=CPP

Valid options are CUDA (device only), OMP, TBB, and CPP. The Thrust TBB backend requires the Intel compiler. The default device is Auto, and will select CUDA if CUDA is found, OMP or CPP otherwise.

Other custom options supported along with the defaults:

• -DGOOFIT_DEVICE=Auto: The device to use for computation (CUDA, OMP, TBB, or CPP). Default setting of Auto looks for CUDA first, then OpenMP, then CPP.
• -DGOOFIT_ARCH=Auto: (Auto, Common, All, valid number(s) or name(s)): sets the compute architecture. See CUDA_SELECT_NVCC_ARCH_FLAGS.
• -DGOOFIT_EXAMPLES=ON: Build the examples
• -DGOOFIT_PACKAGES=ON: Build any packages found with the name goofit_*
• -DGOOFIT_DEBUG=ON and -DGOOFIT_TRACE=ON will enable the matching printout macros
• -DGOOFIT_PYTHON=ON: Include the python bindings using PyBind11 if Python found.

Advanced Options: (click to expand)

• -DGOOFIT_HOST=Auto: This is CPP unless device is OMP, in which case it is also OMP. This changes thrust::host_vector calculations, and is not fully supported when set to a non-default setting.
• -DGOOFIT_TESTS=ON: Build the GooFit tests
• -DGOOFIT_SEPARATE_COMP=ON: Enable separable compilation of PDFs. Single core CUDA builds are faster with this off. The off mode is not well supported, especially on newer cards.
• -DGOOFIT_MPI=ON: (OFF/ON. With this feature on, GPU devices are selected automatically). Tested with MVAPICH2/2.2 and OpenMPI.
• -DGOOFIT_CUDA_OR_GROUPSIZE:INT=128: This sets the group size that thrust will use for distributing the problem. This parameter can be thought of as 'Threads per block'. These will be used after running 'find_optimal.py' to figure out the optimal size.
• -DGOOFIT_CUDA_OR_GRAINSIZE:INT=7: This is the grain size thrust uses for distributing the problem. This parameter can be thought of as 'Items per thread'.
• -DGOOFIT_MAXPAR=1800: The maximum number of parameters to allow. May cause memory issues if too large.
• You can enable sanitizers on non-CUDA builds with -DSANITIZE_ADDRESS=ON, -DSANITIZE_MEMORY=ON, -DSANITIZE_THREAD=ON or -DSANITIZE_UNDEFINED=ON.
• If clang-tidy is available, it will automatically be used to check the source. If you set -DGOOFIT_TIDY_FIX=ON, fixes will be applied to the GooFit source.
• -DGOOFIT_SPLASH=ON: Controls the unicode splash at the beginning.

A few standard CMake tricks: (click to expand)

• Use make VERBOSE=1 to see the commands used to build the files.
• Use cmake .. -LH to list the CMake options with help.
• Use ccmake if available to see a curses (terminal) gui, or cmake-gui for a completely graphical interface.
• Use -G and the name of a generator to use something other than make, like Xcode or Ninja.
• Open the CMakeLists.txt with QtCreator to generate for that IDE.
• Set the release type with -DCMAKE_BUILD_TYPE=Release, RelWithDebInfo, Debug, etc.
• Set up multiple build directories, like build-omp and build-cuda.
• CMake caches your -D option selections in your build directory so you don't have to specify them again.
• CMake reruns when needed when you make unless you add a file that it globs for (like new goofit_projects).
• Use make -j12 to build with 12 cores (for example). You can set this as the MAKEFLAGS environment variable, too.
• Use CMake --build . to build without referring to your specific build tool, like make or ninja.
• If you are using the llvm tool-suite, you can use -DCMAKE_EXPORT_COMPILE_COMMANDS=ON to generate the .json file that the clang-* commands expect.

Running the examples and tests

• To run all the examples, with timing information, use:

./examples/RunAll.py
./pyexamples/RunAll.sh # Python

(This requires the Plumbum library, install with pip install plumbum, pip install --user plumbum, or conda -c conda-forge plumbum.)

If you want to run an individual example, those are in subdirectories in examples (built products are in your build directory, the source is in /examples).

The tests can be run with make test or ctest. The python bindings, if built, can be tested with pytest, run from the main build directory. The python examples and tests folders are linked to the build directory with a py prefix.

Other topics

Adding a new example: (click to expand)

The examples are designed to be easy to add to. Make a new directory, then add a new CMakeLists.txt in your directory with one or more of the following two lines:

goofit_add_directory()
goofit_add_executible(MyNewExample MyNewExample.cu)

The first line adds your .cu file with GooFit code as an executable, and the second one sets up a symbolic links to the source and dataFiles in the build directory to the source directory. If you prefer to only have some files symbolically linked, use goofit_add_link(filename.ext) explicitly for each file. This happens at configure time. To get the example to build when you build GooFit, add the name of your directory to examples/CMakeLists.txt.

If you are building with separable compilation, you can also use goofit_add_pdf(mypdf.cu) to add a PDF. This will also require that you include any directory that you need with include_directory, as usual.

To add packages, use standard CMake tools. For example (CMake 3.5+), to add Boost 1.49+ filesystem and TTreeReader from ROOT:

set(Boost_USE_STATIC_LIBS OFF)
set(Boost_USE_MULTITHREADED ON)
set(Boost_USE_STATIC_RUNTIME OFF)
find_package(Boost 1.49 REQUIRED COMPONENTS filesystem)

goofit_add_executable(K3Pi K3Pi.cu)
target_link_libraries(MyNewExample Boost::filesystem ROOT::TreePlayer)

Adding a new project: (click to expand)

If you'd like to make a separate GooFit project, you can do so. Simply checkout your project inside GooFit, with the name work or GooFit+something. CMake will automatically pick up those directories and build them, and GooFit's git will ignore them. Otherwise, they act just like the example directory. If you add a new directory, you will need to explicitly rerun CMake, as that cannot be picked up by the makefile. The automatic search can be turned off with the GOOFIT_PROJECTS option.

Using an IDE: (click to expand)

The following IDEs have been tested. Here $SRC refers to the source directory, and usually is .. or ../GooFit. You may want -DCMAKE_BUILD_TYPE=Debug and/or -DGOOFIT_DEBUG=ON.

Name	Platform	Setup	Notes
Xcode	macOS	cmake $SRC -GXcode	Only CPP version, works well though
Nsight-Eclipse	Linux	cmake $SRC -G "Eclipse CDT4 - Unix Makefiles"	Must be out-of-source, supports CUDA backend
QtCreator	All	Open from QtCreator dialog	Requires CMake extension (usually present). Might be able to use CMake 3.7+ Server
CLion	All	Open from CLion menu	Young but promising

Converting from older GooFit Code: (click to expand)

The build system underwent a major upgrade in the move to CMake. The folders that were introduced to keep the includes structured require modifications of source code, converting lines like #include "Variable.hh" to #include "GooFit/Variable.h". This modification can be done for you by running the provided script, scripts/ModernizeGooFit.py on your source files (requires Python and Plumbum). You should remove your old Makefiles and use the new CMakeFiles.txt files provided in examples - this should require writing two lines of code instead of the 50 or so previously needed. You should also add a GooFit Application to your code. (2 lines of CMake)

The new GooFit::Application, which is not required but provides GooFit options, like GPU selection and status, as well as MPI support and configurable command line options, is available by adding:

#include "GooFit/Application.h"
using namespace GooFit;

// Place this at the beginning of main
Application app{"Optional discription", argc, argv};

// Command line options can be added here.

GOOFIT_PARSE(app);

See CLI11 for more details. The pipipi0 example has an example of a complex set of options.

The other key differences in code are the addition of the GooFit namespace (using namespace GooFit allows fast conversion), and the removal of direct access to members of Variable (using getters/setters, or directly treat the variable like its value).

See Converting to GooFit 2.0, GooFit 2.1, and the Changelog.

Improving performance with MPI: (click to expand)

Using the MPI version with an appropriate environment setup will allow for multiple GPU's to be used, and/or allow for multiple nodes. To use this feature simply turn the flag on with CMake -DGOOFIT_MPI=ON. This will divide the dataset by the number of processes involved. For instance, if you have two nodes that will be involved in the calculation, the data will be split in half. Currently, each node will load the entire buffer from disk, then load partitioned data it will work on. It is highly recommended not to use more than one process per node for MPI+OpenMP versions.

A few notes about using the MPI version:

• You will need to use the CountingVariable for any event numbers used or referenced within the code, or anything that counts with the events.
• Please call setDataSize after setData. If you do not, setDataSize doesn't have m_iEventsPerTask, which will need to be recalculated.

Configuring group size and grain size: (click to expand)

This advanced option is for GPU devices only. The script scripts/find_optimal.py will search a programmable group and grain space in order to find the optimal configuration for the particular PDFs. This should be run after an example has been developed and tested. Please look at scripts/find_optimal.py to see how to formulate a particular script. Depending on the searchable space, this can take hours to days to compute.
The script will loop over the space and configure each parameter, then recompile and run the example a number of times. A spreadsheet is calculated to help notice patterns, and the fastest version is printed to the user.

Acknowledgement

GooFit's development is supported by the National Science Foundation under grant number 1414736 and was developed under grant number 1005530. Any opinions, findings, and conclusions or recommendations expressed in this material are those of the developers and do not necessarily reflect the views of the National Science Foundation. In addition, we thank the nVidia GPU Grant Program for donating hardware used in developing this framework.