General Information
===================

BDSIM version 0.6, Geant4 toolkit for radiation transport in accelerators

The official web site is:
        http://www.rhul.ac.uk/physics/research/particlephysics/johnadamsinstitute/bdsim.aspx

The official twiki site is 
	https://twiki.ph.rhul.ac.uk/twiki/bin/view/PP/JAI/BdSim

The official Geant4 web site is:
	http://geant4.web.cern.ch/geant4/

The official mailing list:
        BDSIM@jiscmail.ac.uk
        subscription at https://www.jiscmail.ac.uk/cgi-bin/webadmin?A0=BDSIM

Written by G.A. Blair (g.blair@rhul.ac.uk)

Maintained by Lawrence Deacon (l.deacon@cern.ch),
and Jochem Snuverink (jochem.snuverink@rhul.ac.uk)
and Stewart Boogert (stewart.boogert@rhul.ac.uk) 

History
==================

v0.6 : 02.12.13
v0.5 : 30.05.08
v0.4 : 25.02.08
v0.3 : 26.01.07
v0.2 : 18.05.06
v0.1 : 15.11.05 
Beta : 05.05.05


Installation
===================

System requirements:

tested on:
    os: Linux (Scientific Linux Cern 5 and 6), Mac OS 10.x 
    architecture: x86_64
    compiler: gcc 4.x
   
mandatory:
    Geant versions greater than Geant4.8.0

    CLHEP (recommended version 2.1.3.1 or 2.1.0.1 for Geant4 versions 9.5 or smaller)

optional: 
    OpenGL (Mesa), ROOT 4.x, 5.x  

to compile, see https://twiki.ph.rhul.ac.uk/twiki/bin/view/PP/JAI/BDsimInstall

   %  mkdir build
   %  cd build
   %  cmake ..
   %  make
   %  make install

Getting Started
===================

to run:
    bdsim [options]

f.e. 
    bdsim --file=line.gmad --output=root

to see the full list of options:

    bdsim --help


Some input examples are available in ./examples/ directory. 
For more details consult documentation

Directories
===================

parser/          : gmad parser
examples/        : sample lattices
docs/            : documentation
utils/           : various "useful" scripts