Hall A Analyzer

h1. ROOT Installation Guide

{{toc}}

"ROOT":https://root.cern is an advanced software package developed at "CERN":https://home.cern, the European Organization for Nuclear Research. It is widely used for data analysis and visualization in high-energy physics and nuclear physics as well as other fields.

ROOT can easily run on any modern laptop. You will need at least 2 GB of memory (4 GB recommended) and about 1 GB of disk space (2-3 GB if building from source). 

Installing the software varies in difficulty from very easy to fairly high, depending on whether or not your computer is one of the "supported platforms":https://root.cern/supported-platforms. In general, there are three typical ways to get ROOT:

# A set of pre-compiled packages provided by your operating system's package manager

** Very easy to install and almost certain to work well

** Easy updating to new versions

** Generally requires administrative privilege on your machine

** Recommended approach, if possible

# A pre-compiled "binary distribution package":https://root.cern/content/release-61206 provided by the ROOT team.

** Easy, but there is a certain risk of problems due to unexpected incompatibilities

** Only available for the most recent operating system versions

** May be installed privately without administrative privilege

** Requires manual updating

# Building from "source":https://root.cern/building-root

** Moderately difficult. Experience with building large software packages recommended.

** Can take several hours to build. Cannot be done while running on laptop battery power.

** Configuration can be tricky. Updating is a time-consuming manual process.

** Missing dependencies are detected during configuration and may need to be installed separately

** Gives access to all ROOT features, including very advanced ones (not generally needed)

The current version of ROOT is 6.12/06 at the time of his writing. Following are instructions to get up and running quickly with this version, if possible, on specific operating systems based on our experience.

