= Welcome to the Lal GuineaPig++ project =

== The GuineaPig++ project ==

guineapig is a beam-beam simulation code written by D. Schulte (CERN).
The aim of the project guineapig++ at LAL is to provide an reliable, versatile, modular object oriented (C++) guineapig code. The expected benefit is the ability to easy implement new features and functionnalities. 

== People ==

 * Developpers: Guy Le Meur, François Touze
 * Contributers: Cécile Rimbault...

== Technical details on the configuration management tools ==

The system described in this document uses SVN and CMT to compile source programms and to provide executables. SVN is ubiquitous, so it's not a problem. CMT is also easy to install, but it is not usually available by default. We provide in the distribution tarball an embedded CMT version. So the simple user can drop reading these technical details : SVN, and CMT can be usefull for developpers and contributors (please contact us).
 

==== CMT ====

The CMT development is lead at LAL by Christian Arnault and Vincent Garonne. It has been designed from the ground up to work suitably for physics experiments and seems to be the build system of choice for the LHC experiments (e.g. ATLAS, LHCb). It is already quite polished and represents a major step forward from the make/autoconf systems.

CMT has a very good web-site located at:

http://www.cmtsite.org

which contains extensive documentation as well as installation instructions. You can access these instructions directly from the main page, or find the directly at

http://www.cmtsite.org/install.html

The GuineaPig++ simulation group is initially using version v1r16p20061003 (The CMT support team likes LOOONNNG version numbers). At the moment, this is not the most recently released production version, but it has been tested with our software and we recommend installing it. However, CMT has remained relatively stable since about v1r18 so if you have a different version installed, it will probably work.

Installing CMT is quite simple and well described on the website so we won't repeat the instructions. Essentially, you download the source files and then untar them in "[some root]". You then run an installation shell script, source a setup shell script, and run make.

== GuineaPig++ Installation ==

=== Download ===

==== Tarballs ====

You could download the source kit of GuineaPig++ (this kit is complete for a local rebuild): 

|| Versions                                     || URL                    ||
|| GuineaPig++-0.1.0-b (Current beta version ) || [http://www.cmtsite.org/phpmv2/phpmyvisites.php?url=http%3A//flc.web.lal.in2p3.fr/mdi/BBSIM/guineapig%2B%2B-0.1.0-b.tar.gz&id=4&pagename=FILE:guineapig++-0.1.0-b.tar.gz guineapig++-0.1.0-b.tar.gz]||



==== From the SVN Repository ====

We are using the SVN repository at:

{{{
 https://svn.lal.in2p3.fr/FLC/GuineaPig
}}}


If you are interest to get the code directly from svn, you should do the following command:

{{{
$ svn co  https://svn.lal.in2p3.fr/FLC/GuineaPig/guineapig++/tags/<version> <some directoy name>
}}}

the format of <version> is : guineapig++-x.x.x-b

for the moment the only available version is guineapig++-0.1.0-b

<some directoy name> denote the name of the local directory where you wish to put the code guineapig. It should be <version>

Note: In this case, you should first install CMT by yourself or check that CMT is available on your site. 

=== Compile the software ===

To compile the software:

CMT should have been installed by : 

{{{
   > cd <some root>/CMT/v1r<nn>p<xxx>/mgr
   > ./INSTALL
}}}

to compile and provide an executable : 

{{{
   > source setup.[c]sh (once for a session)
   > cd <some directoy name>/cmt
   > cmt make or make
}}}

the executable is in a directory <some directoy name>/<binaries>

the name of <binaries> is  determined by CMT, from the name of the machine. It is like : Linux-i686 or Darwin (on Macintosh) etc. 

Enjoy this product! 

Any question, remark or suggestion are welcome ! Please submit a report [https://trac.lal.in2p3.fr/GuineaPig/newticket here]

== Aknowledgments ==

We are thankful to Antoine Pérus and Vincent Garonne (LAL) for helping us to build the first configuration environment of guineapig++ and the present TRAC page.