DibyashanuPati/PhysLean
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge branch 'master' into SpaceTime/LorentzGroup

Browse source
This commit is contained in:
jstoobysmith 2024-05-17 15:28:16 -04:00
commit 2f0377baf0
2 changed files with 32 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

17
CONTRIBUTING.md
View file

@ -7,6 +7,17 @@ This assumes you have already installed Lean and setup HepLean.
To add a result to HepLean:
- Create a new branch of HepLean.
- Name the branch something which tells people what sort of things you are adding e.g. "StandardModel-HiggsPotential"
- On pushing to a brach GitHub will run a number of continous integration checks on your code.
- Once you are happy, and your branch has passed the continous integration checks, make a pull-request to the main branch of HepLean.
- Name the branch something which tells people what sort of things you are adding e.g., "StandardModel-HiggsPotential"
- On pushing to a branch GitHub will run a number of continuous integration checks on your code.
- Once you are happy, and your branch has passed the continuous integration checks, make a pull-request to the main branch of HepLean.
## Naming commits
It is useful to prefix commits with one of the following.
- `feat:` When you add one or more new lemma, definition, or theorems.
- `refactor:` When you are improving the layout and structure of the code.
- `fix:` When fixing a mistake in a definition or other Lean code.
- `docs:` When adding a comment or updating documentation.
- `style:` When adding e.g., white space, a semicolon etc. But does not change the overall
structure of the code.
- `chore:` Updating e.g., workflows.

27
README.md
View file

@ -4,13 +4,17 @@ 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.
- 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 relevence to the high energy physics community.
- Create gitHub workflows of relevance to the high energy physics community.
## Where to learn more
- Read the associated paper:
https://arxiv.org/abs/2405.08863
- The documentation for this project is at:
https://heplean.github.io/HepLean/
@ -28,22 +32,25 @@ A project to digitalize high energy physics.
- A small example script relating to the three fermion anomaly cancellation condition can be found [here](https://live.lean-lang.org/#code=import%20Mathlib.Tactic.Polyrith%20%0A%0Atheorem%20threeFamily%20(a%20b%20c%20%3A%20ℚ)%20(h%20%3A%20a%20%2B%20b%20%2B%20c%20%3D%200)%20(h3%20%3A%20a%20%5E%203%20%2B%20b%20%5E%203%20%2B%20c%20%5E%203%20%3D%200)%20%3A%20%0A%20%20%20%20a%20%3D%200%20∨%20b%20%3D%200%20∨%20c%20%3D%200%20%20%3A%3D%20by%20%0A%20%20have%20h1%20%3A%20c%20%3D%20-%20(a%20%2B%20b)%20%3A%3D%20by%20%0A%20%20%20%20linear_combination%20h%20%0A%20%20have%20h4%20%3A%20%203%20*%20a%20*%20b%20*%20c%20%3D%200%20%3A%3D%20by%20%0A%20%20%20%20rw%20%5B←%20h3%2C%20h1%5D%0A%20%20%20%20ring%20%0A%20%20simp%20at%20h4%20%0A%20%20exact%20or_assoc.mp%20h4%0A%20%20%0A)
## Contributing
We follow here roughly the same contribution policies as MathLib4 (which can be found [here](https://leanprover-community.github.io/contribute/index.html)).
A guide to contributing can be found [here](https://github.com/HEPLean/HepLean/blob/master/CONTRIBUTING.md).
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
The installation instructions for Lean 4 are given here: https://leanprover-community.github.io/get_started.html.
### Quick installation
### 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).
- clone this repository
- Open a terminal in the corresponding directory.
- Run `lake exe cache get`.
- Rune `lake build`.