SusyFit - a Fitting Tool for the Standard Model and Beyond
===========================================================================

version 0.2
-----------

SusyFit is a flexible tool which, given the Standard Model or any extension,
allows to:

  - fit the model parameters to a given set of experimental observables
  - obtain fit results for observables
  - obtain predictions for observables

SusyFit can be used:

  - as an executable in Monte Carlo mode, to perform a Bayesian Markov Chain
    Monte Carlo analysis of the given model
  - as an executable in single event mode, to obtain predictions of observables
    for a given point in the parameter space of the model
  - in library mode, to obtain predictions of observables for a given point
    in the parameter space of the model, allowing our computational tool to
    be used in any statistical framework

The Monte Carlo mode is based on the BAT (Bayesian Analysis Toolkit) library.

Availability:
-------------
SusyFit is available from [the SusyFit webpage](http://susyfit.roma1.infn.it/).
See COPYING file for licensing terms.

Installation:
-------------
To compile and install SusyFit, the following have to be availabled installed:
GSL, LoopTools, Boost, ROOT, and BAT. If all these are installed in
the default install prefix (/usr/local) then run the following
commands to install SusyFit into /usr/local:

	./configure
	make -j 4
	make install

To chose a non-default directory where SusyFit will be installed, set
the prefix (default is /usr/local) with --prefix=/custom/install/path
argument to configure. Likewise to set a non-default directory where
BAT, for example, is installed, set the --with-bat=/custom/path
argument to configure. An example is 

	./configure --prefix=/install/path --with-bat=/BATinstall/dir 
	
Read the output of the command 'configure --help' for the list of
options and environment variables that can be passed to configure.

See the INSTALL file for detailed installation instructions.

After a successfull installation, the three examples can be executed:

./ExamplesSrc/MonteCarloMode/analysis ExamplesSrc/config/StandardModel.conf \
ExamplesSrc/MonteCarloMode/MonteCarlo.conf 

./ExamplesSrc/LibMode_config/analysis ExamplesSrc/config/StandardModel.conf

./ExamplesSrc/LibMode_header/analysis ExamplesSrc/config/StandardModel.conf 


Support:
--------
There is not yet a manual for SusyFit. For additional information and
contacting the authors, please, consult [the SusyFit
webpage](http://susyfit.roma1.infn.it/).

===========================================================================
This file is part of SusyFit
Copyright (C) 2012  The SusyFit Collaboration

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License version 3 as 
published by the Free Software Foundation.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.