PhysLean/README.md

High Energy Physics in Lean

A project to digitalize high energy physics.

Aims of this project

• Use Lean to create an exhaustive database of definitions, theorems, proofs, and calculations in high energy physics.
• Make a library that is easy to use by the high energy physics community.
• Keep the database up-to date with developments in MathLib4.
• Create gitHub workflows of relevance to the high energy physics community.

Where to learn more

• The documentation for this project is at:

  https://heplean.github.io/HepLean/

• Watch this overview of HepLean:

  https://www.youtube.com/watch?v=W2cObnopqas

• A list of 'Frequently asked questions' can be found on the Wiki for this project:

  https://github.com/HEPLean/HepLean/wiki/The-answers-to-some-questions

• Feel free to connect on the Lean Zulip channel:

  https://leanprover.zulipchat.com

• A small example script relating to the three fermion anomaly cancellation condition can be found here

Contributing

We follow here roughly the same contribution policies as MathLib4 (which can be found here).

A guide to contributing can be found here.

If you want permission to create a pull-request for this repository contact Joseph Tooby-Smith on the lean Zulip, or email.

Installation

Installing Lean 4

See: https://leanprover-community.github.io/get_started.html

Quick installation

• Clone this repository
• Open a terminal in the corresponding directory.
• Run lake exe cache get.
• Run lake build.