rivet is hosted by Hepforge, IPPP Durham
close Warning: Can't synchronize with repository "(default)" (Repository path '/hepforge/hg/rivet/public/rivet' does not exist.). Look in the Trac log for more information.

Version 98 (modified by Jon Butterworth, 13 years ago) (diff)


Getting started with Rivet

These instructions are aimed at users who want to install and run a release of Rivet. GettingStartedForDevelopers has some additional or replacement steps for people wishing to check out the development version from the repository and build from there.

Rivet installation instructions

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

Automated installation

The simplest Rivet installation uses a script to install Rivet and the AGILe generator interface library, plus some dependency libraries if required. The script will also try to use copies of the dependencies from the CERN AFS area, if it is mounted on your system at /afs/cern.ch. Due to some issues with the CERN system, it is very recommended that you use the script installation to get Rivet working at CERN.

  1. Download the bootstrap script from http://svn.hepforge.org/rivet/bootstrap/rivet-bootstrap , and make it executable e.g.
    > wget http://svn.hepforge.org/rivet/bootstrap/rivet-bootstrap
    > chmod a+x rivet-bootstrap
  1. Pick an installation directory, e.g. $HOME/local for the libraries and executables to be installed to.
  1. Run the script, with the installation directory as an optional argument. By default the script will install to $PWD/local, where $PWD is the current directory:
    > ./rivet-bootstrap $HOME/local

or just

> ./rivet-bootstrap

if $PWD/local is a suitable installation location.

  1. After the script grinds away for a while, it will present you with a set of environment variables which need to be set. After these are set (you can just copy and paste the example into a bash session), try running rivetgun with the -h flag to get some help:
    > rivetgun -h

If the help stage does not list any generators to go with the -g option, then you need to set up a local mirror of the Genser generators archive. Instructions for this can be found at GenserMirror.

  1. If/when you have available generators according to the rivetgun help listing, then try generating a few events in the default (LHC) mode:
    > rivetgun -g FPythia:6413

Manual installation

The manual installation will be harder work: we advise running ./configure --help while building packages to get a guide to the various ways in which you can influence the build.

  1. Create a directory (e.g. named $HOME/cedar/local) to contain the created libraries.
  1. First install the related packages. If they are installed already on your system, you can use them as long as you tell the Rivet configuration where they are. We recommend using the latest available version of each package. The versions given below represent the latest version we have tested. Older versions may work too, but why use them when they probably have bugs which are fixed in later versions...
  1. HepMC version 2.03.04 (or later) from http://lcgapp.cern.ch/project/simu/HepMC/download/ then do:
           tar xvzf HepMC-X.Y.Z.tar.gz
           cd HepMC-X.Y.Z
           ./configure --prefix=[path_to_my_local_directory]
           make install  
           cd ..
  1. fastjet from http://www.lpthe.jussieu.fr/~salam/fastjet/ then do:
           tar xvzf fastjet-X.Y.tar.gz
           cd fastjet-X.Y
           ./configure --prefix=[path_to_my_local_directory]
           make install
           cd ..
  1. Optional. If you want to use the RivetGun main program and the CEDAR generator interfaces, you need to get the latest AGILe tarball from http://www.hepforge.org/downloads/agile (see notes below)
           tar xvfz AGILe-{version}.tar.gz
           cd AGILe-{version}
           ./configure --prefix=[path_to_my_local_directory] 
           make install
           cd ..
  1. Optional: If you want to output root histograms or trees, you'll need to install the root headers and libraries and set the ROOTSYS and LD_LIBRARY_PATH variables as outlined in the root installation instructions (see http://root.cern.ch). You should then add the flag --with-root to the ./configure command below.
  1. Some Linux distributions do not include the GNU Scientific Library (GSL). In these cases it will be necessary to download and install GSL from http://www.gnu.org/software/gsl/. You may also be able to install GSL as an optional system package: you won't need the GSL headers, but it may anyway be necessary (e.g. on Scientific Linux systems) to install the GSL development package, perhaps named something like libgsl-devel, to get a useable copy of the library file.
  1. Rivet latest tarball from http://www.hepforge.org/downloads/rivet (see note below)
           tar xvfz Rivet-{version}.tar.gz
           cd Rivet-{version}
           ./configure --prefix=[path_to_my_local_directory] 
           make install
           cd ..
  1. The same points as for the automatic installation's access to generators apply to the manual installation. Have a look at GenserMirror for information on getting a mirror of the Genser generator archive set up and made known to AGILe (and hence rivetgun.)

Running Rivet

To run Rivet, you'll need to link to a main program. Within CEDAR we use RivetGun; to see how to get started with this, follow these instructions.