h2{background:#D5D8DC}. Linux

h3. Red Hat Enterprise Linux (RHEL) 7, CentOS 7 and compatible

# Enable the "EPEL":https://fedoraproject.org/wiki/EPEL (Extra Packages for Linux) repository. Follow the "EPEL Quickstart instructions":https://fedoraproject.org/wiki/EPEL#Quickstart.

# Install the core ROOT package. This will install the most commonly used libraries. More packages are available if you need advanced features later.

<pre>

sudo yum install root

</pre>

# To work with ROOT from within Python 3, also install python34-root. This will automatically install python 3.4 as well:

<pre>

sudo yum install python34-root

</pre>

h3. Fedora

For Fedora 24 and higher, ROOT 6 is available in the main Fedora repository. The current version of ROOT, 6.12/06, requires at least Fedora 26. Simply do

<pre>

sudo yum install root

sudo yum install python3-root

</pre>

For Fedora 20-22, CERN offers binary distributions of older versions of ROOT:

* "ROOT 6.08/06 for Fedora 22":https://root.cern/download/root_v6.08.06.Linux-fedora22-x86_64-gcc5.3.tar.gz

* "ROOT 6.06/08 for Fedora 21":https://root.cern/download/root_v6.06.08.Linux-fedora21-x86_64-gcc4.9.tar.gz

* "ROOT 6.06/08 for Fedora 20":https://root.cern/download/root_v6.06.08.Linux-fedora20-x86_64-gcc4.8.tar.gz

See [[Installing ROOT from a CERN binary distribution|installing a binary distribution]] for instructions.

h3. Ubuntu

At present, Ubuntu repositories only offer ROOT 5 packages, which should be considered obsolete. Do not install these. To get ROOT 6 on Ubuntu 14, 16 or 17, download and install the appropriate binary release from CERN:

* "ROOT 6.12/06 for Ubuntu 17":https://root.cern/download/root_v6.12.06.Linux-ubuntu17-x86_64-gcc7.2.tar.gz

* "ROOT 6.12/06 for Ubuntu 16":https://root.cern/download/root_v6.12.06.Linux-ubuntu16-x86_64-gcc5.4.tar.gz

* "ROOT 6.12/06 for Ubuntu 14":https://root.cern/download/root_v6.12.06.Linux-ubuntu14-x86_64-gcc4.8.tar.gz

See [[Installing ROOT from a CERN binary distribution|installing a binary distribution]] for instructions.

h3. Arch Linux, Debian, and other Linux varieties with at least gcc 4.8

[[Building ROOT from source|Build ROOT from source]].

h3. RHEL6, CentOS 6 and older Linux distributions

ROOT 6 cannot be installed easily on these systems, not even from source, because the system compiler is too old. (ROOT 6 requires a fully C++11-capable compiler.) Pre-built ROOT 5 packages are available, however.

Of course, it is possible to run ROOT 6 even on quite old Linux systems. One needs to install a modern compiler first, build ROOT from source using that compiler, and run ROOT with that compiler's runtime libraries. This procedure is beyond the scope of this document, however.

h2{background:#D5D8DC}. macOS

Before attempting to install ROOT, please set up the Xcode command line tools (unless already done). From a Terminal, run

<pre>

$ xcode-select --install

</pre>

Once this command completes, you should have a working compiler:

<pre>

$ g++ --version

Configured with: --prefix=/Applications/Xcode.app/Contents/Developer/usr --with-gxx-include-dir=/usr/include/c++/4.2.1

Apple LLVM version 9.0.0 (clang-900.0.39.2)

...

</pre>

A quick way to get ROOT on macOS/OSX 10.8-10.13 is to download the appropriate binary distribution from CERN:

* "ROOT 6.12/06 for macOS 10.13":https://root.cern/download/root_v6.12.06.macosx64-10.13-clang90.tar.gz

* "ROOT 6.12/06 for macOS 10.12":https://root.cern/download/root_v6.12.06.macosx64-10.12-clang90.tar.gz

* "ROOT 6.10/08 for macOS 10.11":https://root.cern/download/root_v6.10.08.macosx64-10.11-clang80.tar.gz

* "ROOT 6.08/06 for macOS 10.10":https://root.cern/download/root_v6.08.06.macosx64-10.10-clang70.tar.gz

* "ROOT 6.06/08 for macOS 10.9":https://root.cern/download/root_v6.06.08.macosx64-10.9-clang60.tar.gz

* "ROOT 6.04/06 for macOS 10.8":https://root.cern/download/root_v6.04.06.macosx64-10.8-clang51.tar.gz

See [[Installing ROOT from a CERN binary distribution|installing a binary distribution]] for instructions.

However, please note that using versions of ROOT older than 6.08 is discouraged as those releases were quite buggy. If you still run an old version of macOS, it may be better to get the latest ROOT release and [[Building ROOT from source|build from source]].

ROOT is also available from "Homebrew":https://brew.sh (package root) and "MacPorts":https://www.macports.org (package root6). For example, you can install it from Homebrew on macOS 10.11-10.13 as follows:

# Install Homebrew (skip if you have already done that before):

<pre>

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

</pre>

Follow the text prompts to complete the installation.

# With Homebrew set up, installing ROOT and Python 3 is now very easy:

<pre>

brew install root python

</pre>

Homebrew's ROOT comes with support for Homebrew's Python 3, while the CERN binary distributions support Apple's native Python 2. However, CERN's binary releases are built with more features enabled.

h2{background:#D5D8DC}. Windows

ROOT 6 is not supported on Windows platforms. However, CERN maintains a Docker image (based on Ubuntu 16) that should allow you to run a ROOT indirectly under Windows 10 Professional 64-bit. Detailed instructions can be found on "Docker Hub":https://hub.docker.com/r/rootproject/root-ubuntu16. This is an advanced procedure.

Alternatively, you can download and install "VirtualBox":https://www.virtualbox.org and run our "CentOS 7 virtual machine image":http://hallaweb.jlab.org/data_reduc/AnaWork2017/VirtualBox, which has ROOT pre-installed. You will also find installation instructions there. Unfortunately, this requires a large download, about 30 GB of disk space for the uncompressed VM image, and at least 4 GB, preferably 8 GB, of memory on your host computer. However, you'll be independent of remote computers, similar to the Docker image.

As a second alternative, install an "X server":https://sourceforge.net/projects/xming on your Windows machine, then use "PuTTY":https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html with X forwarding enabled to connect to a Unix (or macOS) machine via ssh. At JLab, you could connect to the central ifarm machines, for example. Then run ROOT on the remote machine. This requires a fast network connection.

A third and perhaps best alternative is to run a "VNC server":http://tigervnc.org session on a Unix (or macOS) machine that you have access to and where ROOT is installed (e.g. ifarm). Then connect to that session with a "VNC client":https://www.realvnc.com/en/connect/download/viewer/windows on Windows.

h2{background:#D5D8DC}. Testing your installation

If you installed ROOT from your distribution's package manager, or from Homebrew/MacPorts, no setup should be necessary to start using the software. Just type @root@, and you should see this:

<pre>

shell prompt$ root

   ------------------------------------------------------------

  | Welcome to ROOT 6.12/06                http://root.cern.ch |

  |                               (c) 1995-2017, The ROOT Team |

  | Built for macosx64                                         |

  | From tag v6-12-06, 9 February 2018                         |

  | Try '.help', '.demo', '.license', '.credits', '.quit'/'.q' |

   ------------------------------------------------------------

root [0] 

</pre>

If you installed a binary distribution or from source, you will need to run a setup script first:

<pre>

source <dir-where-you-installed-root>/bin/thisroot.sh

</pre>

or, if you are using @tcsh@

<pre>

source <dir-where-you-installed-root>/bin/thisroot.csh

</pre>

After doing so, the @root@ command should be available, and you can start ROOT as shown above.

Now you can type

<pre>

root [0] .demo

</pre>

at the ROOT prompt for a flashy demonstration of some of ROOT's graphics capabilities.

It is probably a good idea to set up ROOT from your shell's login script. To do so, simply put the above "source" command near the end of your @~/.bash_profile@ (or @~/.login@ for @csh/tcsh@).

Sourcing the setup script is also necessary on the JLab ifarm systems. There, you can find various ROOT versions installed under @/apps/root@. For example, to use the latest version, do

<pre>

ifarm1402.jlab.org$ source /apps/root/6.12.04/bin/thisroot.csh

</pre>

Then proceed as described above to test ROOT.

Sometimes it is interesting to find out more details about the installation of ROOT that you are working with. ROOT provides a command called @root-config@ for this purpose. For example, to show which "features" (capabilities) ROOT was compiled with, run @root-config --features@. Here is an example from JLab's RHEL7 ifarm systems, which you can run after setting up ROOT as described in the preceding paragraph:

<pre>

ifarm1402.jlab.org$ which root-config

/u/apps/root/6.12.04/root/bin/root-config

ifarm1402.jlab.org$ root-config --features

asimage astiff builtin_afterimage builtin_ftgl builtin_gl2ps builtin_glew builtin_llvm builtin_lz4 builtin_tbb

builtin_unuran cling cxx11 exceptions explicitlink fftw3 gdml genvector http imt mathmore minuit2 mysql opengl

pch pgsql python qt roofit shared soversion sqlite ssl thread tmva unuran x11 xft xml

</pre>

Some of these items are self-explanatory, others probably obscure. Consult the ROOT documentation for a full description.

h2{background:#D5D8DC}. Python support

You can see "python" in the "feature list" above, indicating support for Python 2. We can check this further:

<pre>

ifarm1402.jlab.org$  root-config --python-version

2.7

</pre>

This version of ROOT therefore has support for Python 2.7. We can try it out:

<pre>

ifarm1402.jlab.org$  python -c 'import ROOT'

</pre>

If this finishes without error, this version of Python will probably work correctly with this version of ROOT. However, be careful; sometimes multiple versions of Python are installed on the same machine. On ifarm, there are two Python 2.7 versions:

<pre>

ifarm1402.jlab.org$  which python

/apps/bin/python

ifarm1402.jlab.org$  /apps/bin/python --version

Python 2.7.12

ifarm1402.jlab.org$  /usr/bin/python --version

Python 2.7.5

</pre>

In this case, do not be completely surprised if your Python/ROOT experience turns out to be a bit bumpy and be prepared to file a bug report. On your personal system, try to make sure that only one version is installed.