/gosam

Primary LanguagePythonOtherNOASSERTION

################################################################################
#   __   __   ___   __   __  __                      GoSam                     #
#  / _) /  \ / __) (  ) (  \/  )             An Automated One-Loop             #
# ( (/\( () )\__ \ /__\  )    (             Matrix Element Generator           #
#  \__/ \__/ (___/(_)(_)(_/\/\_)             Version 2.x.x                     #
#                                                                              #
#                                    (c) The GoSam Collaboration 2011-2021     #
#                                                                              #
#        AUTHORS:                                                              #
#        * Gudrun Heinrich                   <gudrun.heinrich@kit.edu>         #
#        * Stephen Jones                     <s.jones@cern.ch>                 #
#        * Matthias Kerner                   <mkerner@physik.uzh.ch>           #
#        * Jannis Lang                       <jannis.lang@kit.edu>             #
#        * Vitaly Magerya                    <vitaly.magerya@tx97.net>         #
#        * Pierpaolo Mastrolia               <Pierpaolo.Mastrolia@cern.ch>     #
#        * Giovanni Ossola                   <gossola@citytech.cuny.edu>       #
#        * Tiziano Peraro                    <tiziano.peraro@unibo.it>         #
#        * Johannes Schlenk                  <johannes.schlenk@psi.ch>         #
#        * Ludovic Scyboz                    <ludovic.scyboz@physics.ox.ac.uk> #
#        * Francesco Tramontano              <Francesco.Tramontano@cern.ch>    #
#                                                                              #
#        FORMER AUTHORS:                                                       #
#        * Gavin Cullen, Hans van Deurzen, Nicolas Greiner, Stephan Jahn,      #
#          Gionata Luisoni, Edoardo Mirabella, Joscha Reichel, Thomas Reiter,  #
#          Johann Felix von Soden-Fraunhofen                                   #
#                                                                              #
#  This program is free software: you can redistribute it and/or modify        #
#  it under the terms of the GNU General Public License either                 #
#  version 3, or (at your option) any later version.                           #
#                                                                              #
#  Scientific publications prepared using the present version of               #
#  GoSam or any modified version of it or any code linking to GoSam            #
#  or parts of it should make a clear reference to the publication:            #
#                                                                              #
#      G. Cullen et al.,                                                       #
#      ``GoSam-2.0: a tool for automated one-loop calculations                 #
#                        within the Standard Model and Beyond'',               #
#      Eur. Phys. J. C 74 (2014) 8,  3001                                      #
#      [arXiv:1404.7096 [hep-ph]].                                             #
################################################################################


Synopsis
--------

GoSam is a general one-loop evaluator for matrix elements.
The program produces Fortran 90 code from a given process
description by evaluating Feynman diagrams and translating
the associated one-loop diagrams into code suitable for the
evaluation with Ninja, Golem95 and/or Samurai.

Download
--------

GoSam can be downloaded from:
https://github.com/gudrunhe/gosam

Installation
------------

 * To install GoSam together with all its dependencies:
   Use the install script tools/gosam_installer.py and run it with
   "python3 tools/gosam_installer.py --prefix=<XXXX>"
   (where the prefix is optional)

   By default GoSam will be installed in a subdirectory ./local of the directory where
   the install script is called.

 * Installing GoSam without its dependencies:

If the user has super-user privileges:

sudo python setup.py install

If the user wants (or has to) maintain an alternative installation
path <XXXX> for the python modules:

python setup.py install --prefix=<XXXX>

The prefix option can also be set permanently in the user's pydistutils config file.

After successful installation the user should also update the environment variable
PATH=$PATH:<XXXX>/bin

For bourne shell compatible shells (bash, zsh, ...), this can be done by adding the
following lines to ~/.profile:

   PATH="$PATH:<XXXX>/bin"
   export PATH

For csh compatible shells (tcsh, ...), the following line need to be added to ~/.cshrc:

   setenv PATH "$PATH:<XXXX>/bin"

To enable this change, you need to run "source ~/.profile" or
"source ~/.cshrc" and "rehash", or re-login.

For more details, please refer to the manual (doc/refman.pdf).