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 121 (modified by Andy Buckley, 7 years ago) (diff)


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.


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

The simplest Rivet installation from source uses a "bootstrap" script to install Rivet and its dependencies from release tarballs. The script can also try to use copies of the dependencies from the CERN AFS area if it is mounted on your system at /afs/cern.ch -- this is the default behaviour. The description below is based on a build from CERN's lxplus6 SLC6 machines.

If you wish, you can of course do everything the script does, by hand. You will need to do this if wanting to use a development version of Rivet from our version control repository. See ManualInstallation for details.

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/tip/rivet-2-bootstrap
  chmod +x rivet-2-bootstrap

or for Rivet 1.x:

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

(From now on we'll just call this script rivet-bootstrap to avoid repeating ourselves.)

2) Look in the script 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 ## and read...
  nano rivet-bootstrap ## 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.


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

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

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

source 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.


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