*****************************************************************
* SmeftFR 2.0 - Feynman rules generator for the Standard Model  *
* Effective Field Theory                                        *
*****************************************************************

AUTHORS: A. Dedes, M. Paraskevas, J. Rosiek, K. Suxho, L. Trifyllis

Latest version can be downloaded from www.fuw.edu.pl/smeft

Program maintainer: janusz.rosiek@fuw.edu.pl

SmeftFR is distributed under the GPLv3 license

*************************
* PACKAGE INSTALLATION: *
*************************

Running package requires installing Wolfram Mathematica. It has been
tested with Mathematica version 11.3 or later, earlier versions were
reported to have problems running this code.

SmeftFR package works using the FeynRules system.  A recent version
and installation instructions for the FeynRules package can be
downloaded from the address feynrules.irmp.ucl.ac.be.  SmeftFR has
been tested with FeynRules version 2.3.

After installing FeynRules:

1. Create subdirectory Models/SMEFT_2_01 in the main FeynRules
installation directory.

2. Unpack SmefrFR distribution into Models/SMEFT_2_01 subdirectory.

3. Edit the $FeynRulesPath variable at the top of SmeftFR-init.nb and
SmeftFR-interfaces.nb Mathematica notebooks (both files located in
Models/SMEFT_2_01 subdirectory). $FeynRulesPath should be equal to the
absolute path to the main FeynRules installation directory
(e.g. $FeynRulesPath = "/home/rosiek/FeynRules" etc.)

4. Run the SmeftFR-init.nb first to produce the output in Mathematica
format. Quit the Mathematica kernel and run SmeftFR-interfaces.nb in
the new kernel to get the output in other supported formats.

Steps 3 and 4 can be also performed editing and executing in
Mathematica window the text scripts

<< smeft_fr_init.m
<< smeft_fr_interfaces.m

Further user-defined options of the SmeftFR package are described in
the manual.


********************
* PACKAGE CONTENT: *
********************

Models/SMEFT_2_01 subdirectory contains the following files and
subdirectories:

*** SmeftFR-init.nb (smeft_fr_init.m) -- notebook and equivalent text
script generating SMEFT Lagrangian in mass basis and Feynman rules in
Mathematica format.

*** SmeftFR-interfaces.nb (smeft_fr_interfaces.m) -- notebook and text
script with routines for exporting Feynman rules in various formats:
WCxf, Latex, UFO and FeynArts.

*** SmeftFR.pdf --  package manual in pdf format

*** README.txt -- brief installation instructions

*** code -- subdirectory with package code and utilities

*** lagrangian -- subdirectory with expressions for the SM Lagrangian and
dimension-5 and 6 operators coded in FeynRules format

*** definitions -- subdirectory with templates of SMEFT ``model files''
and example of numerical input for Wilson coefficients in WCxf format

*** output -- subdirectory with dynamically generated ``parameter files''
and output for Feynman rules in various formats, by default
Mathematica, Latex, UFO and FeynArts are generated.

*** output_sample -- subdirectory with sample output generated by
running SmeftFR-init.nb and SmeftFR-interfaces.nb (or equivalently
smeft_fr_init.m and smeft_fr_interfaces.m) as supplied in code
distribution.  Added for test purposes - for the same control variable
setup other users should reproduce identical results.

*** full_rxi_results -- subdirectory with ready-to-use set of Feynman
rules including all SMEFT operator classes, calculated in R_xi-gauges.

*** full\_unitary\_results -- subdirectory with ready-to-use set of
Feynman rules including all SMEFT operator classes, calculated in
unitary gauge.
