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 111 (modified by Andy Buckley, 11 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 from source uses a "bootstrap" script to install Rivet, 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 into a temporary working directory, and make it executable:
      cd /scratch/rivet
      wget http://svn.hepforge.org/rivet/bootstrap/rivet-bootstrap
      chmod +x rivet-bootstrap
  1. Run the script, with your chosen installation directory (e.g. $HOME/local) as an optional argument. By default the script will install to $PWD/local, where $PWD is the current directory. You can get usage information with
      ./rivet-bootstrap --help

and then to install, run

  ./rivet-bootstrap --prefix=$HOME/local

or just


to install to $PWD/local. We will refer to the installation root path as $PREFIX.

  1. After the script grinds away for a while, it will tell you about some system environment variables which you may wish to set for more convenient usage of Rivet: these are the system PATH (for finding the executables), LD_LIBRARY_PATH (for finding the libraries), and PYTHONPATH (for finding the Python library modules). If installing to a system location, such as usr/local, you probably won't have to set these. If you wish to run generators via AGILe, then you may also need to set AGILE_GEN_PATH, which is used to find generator libraries in the structure used by [LCG Genser](http://lcgapp.cern.ch/project/simu/generator/) MC library archive, as used by the LHC experiments.

After these are set, try running the rivet program with the -h flag to get some help:

  rivet -h

If that works, everything is installed correctly. If you are using the bash shell in your terminal, then you can make use of the Rivet programmable tab completion by sourcing the installed rivet-completion script:

  . $PREFIX/share/Rivet/rivet-completion

You can now check out the FirstRivetRun guide, unless you want to use generators via AGILe.

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

  1. Optionally, you can also test the AGILe generator interface library at this stage. Unfortunately you will currently have to build this by hand, since it's less commonly needed than Rivet is, but there are instructions on the AGILe home page. Once it's set up, try running agile-rungen -h. A bash completion script, similar to that for Rivet, can be sourced with
      . $PREFIX/share/AGILe/agile-completion

To see if agile-runmc can find any generators to run, execute this command:

  agile-runmc --list-gens

If no generator names are returned, you need to set up a local mirror of the Genser generators archive. Instructions for this can be found at GenserMirror. If you have already done this, and still get no generators in the listing, you should check that your $AGILE_GEN_PATH environment variable is pointing to the correct path.

If at least one generator is listed, you can try to generate a few events in LHC mode, e.g.:

  agile-runmc Pythia6:418 --beams pp:14TeV

Manual installation

If you wish, you can of course do everything the script does, by hand. See ManualInstallation for details.