Rivet is hosted by Hepforge, IPPP Durham

Getting started with Rivet

These instructions are aimed at users who want to install and run a release of Rivet.

If you are running on the CERN lxplus system, or any other system where the /afs/cern.ch/sw/lcg applications are usable, you should be able to use the LCG/Genser installation of Rivet without having to build it yourself: see the tutorial slides in our documentation area.

GettingStartedForDevelopers has some additional or replacement steps for people wishing to check out the development version from the repository and build from there.

Installation

If you are installing Rivet on an Apple Mac, please take a look at the MacInstallationIssues first.

The simplest Rivet installation uses a "bootstrap" script to install Rivet and all its dependencies from release tarballs. You can alternatively opt to use copies of the dependencies from the CERN AFS area if it is mounted on your system at /afs/cern.ch, cf. Installation with AFS below.

Installation of Rivet 2.x and all dependencies

Prerequisite Python header files are required. On Ubuntu, you can use this command to install the necessary files system-wide:

sudo apt-get install python-dev

1) Download the bootstrap script into a temporary working directory, and make it executable:

  cd /scratch/rivet
  wget http://rivet.hepforge.org/hg/bootstrap/raw-file/2.5.4/rivet-bootstrap
  chmod +x rivet-bootstrap

(Replace the version string as appropriate if you want to install other versions of Rivet 2.x, and get rivet-bootstrap-lcg if you want the version that tries to use installations of HepMC, FastJet? and Boost from the LCG AFS areas.)

2) Check the options. Look at the header of the script to see all variables which you can set, e.g. to skip installation of certain dependencies (boost, gsl, ...) if they are available in your system:

  less rivet-bootstrap ## and read...

3) Run the script. By default it will install to $PWD/local, where $PWD is the current directory. If you need to change that, specify the corresponding values on the command line. Examples:

./rivet-bootstrap
  # or
INSTALL_BOOST=0 BOOSTPATH=/usr/local ./rivet-bootstrap
  # or
INSTALL_PREFIX=$HOME/software/rivet MAKE="make -j8" ./rivet-bootstrap

We will refer to the installation root path as $PREFIX.

If you have trouble with the Boost library (hopefully you won't) see TroubleshootingBoost.

Alternative: Installation with AFS

The description below is based on a build from CERN's lxplus6 SLC6 machines.

1) Download the bootstrap-lcg script into a temporary working directory, and make it executable:

  cd /scratch/rivet
  wget http://rivet.hepforge.org/hg/bootstrap/raw-file/2.5.4/rivet-bootstrap-lcg
  chmod +x rivet-bootstrap-lcg

2) Check/edit the script. Look in the script to see its target setup and make edits if you need to: you may want to change the LCG tag, the compiler environment that is set up, whether LCG packages are to be used from AFS, and the install and build locations:

  less rivet-bootstrap-lcg ## and read...
  nano rivet-bootstrap-lcg ## and edit...

3) Run the script. By default it will install to $PWD/local, where $PWD is the current directory. If you need to change that, edit the file as above.

./rivet-bootstrap-lcg

We will refer to the installation root path as $PREFIX.

If you have trouble with the Boost library (hopefully you won't) see TroubleshootingBoost.

Setting up the environment

After the script grinds away for a while, it will tell you that it is finished and how to set up a runtime environment (similar to that used inside the build script) for running Rivet. A sourceable rivetenv.(c)sh script is provided for (c)sh shell users to help set up this environment. Here's how to set up the environment and then test the rivet program's help feature and analysis listing:

  source $PREFIX/rivetenv.sh
  rivet --help
  rivet --list-analyses

If that works, everything is installed correctly. If you are using the bash shell in your terminal, then Rivet will offer you programmable tab completion: try typing rivet and pressing the Tab key!

You may wish to add the environment variable settings to your ~/.bashrc shell config file, so that Rivet will work without needing any special session setup.

You can now check out the FirstRivetRun guide.

Alternative2: Installation with docker

Please see the instructions given here: https://rivet.hepforge.org/trac/wiki/Docker

Problems?

If you're having trouble, there may well be some relevant help on the TroubleShooting page.

Last modified 5 weeks ago Last modified on Jun 18, 2017, 2:15:03 PM