PhysLean/README.md
Joseph Tooby-Smith ea126d0fae
docs: ReadMe
2024-05-14 16:16:01 -04:00

2.4 KiB

High Energy Physics in Lean

A project to digitalize high energy physics.

Aims of this project

  • Use Lean to create a exhaustive database of definitions, theorems, proofs and calculations in high energy physics.
  • Make a libary 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 relevence to the high energy physics community.

Where to learn more

Contributing

We follow here roughly the same contribution policies as MathLib4 (which 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

The installation instructions for Lean 4 are given here: https://leanprover-community.github.io/get_started.html.

Installing HepLean

  • Clone this repository (or download the repository as a Zip file)
  • Open a terminal at the top-level in the corresponding directory.
  • Run lake exe cache get. The command lake should have been installed when you installed Lean.
  • Run lake build.
  • Open the directory (not a single file) in Visual Studio Code (or another Lean compatible code editor).