Skip to content

wanweilin/fire6

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1,762 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

README

FIRE stands for Feynman Integral REduction

Articles

Installation

Either download a binary package, or

  • git clone https://gitlab.com/feynmanIntegrals/fire.git
  • cd fire/FIRE6
  • ./configure
  • Now read the options provided by ./configure and reconfigure with desired options, for example
  • ./configure --enable_tcmalloc --enable_zstd --enable-debug
  • make dep
  • make

Add the following configure options to enable support of new simplifiers

  • --enable-flint --enable-symbolica

FIRE works under various Linux distributions. FIRE works under Windows inside the WSL, version 2 (Windows subsystem for Linux). Just get WSL with an Ubuntu installation.

Important notice! We ship LiteRed 1.8.3 with FIRE. It is a separate package created by R.N.Lee, and in case it is used, a paper on LiteRed should be cited together with FIRE.

In case of changes in ./configure options it is recommended to have a clean rebuild

  • make cleandep
  • make clean
  • make dep
  • make

Usage

  • make test
  • Follow the instructions in the article FIRE6 and additional instructions on using different simplifier backends in FIRE6.5.
  • There are some examples in the examples folder
  • You can run bin/FIRE6 without options to see possible options. Note the syntax was changed between 6.5 and 6.5.1 - we updated the syntax to the classical linux style with "short options" (like -c) and their "long option" analogues (like --config)
  • a new option (--calc-options) can be used to pass options to FUEL
  • see CHANGELOG.md for changes between versions

For details of installation under OSX we recommend to use brew-installed llvm.

  • brew install automake
  • brew install llvm

Also see the following issue thanks to Sudeepan Datta

Documentation

Doxygen is used to create documentation for FIRE. You need to have doxygen installed to generate documentation.

To generate docs run

  • make doc

This will create html/ and latex/ subfolders in FIRE6/documentation/ html/ contains complete docs, latex/ contains latex sources.

To generate .pdf from latex sources, run

  • make doc_pdf

You will need to have appropriate tools installed, like pdflatex. This will generate refman.pdf and place it directly in FIRE6/documentation/

To view docs after creation, either

  • open FIRE6/documentation/html/index.html in your Web Browser
  • open FIRE6/documentation/refman.pdf (after generating it)

To delete documentation run

  • make cleandoc

More information

  • For the package structure see FIRE6/README
  • For examples listing see FIRE6/examples/README
  • For information about documentation see FIRE6/documentation/README

External packages

  • Most of the packages that FIRE uses are open-source, so they are included in the FIRE distribution
  • FIRE relies on the Fermat program by Robert Lewis. Fermat is free-ware, but has some restrictions for organizations. Fermat is shipped in the FIRE package, however it is the user responsibility to check, whether his use of Fermat is legal. If one does not accept the Fermat license, he should not use the fermat as well.
  • An alternative variant to Fermat is to enable new simplifiers, Flint or Symbolica. Flint is open-source and free, Symbolica has restrictions.
  • Suggested usage is together with LiteRed. Do not forget to include a reference to https://arxiv.org/abs/1310.1145 in this case.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • C 26.5%
  • C++ 25.2%
  • HTML 21.3%
  • Wolfram Language 17.2%
  • Makefile 4.4%
  • Shell 2.7%
  • Other 2.7%