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

BDSIM version 0.992, Geant4 toolkit for radiation transport in accelerators

The official web site is:
	http://www.pp.rhul.ac.uk/bdsim

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

Currently maintained and developed by (alphabetically):

Andrey Abramov        <andrey.abramov.2012@live.rhul.ac.uk>
Stewart Boogert       <stewart.boogert@rhul.ac.uk>
Lawrence Deacon       <ucaplde@ucl.ac.uk>
Hector Garcia Morales <hector.garciamorales@rhul.ac.uk>
Stephen Gibson        <stephen.gibson@rhul.ac.uk>
Laurie Nevay          <laurie.nevay@rhul.ac.uk> (main contact)
Will Shields          <william.shields.2010@live.rhul.ac.uk>
Jochem Snuverink      <jochem.snuverink@psi.ch>
Stuart Walker         <stuart.walker.2011@live.rhul.ac.uk>

Originally written by G.A. Blair

History
=======

v0.99: 09.06.17
v0.95: 07.11.16
v0.94: 14.09.16
v0.93: 24.08.16
v0.92: 29.03.16
v0.91: 17.12.15
v0.9 : 10.11.15
v0.8 : 10.08.15
v0.7 : 30.06.15
v0.65: 10.04.15
v0.64: 16.02.15
v0.63: 06.02.15
v0.62: 07.08.14
v0.61: 05.08.14
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 6), Mac OS 10.10 onwards
    architecture: x86_64
    compiler: gcc 4.9, clang 6 (fully c++ 11 compliant)
   
mandatory:
    Geant versions Geant4.10 or greater (10.3.p01 recommended)
    Latest patch version recommended of any 10.X version.

    CLHEP (recommended version 2.1.3.1 or greater)

    ROOT 6.x

optional: 
    OpenGL

To compile, see http://www.pp.rhul.ac.uk/bdsim/manual/installation.html

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

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

To run:
    bdsim [options]
 
    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 on http://www.pp.rhul.ac.uk/bdsim/manual/

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

analysis/        : analysis tools
cmake/           : cmake configuration files
comparator/      : tool for comparison of results
configuration/   : software version information for compilation
depend/          : build environment
examples/        : sample lattices
include/         : header files
interpolator/    : tool for field map validation
manual/          : documentation
modules/         : extra modules for user code
parser/          : gmad parser
include/         : header files
src/             : source files
src-external/    : third party source code
test/            : various test libraries
utils/           : various "useful" scripts
vis/             : default visualisation files