diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 2f9fb44..717ad0f 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -1,15 +1,14 @@ -on: - push: - pull_request: +on: + pull_request: name: continuous integration -jobs: - doc_lint: - name: doc lint +jobs: + doc_lint: + name: doc lint runs-on: ubuntu-latest - steps: + steps: - uses: actions/checkout@v4 @@ -28,7 +27,7 @@ jobs: - name: build cache run: | lake exe cache get - + - name: build HepLean id: build uses: liskin/gh-problem-matcher-wrap@v3 @@ -37,8 +36,8 @@ jobs: run: | bash -o pipefail -c "env LEAN_ABORT_ON_PANIC=1 lake build -KCI | tee stdout.log" - - name: check file imports - run: | + - name: check file imports + run: | bash -o pipefail -c "env LEAN_ABORT_ON_PANIC=1 lake exe check_file_imports" - name: runLinter on HepLean @@ -49,7 +48,7 @@ jobs: linters: gcc run: env LEAN_ABORT_ON_PANIC=1 lake exe runLinter HepLean - style_lint: + style_lint: name: Python based style linter runs-on: ubuntu-latest steps: @@ -76,4 +75,3 @@ jobs: run: | chmod u+x scripts/lint-style.sh ./scripts/lint-style.sh - diff --git a/README.md b/README.md index 39a4cae..498e259 100644 --- a/README.md +++ b/README.md @@ -12,29 +12,38 @@ A project to digitalize high energy physics. ## Aims of this project -1. Digitalize results (meaning calculations, definitions, and theorems) from high energy physics +๐ŸŽฏ __Digitalize__ results (meaning calculations, definitions, and theorems) from high energy physics into Lean 4. -2. Develop structures to aid the creation of new results in high energy physics using Lean, + +๐ŸŽฏ Develop structures to aid the __creation__ of new results in high energy physics using Lean, with the potential future use of AI. -3. Create good documentation so that the project can be used for pedagogical purposes. + +๐ŸŽฏ Create good documentation so that the project can be used for __pedagogical__ purposes. -## Areas of high energy physics with some coverage in HepLean +## Some parts of HepLean +HepLean _currently_ includes, but is not limited to, the following parts: +__Lorentz [๐Ÿ—‚๏ธ](https://heplean.github.io/HepLean/docs/HepLean/Lorentz/Group/Basic.html):__ The Lorentz group, Lorentz algebra, Weyl fermions, Real Lorentz vectors, complex Lorentz vectors, complex Lorentz tensors, bispinors, Pauli matrices, etc. + +__Index notation [๐Ÿ—‚๏ธ](https://heplean.github.io/HepLean/docs/HepLean/Tensors/OverColor/Basic.html):__ Formalization of index notation using category theory allowing commands like + +```Lean +{A | ฮผ ฮฝ โŠ— S | ฮผ ฮฝ = - A | ฮผ ฮฝ โŠ— S | ฮผ ฮฝ}แต€ +``` + +__Anomaly cancellation [๐Ÿ—‚๏ธ](https://heplean.github.io/HepLean/docs/HepLean/AnomalyCancellation/Basic.html):__ Results related to solutions to the anomaly cancellation conditions of several theories. + +__Standard Model physics [๐Ÿ—‚๏ธ](https://heplean.github.io/HepLean/docs/HepLean/StandardModel/Basic.html):__ Properties of the Higgs potential. + +__BSM physics [๐Ÿ—‚๏ธ](https://heplean.github.io/HepLean/docs/HepLean/BeyondTheStandardModel/TwoHDM/Basic.html):__ Starts to: Georgi Glashow model, Pati-Salam, Spin(10), Two Higgs doublet model. + +__Flavor physics [๐Ÿ—‚๏ธ](https://heplean.github.io/HepLean/docs/HepLean/FlavorPhysics/CKMMatrix/Basic.html):__ Properties of the CKM matrix. -[![](https://img.shields.io/badge/The_CKM_Matrix-blue)](https://heplean.github.io/HepLean/docs/HepLean/FlavorPhysics/CKMMatrix/Basic.html) -[![](https://img.shields.io/badge/Higgs_Field-blue)](https://heplean.github.io/HepLean/docs/HepLean/StandardModel/HiggsBoson/Basic.html) -[![](https://img.shields.io/badge/2HDM-blue)](https://heplean.github.io/HepLean/docs/HepLean/BeyondTheStandardModel/TwoHDM/Basic.html) -[![](https://img.shields.io/badge/Lorentz_Group-blue)](https://heplean.github.io/HepLean/docs/HepLean/SpaceTime/LorentzGroup/Basic.html) -[![](https://img.shields.io/badge/Anomaly_Cancellation-blue)](https://heplean.github.io/HepLean/docs/HepLean/AnomalyCancellation/Basic.html) -[![](https://img.shields.io/badge/Feynman_diagrams-blue)](https://heplean.github.io/HepLean/docs/HepLean/FeynmanDiagrams/PhiFour/Basic.html) ## Associated media and publications -| | Description | -|----|------| -| [Paper](https://arxiv.org/abs/2405.08863) | HepLean: Digitalising high energy physics | -| [Code](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) | Example code snippet | -| [Video](https://www.youtube.com/watch?v=W2cObnopqas) | HepLean: Lean and high energy physics | -| [Video](https://www.youtube.com/watch?v=IjodVUawTjM) | Index notation in Lean 4 | +- [๐Ÿ“„](https://arxiv.org/abs/2405.08863) Joseph Tooby-Smith, __HepLean: Digitalising high energy physics__, arXiv:2405.08863 +- [๐Ÿ’ป](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) Example code snippet related to Anomaly cancellation conditions. +- [๐ŸŽฅ](https://www.youtube.com/watch?v=W2cObnopqas) Seminar recording of "HepLean: Lean and high energy physics" by J. Tooby-Smith ### Papers referencing HepLean - Hu, Jiewen, Thomas Zhu, and Sean Welleck. "miniCTX: Neural Theorem Proving with (Long-) Contexts." arXiv preprint [arXiv:2408.03350](https://www.arxiv.org/abs/2408.03350) (2024). [Project page]( https://cmu-l3.github.io/minictx/) @@ -47,13 +56,21 @@ We follow here roughly the same contribution policies as MathLib4 (which can be 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. +If you want permission to create a pull-request for this repository contact Joseph Tooby-Smith on the [Lean Zulip](https://leanprover.zulipchat.com), or email. ## Installation +If you want to playaround with HepLean, but do not want to download Lean, then you can use [GitPod](https://gitpod.io/#https://github.com/HEPLean/HepLean). + ### Installing Lean 4 -The installation instructions for Lean 4 are given here: https://leanprover-community.github.io/get_started.html. +Installation instructions for Lean 4 can be found: + +- https://lean-lang.org/lean4/doc/quickstart.html + +or + +- https://leanprover-community.github.io/get_started.html ### Installing HepLean