Skip to content

docs(higgs): add Higgs field API map - #1499

Merged
jstoobysmith merged 1 commit into
leanprover-community:masterfrom
Robby955:physlib/higgs-api-map-20260810
Aug 11, 2026
Merged

docs(higgs): add Higgs field API map#1499
jstoobysmith merged 1 commit into
leanprover-community:masterfrom
Robby955:physlib/higgs-api-map-20260810

Conversation

@Robby955

Copy link
Copy Markdown
Contributor

Motivation

Related to #1414 and the tracking issue #857, which is still an unfilled template, so the map supplies the requirement list it asks for. The Two Higgs Doublet Model map already lists Higgs Field (Physlib/Particles/StandardModel/HiggsBoson) as a parent API, so this map also fills a node that an existing map references. An API map records the implemented status and source location of each requirement, so the gap between a planned API and the current library stays visible in-tree.

Changes

Adds Physlib/Particles/StandardModel/HiggsBoson/API-map.yaml, with 21 requirements, 16 of them done. The completed entries cover HiggsVec with its basis, real-scalar coordinates, and the repGaugeGroupI representation with its invariance and orbit-by-norm theory; HiggsBundle and HiggsField with constant fields and component smoothness; the pointwise inner product and norm-squared with their algebra and smoothness; the Potential structure with its completing-the-square, discriminant, boundedness, and minimisation theory; and EffectivePotential with gauge invariance, factorisation through the norm, and the polynomial expansion in powers of the norm.

Five are recorded as not done: the stability-group lemmas and the global gauge action on HiggsField exist only as informal declarations, and the map cites them as such; the Higgs bundle is still the trivial bundle rather than an associated bundle; effective potentials are not yet connected to field-level potentials; and covariant derivatives with kinetic terms wait on a gauge-connection API. Nothing outside the new file changes, and no Lean source is touched.

Checks

python3 scripts/api_map_linter.py --repo . passes with no missing files and no missing names, resolving 91 declarations in the new map against the Lean sources.

@github-actions

Copy link
Copy Markdown
Contributor

Thank you for this pull-request (PR). If this is your first PR, welcome to the community!

Below is what will happen next. Please read carefully if you are not familiar with the process. You may open other PRs while this one is being reviewed, and can stack PRs on top of each other, so don't let these steps slow you down.

  1. Some automated checks will be run on your PR. You can see the results of these checks at the buttom of your PR page. If any of these checks fail, you will need to fix the issues before your PR can be merged. You can learn more about these here, including how to run them locally, which is sometimes quicker than relying on the GitHub Actions. If you have never had a PR merged before, you may have to wait for a reviewer to manually start these checks (this is for security).

  2. A reviewer will look at your PR and may ask you to make changes. This may happen a couple of days after you submit your PR, so you may need to be patient. But it should not be longer than that - if it is please bring it to the attention of the community on the Zulip. The level of review will depend on where your PR is submitted. If it is submitted to ./Physlib or ./QuantumInfo, the review will be more thorough than if it is submitted to ./PhyslibAlpha. You can find out more about what the review process is looking for in our review guidelines. If a reviewer adds an awaiting-author label to your PR, address the review comments, then please remove that label by adding a comment with -awaiting-author. This helps us keep track of reviews.

  3. The reviewer will either approve your PR, or request more changes (in which case we return to step 2). Once your PR is approved, it will be merged by a maintainer, this should happen shortly after approval, though you may get more comments at this stage.

Tip: The easiest way to get have a fast review is to submit a PR that is small and self-contained, and has clear documentation explaining why things are the way they are in your chages.

If you have any problems or questions, please reach out to the community on the Zulip.

@github-actions github-actions Bot added the t-particles Particles label Aug 11, 2026
@Robby955
Robby955 marked this pull request as ready for review August 11, 2026 04:08

@jstoobysmith jstoobysmith left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved - looks good to me. Thanks

@jstoobysmith jstoobysmith added the ready-to-merge This PR is approved and will be merged shortly label Aug 11, 2026
@jstoobysmith
jstoobysmith merged commit ac81bfd into leanprover-community:master Aug 11, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready-to-merge This PR is approved and will be merged shortly t-particles Particles

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants