From f821bf71c5fa365994b2c59fc919c1a2abb943dd Mon Sep 17 00:00:00 2001 From: Dibyashanu Pati <> Date: Wed, 23 Apr 2025 12:15:50 +0530 Subject: [PATCH] edited README --- README.md | 93 ++----------------------------------------------------- 1 file changed, 3 insertions(+), 90 deletions(-) diff --git a/README.md b/README.md index 64a1737..49cec60 100644 --- a/README.md +++ b/README.md @@ -1,92 +1,5 @@ + ![PhysLean](./docs/PhysLeanLogo.jpeg) -![PhysLean](./docs/PhysLeanLogo.jpeg) -[![](https://img.shields.io/badge/Read_The-Docs-green)](https://heplean.com) -[![](https://img.shields.io/badge/Get-Involved-green)](https://heplean.com/GetInvolved.html) -[![](https://img.shields.io/badge/Lean-Zulip-green)](https://leanprover.zulipchat.com) -[![](https://img.shields.io/badge/TODO-List-green)](https://heplean.com/TODOList) -[![](https://img.shields.io/badge/Informal_dependencies-Graph-green)](https://heplean.com/InformalGraph) +This branch of is my fork of [Physlean](https://github.com/HEPLean/PhysLean) . -[![](https://img.shields.io/badge/View_The-Stats-blue)](https://heplean.com/Stats) -[![](https://img.shields.io/badge/Lean-v4.18.0--rc1-blue)](https://github.com/leanprover/lean4/releases/tag/v4.18.0) -[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/HEPLean/HepLean) - -A project to digitalize physics. - -*(Formerly called HepLean)* -## Aims of this project - -๐ŸŽฏ __Digitalize__ results (meaning calculations, definitions, and theorems) from physics -into Lean 4. - -๐ŸŽฏ Develop structures to aid the __creation__ of new results in physics using Lean, - with the potential future use of AI. - -๐ŸŽฏ Create good documentation so that the project can be used for __pedagogical__ purposes. - - -## Some parts of PhysLean -PhysLean _currently_ includes, but is not limited to, the following parts: - -__Lorentz [๐Ÿ—‚๏ธ](https://physlean.com/docs/PhysLean/Relativity/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://physlean.com/docs/PhysLean/Relativity/Tensors/OverColor/Basic.html) [๐Ÿ“„](https://arxiv.org/abs/2411.07667):__ Formalization of index notation using category theory allowing commands like - -```Lean -{A | ฮผ ฮฝ โŠ— S | ฮผ ฮฝ = - A | ฮผ ฮฝ โŠ— S | ฮผ ฮฝ}แต€ -``` - -__Anomaly cancellation [๐Ÿ—‚๏ธ](https://physlean.com/docs/PhysLean/QFT/AnomalyCancellation/Basic.html):__ Results related to solutions to the anomaly cancellation conditions of several theories. - -__Standard Model physics [๐Ÿ—‚๏ธ](https://physlean.com/docs/PhysLean/Particles/StandardModel/Basic.html):__ Properties of the Higgs potential. - -__BSM physics [๐Ÿ—‚๏ธ](https://physlean.com/docs/PhysLean/Particles/BeyondTheStandardModel/TwoHDM/Basic.html):__ Starts to: Georgi Glashow model, Pati-Salam, Spin(10), Two Higgs doublet model. - -__Flavor physics [๐Ÿ—‚๏ธ](https://physlean.com/docs/PhysLean/Particles/FlavorPhysics/CKMMatrix/Basic.html):__ Properties of the CKM matrix. - -__Perturbation Theory [๐Ÿ—‚๏ธ](https://physlean.com/docs/PhysLean/QFT/PerturbationTheory/WickContraction/Basic.html):__ Time-dependent version of Wick's theorem for both fermions and bosons. - -## Associated media and publications -- [๐Ÿ“„](https://arxiv.org/abs/2405.08863) Joseph Tooby-Smith, -__HepLean: Digitalising high energy physics__, Computer Physics Communications, Volume 308, -2025, 109457, ISSN 0010-4655, https://doi.org/10.1016/j.cpc.2024.109457. \[arXiv:2405.08863\] -- [๐Ÿ“„](https://arxiv.org/abs/2411.07667) Joseph Tooby-Smith, __Formalization of physics index notation in Lean 4__, arXiv:2411.07667 -- [๐Ÿ’ป](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 PhysLean -- 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/) - -How HepLean was used: *Theorems from the space-time files of HepLean were included in a data set used to evaluate the ability of models to prove theorems from real-world repositories, which requires working with definitions, theorems, and other context not seen in training.* - -## Contributing - -We would love to have you involved! See the [Get Involved](https://heplean.com/GetInvolved.html) page to see how you can get involved. -Any contributions are welcome! If you have any questions or want permission 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 play around 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 - -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 PhysLean - -- 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). - -### Optional extras - -- [Lean Copilot](https://github.com/lean-dojo/LeanCopilot) and [LLMLean](https://github.com/cmu-l3/llmlean) allow for the use of large language models in Lean -- [tryAtEachStep](https://github.com/dwrensha/tryAtEachStep) allows one to apply a tactic, e.g. `exact?` at each step of a lemma in a file to see if it completes the goal. This is useful for golfing proofs. +The parts written by me are in [KineticTheory](./PhysLean/KineticTheory/)