[{"data":1,"prerenderedAt":4},["ShallowReactive",2],{"xlGnZtQjW3":3},"> [!NOTE]\n> Things look different? We've recently undergone a name change and move from /lean-phys-community/PhysLean\n> to /leanprover-community/physlib. Same repo, different location and name. This shouldn't affect\n> the average user, but please be patient as we update things.\n\n\n\u003Cdiv align=\"center\">\n\u003Cimg src=\"./docs/Physlib-logo.jpeg\" alt=\"Physlib logo\" width=\"500\">\n\u003C/div>\n\n\n\u003Cdiv align=\"center\">\n\n## An open-source, community, project to digitalize results from physics into Lean 4\n\n\n\n[![](https://img.shields.io/badge/Getting-Started-darkgreen)](https://physlib.io/GettingStarted.html)\n[![](https://img.shields.io/badge/The-Website-darkgreen)](https://physlib.io)\n[![](https://img.shields.io/badge/How_To-Get_Involved-darkgreen)](https://physlib.io/GetInvolved.html)\n[![](https://img.shields.io/badge/Physlib_Zulip-Discussion-darkgreen)](https://leanprover.zulipchat.com/#narrow/channel/479953-Physlib/)\n[![](https://img.shields.io/badge/TODO-List-darkgreen)](https://physlib.io/TODOList)\n\n\n[![](https://img.shields.io/badge/View_The-Stats-blue)](https://physlib.io/Stats)\n[![](https://img.shields.io/badge/Lean-v4.29.0-blue)](https://github.com/leanprover/lean4/releases/tag/v4.29.0)\n[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/leanprover-community/physlib)\n[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/leanprover-community/physlib)\n[![api_docs](https://img.shields.io/badge/doc-API_docs-blue)](https://physlib.io/docs/)\n\n\u003C/div>\n\n\n## Requirements of the project\n\n🎯 The project shall contain results (definitions, theorems, lemmas and calculations) from **physics**,\n  including quantum information, formalized (or **digitalized**) into the interactive theorem prover **Lean 4**.\n\n🎯 The project shall be **organized** by **physics**.\n\n🎯 Each definition in the project shall carry a physics-based **documentation**.\n\n🎯 Each module (file) in the project shall carry a physics-based **documentation**.\n\n🎯 The project shall contain Physics Lean **tactics**, **notation** and **syntax** for physicists.\n\n🎯 The project shall *not* be tied to physics axiomizations (e.g. axiomatic QFT), but rather flexiable enough to accommodate different approaches and starting points.\n\n🎯 The content of the project shall be carefully **reviewed** and curated, to ensure reusability, readability and fit.\n\n🎯 The project shall be completely open-source, community run and independent from any company or organization.\n\n🎯 The project shall not be tied to any specific AI model or tool.\n\n🎯 The project shall be for **mainstream** physics only.\n\n\n## Contributing to Physlib\n\nPhyslib is open-source and community run, and we welcome contributions from anyone.\nAll you need to do is open a pull-request with your changes\nand our team of maintainers will review it and iterate with you on feedback until it\ncan be merged.\n\nIf you unsure where you would like to contribute, you may find ideas on:\n- our [open issues](https://github.com/leanprover-community/physlib/issues).\n- our [todo list](https://physlib.io/TODOList)\n- our [Get Involved page](https://physlib.io/GetInvolved.html)\n- the [quantumInfo todo page](./QuantumInfo/WildeTODO.md)\n> [!NOTE]\n> If stuck at any point there are lots of people happly to help on the [Physlib zulip](https://leanprover.zulipchat.com/#narrow/channel/479953-Physlib)\n\n### Installing Lean 4\n\nInstallation instructions for Lean 4 can be found:\n\n- https://lean-lang.org/lean4/doc/quickstart.html\n\nor\n\n- https://leanprover-community.github.io/get_started.html\n\n### Installing Physlib\n\n- Clone this repository (or download the repository as a Zip file)\n- Open a terminal at the top-level in the corresponding directory.\n- Run `lake exe cache get`. The command `lake` should have been installed when you installed Lean.\n- Run `lake build`.\n- Open the directory (not a single file) in Visual Studio Code (or another Lean compatible code editor).\n\nAt the moment Physlib is divided into two essentially disjoint halves, `Physlib` and `QuantumInfo`.\nThese were two repositories that merged in an effort to create a more cohesive ecosystem for physics\nin Lean. There is ongoing effort to integrate them more deeply and share code, but at the moment\nthey offer two separate _build targets_: `Physlib` and `QuantumInfo`, as specified in `lakefile.lean`.\nThey are both default targets, so `lake build` will build both.\n\nIf you only want to build one, `lake build Physlib` or `lake build QuantumInfo` will target just one\nor the other. This could be useful if you're working on one part or the other and want to see that\nall your changes worked, or if you're only interested in having one or the other as a dependency in\nyour project.\n\n### Making a pull-request\n\nThere are lots of guides on how to make a pull-request on GitHub. The first thing you\nneed to do is fork the repository. Once you've made your pull request we will review it:\n- Guide to [Physlib reviews](https://github.com/leanprover-community/physlib/blob/master/docs/ReviewGuidelines.md).\nIt will also undergo a number of automated checks called linters. Sometimes these are easier\nto run locally:\n- Guide to [linters and running them locally](https://github.com/leanprover-community/physlib/blob/master/scripts/README.md).\n\nMost importantly:\n> [!NOTE]\n> When making contributing to Physlib it is much better to do it with small steps. This makes it easier for us to review, and allows you to get feedback sooner.\n\n## Maintainers\n\nBelow are the maintainers of the project, however the best way to reach them is by posting\non the [Lean Zulip](https://leanprover.zulipchat.com/#narrow/channel/479953-Physlib)\n\n- Léo Lessa (@Megaleo)\n- Alex Meiburg (@Timeroot)\n- Daniel Morrison (@morrison-daniel)\n- Zhi-Kai Pong (@zhikaip)\n- Rodolfo Soldati (@rodolfor-s)\n- Joseph Tooby-Smith (@jstoobysmith)\n- Winston Yin (@winstonyin)\n\n## Citing the project\n\nIf you want to cite the project as a whole please cite:\n\n```bibtex\n@misc{physlib,\n  author = {The Physlib community},\n  title = {Physlib: The Lean Physics Library},\n  year = {2024},\n  publisher = {GitHub},\n  journal = {GitHub repository},\n  howpublished = {\\url{https://github.com/leanprover-community/physlib}},\n}\n```\n\nPhyslib was formed by merging the general physics Lean library PhysLean (formerly called HepLean)\nwith the quantum-information library Lean-QuantumInfo. Where appropriate please also consider\nciting the papers associated with the origin of these projects. For the former please use:\n```bibtex\n@article{Tooby-Smith:2024vqu,\n    author = \"Tooby-Smith, Joseph\",\n    title = \"{HepLean: Digitalising high energy physics}\",\n    eprint = \"2405.08863\",\n    archivePrefix = \"arXiv\",\n    primaryClass = \"hep-ph\",\n    doi = \"10.1016/j.cpc.2024.109457\",\n    journal = \"Comput. Phys. Commun.\",\n    volume = \"308\",\n    pages = \"109457\",\n    year = \"2025\"\n}\n```\nand for the latter please use:\n\n```bibtex\n@article{Meiburg:2025mwn,\n    author = \"Meiburg, Alex and Lessa, Leonardo A. and Soldati, Rodolfo R.\",\n    title = \"{A Formalization of the Generalized Quantum Stein's Lemma in Lean}\",\n    eprint = \"2510.08672\",\n    archivePrefix = \"arXiv\",\n    primaryClass = \"quant-ph\",\n    month = \"10\",\n    year = \"2025\"\n}\n```\n",1776560085034]