====== CompHEP-4.1. Installation. ======

**New:** //For Mac users the installation instruction is [[:comphep:mac:welcome|here]]//

Please send all you remarks to A.Kryukov by e-mail: [[kryukov@theory.sinp.msu.ru]]

===== Preliminary remarks and notations. =====

In this document we suppose that Linux is used. Thus, if you have another OS on the computer, please adjust this installation procedure according requirements of your OS.

Below, we use the following notations:

  XXXX - CompHEP version number;
  comphep-XXXX - directory where CompHEP files will live;
  comphep-XXXX.tgz - distributive tar-file with sources;
  comphep-XXXX-linux.tgz - distributive tar-file with binaries;

See section 4 for the installation from binary distributive.

===== Compilation of the package from the source distributive. =====

  - Untar gzip-tar distributive archive: <code>
tar xzvf comphep-XXXX.tgz
</code> The directory with name comphep-XXXX will be created with all files of CompHEP distributive.
  - Pass to the comphep-XXXX directory: <code>
cd comphep-XXXXX 
</code>
  - Launch configure script:<code>
./configure
</code> This script has several options. In order to get help for the options execite ./configure --help
  - ./configure generates several files with compiler/linker options: CC, CFLAGS, CLIBS, F77, F77FLAGS, F77LIBS, RANLIB. If user want additional or other option, (s)he can edit this files. Default values (for Linux):<code>
CC = gcc
CFLAGS = -Wall -DNUM_DOUBLE -DCOMPHEP
CLIBS = -Llib -lX11 -lm
F77 = gfortran
F77FLAGS =  
F77LIBS = -lgfortran -lgcc
RANLIB = ranlib
</code> If user wants to have an interface with ROOT the option --with-root must be used. In this case, two files ROOTFLAGS and ROOTLIBS will have options and libriaries necessary for the interface.
  - Compile CompHEP:<code>
make
</code> NOTE://
      All CompHEP binaries are ready to use. But for convenient
      work with CompHEP we recommend to create a user directory, which will contain necessary scripts, model files, and directories for results of your calculation.
//

===== Installation of a user directory =====
In order to create a user working directory execute:
<code>
make setup WDIR=path_to_user_work_directory
</code> NOTE:
   * WDIR is a path to a directory where you want to have all CompHEP start-up scripts. Default value is <code>../comphep_XXXX_usr_test (relatively to $COMPHEP).</code>
   * Do not use '~' (tilde) to point home directory. Use the $HOME variable instead of '~'.

After that go to WDIR and enjoy CompHEP!

===== Additional services are provided. =====

   - Clean up CompHEP :<code>
make clean
</code>
   - make tar gzip archive of CompHEP:<code>
make dist
</code> NOTE: Archives will be in directory comphep-XXXX/.. with the name comphep-XXXX.tgz

===== Some incompatibilities with previous versions. =====

  - Models of CompHEP version 4.4 and later have different notations for leptons: <code>
e,E/ne,Ne instead of e1,E1/n1,N1; m,M/nm,Nm instead of e2,E2/n2,N2; and l,L/nl,Nl instead of e3,E3/n3,N3.
</code>
  - In debug mode the environment variable COMPHEP defined in the startup scripts like ~/.cshrc can interfere with the run time environment defined in the script 'comphep'