Complete FeynCalc and FeynHelpers documentation, source code, and examples
The feyncalc-reference/ directory contains the complete external reference materials for the FeynCalc project:
- Total Files: 4,663 (including git history)
- Main Subdirectories: 3
feyncalc/- FeynCalc source + documentationfeynhelpers/- FeynHelpers source + documentationfeynhelpers-manual/- FeynHelpers LaTeX manual
FeynCalc complete distribution
feyncalc/
├── FeynCalc/
│ ├── Dirac/ (Dirac algebra functions)
│ ├── Lorentz/ (Lorentz algebra functions)
│ ├── SUN/ (SU(N) color functions)
│ ├── LoopIntegrals/ (Loop integral functions)
│ ├── Feynman/ (Feynman diagram functions)
│ ├── Database/ (Topology database)
│ ├── Tables/ (Reference cards & symmetries)
│ ├── AddOns/ (FeynArtsLoader, TARCER, FVProjection, etc.)
│ └── Documentation/
│ ├── Mathematica/ (*.nb & *.m files)
│ │ ├── Dirac/
│ │ ├── Lorentz/
│ │ ├── LoopIntegrals/
│ │ ├── SUN/
│ │ ├── Main/
│ │ └── Tutorials/
│ ├── Markdown/ (*.md files)
│ ├── Examples/ (Working examples)
│ │ ├── QED/ (QED examples)
│ │ ├── QCD/ (QCD examples)
│ │ ├── EW/ (Electroweak)
│ │ ├── MSSM/ (MSSM)
│ │ ├── FeynRules/ (FeynRules integration)
│ │ └── MasterIntegrals/
│ └── Scripts/ (Build & filter scripts)
├── Tests/ (Comprehensive test suites)
│ ├── Dirac/
│ ├── Lorentz/
│ ├── SUN/
│ ├── LoopIntegrals/
│ └── IntegrationTests/
└── .git/ (Git history)
Use For:
- Complete function reference (Dirac, Lorentz, SUN, Loop functions)
- Official examples & tutorials
- Understanding internal structures
- Testing & validation
FeynHelpers complete distribution
feynhelpers/
├── Documentation/
│ ├── Markdown/ (Quick reference)
│ │ └── Extra/ (Additional guides)
│ ├── Mathematica/ (Detailed documentation)
│ │ ├── FIRE/ (IBP reduction)
│ │ ├── LoopTools/ (1-loop evaluation)
│ │ ├── Kira/ (Advanced reduction)
│ │ ├── FIESTA/ (Numerical evaluation)
│ │ ├── PackageX/ (Package-X)
│ │ ├── PySecDec/ (PySecDec)
│ │ ├── Fermat/ (Fermat integration)
│ │ ├── QGRAF/ (QGRAF diagram generation)
│ │ └── Generic/ (General functions)
│ └── Examples/ (Worked examples)
│ ├── QED/
│ ├── QCD/
│ ├── Misc/
│ ├── FIESTA/
│ └── pySecDec/
├── Interfaces/ (Tool integrations)
│ ├── FIRE/
│ ├── LoopTools/
│ ├── Kira/
│ ├── FIESTA/
│ ├── PackageX/
│ ├── PySecDec/
│ ├── QGRAF/
│ └── Fermat/
├── ExternalTools/ (External tool binaries & configs)
│ ├── QGRAF/
│ ├── Fermat/
│ └── OneLoopFromPackageX/
├── Tests/ (Tool integration tests)
│ ├── FIRE/
│ ├── LoopTools/
│ ├── Kira/
│ ├── FIESTA/
│ ├── PackageX/
│ ├── PySecDec/
│ ├── QGRAF/
│ └── Fermat/
└── .git/ (Git history)
Use For:
- Tool-specific integration guides (FIRE, LoopTools, Kira, etc.)
- Function signatures & options
- Tool configuration
- Troubleshooting & examples
FeynHelpers LaTeX manual with full documentation
feynhelpers-manual/
├── FeynHelpersManual.tex (Main LaTeX document)
├── includes.tex (Included sections)
├── pages/ (Documentation pages)
├── img/ (Diagrams & images)
│ ├── *.svg (Vector graphics)
│ └── *.pdf (Rasterized images)
├── .github/workflows/ (CI/CD)
└── .git/ (Git history)
Use For:
- Complete manual (PDF or compiled version)
- High-quality diagrams
- Official documentation
- Reference material layout
(* Look up a function in FeynCalc *)
(* Visit: feyncalc-reference/feyncalc/Documentation/Markdown/Main/ *)
(* or: feyncalc-reference/feyncalc/FeynCalc/Documentation/Mathematica/Dirac/ *)(* Configure FIRE *)
(* Read: feyncalc-reference/feynhelpers/Documentation/Mathematica/FIRE/ *)
(* Examples: feyncalc-reference/feynhelpers/Documentation/Examples/ *)(* Study LorentzIndex, SUNIndex, etc *)
(* View source: feyncalc-reference/feyncalc/FeynCalc/Shared/ *)(* Official FeynCalc examples *)
Get["feyncalc-reference/feyncalc/FeynCalc/Examples/QED/Tree/Mathematica/..."]
(* Official FeynHelpers examples *)
Get["feyncalc-reference/feynhelpers/Documentation/Examples/..."]- Source files: ~1,200 .m files
- Documentation: ~300 Markdown + ~200 Mathematica files
- Examples: ~100+ working examples
- Tests: ~150+ test files
- Source files: ~800 .m files
- Documentation: ~200 Markdown + ~150 Mathematica files
- Examples: ~50+ working examples
- Tests: ~80+ test files
- Pages: Comprehensive (100+ pages)
- Diagrams: ~50+ images (SVG + PDF)
- Format: LaTeX source + images
feyncalc-reference/ (Source of Truth)
↓
├─→ feyncalc-core-skill/references/
├─→ feyncalc-qed-skill/references/
├─→ feyncalc-qcd-skill/references/
└─→ feyncalc-tools-skill/references/
+ FEYNHELPERS_REFERENCE.md (extracted from feynhelpers/)
↓
└─→ Each skill's CURATORS_GUIDE.md (references extracted)
Each skill extracts domain-specific content from feyncalc-reference/:
Core Skill extracts:
- Lorentz algebra (vectors, metrics, indices)
- Dirac algebra (spinors, traces, gamma matrices)
- Data structures (internal FeynCalc objects)
QED Skill extracts:
- QED examples (tree & loop)
- Photon & electron processes
- Vacuum polarization references
QCD Skill extracts:
- QCD examples (tree & loop)
- Color algebra (SU(3), ghost fields)
- Renormalization group information
Tools Skill extracts:
- FIRE configuration & examples
- LoopTools reference & usage
- Kira, FIESTA, Package-X guides
-
Complete Function Reference
- Look up exact function signatures
- Understand all available options
- See internal implementation
-
Official Examples
- Working code directly from FeynCalc team
- Verified & tested implementations
- Different complexity levels
-
Tool Integration
- Complete FIRE/LoopTools/Kira setup
- Configuration options
- Troubleshooting guides
-
Understanding Internals
- How FeynCalc structures work
- Database queries
- Advanced techniques
- Quick start (too overwhelming)
- Learning basics (too much detail)
- Finding specific examples (too many files)
→ Use feyncalc-*-skill/ instead for these!
| Aspect | feyncalc-reference/ | feyncalc-*-skill/ |
|---|---|---|
| Size | 4,663 files (huge) | 50-150 files (curated) |
| Purpose | Complete reference | Learning + specific domains |
| Audience | Advanced developers | Students + practitioners |
| Search | Complex (many files) | Fast (indexed) |
| Learning curve | Steep | Gradual |
| Best for | Deep understanding | Getting started |
- Find a function:
feyncalc-reference/feyncalc/Documentation/Markdown/ - Use FIRE:
feyncalc-reference/feynhelpers/Documentation/Mathematica/FIRE/ - Run an example:
feyncalc-reference/feyncalc/Examples/orfeyncalc-reference/feynhelpers/Documentation/Examples/ - Manual:
feyncalc-reference/feynhelpers-manual/FeynHelpersManual.tex(compile to PDF)
Status: Reference materials integrated and organized
Total Files: 4,663
Last Updated: 2026-05-15