docs(electromagnetism): add kinematics API map#1439
Conversation
|
Thank you for this PR, which will now be reviewed. If submitting to ./Physlib or ./QuantumInfo, please see our review guidelines if you are not familiar with the process. You should expect a back and forth with a reviewer before your PR is merged. See also that link for how to add appropriate labels to your PR. The PR will also go through a number of automated checks. You can learn more about these here, including how to run them locally. If you are submitting to ./PhyslibAlpha there will be a lighter review process, though your PR must still pass the automated checks. If you want to bring attention to this PR, please write a message on this thread of the Lean Zulip. Important: If a reviewer adds an |
|
|
||
| References: | ||
| - HEPLean/PhysLean issue "API - Electromagnetic potential" | ||
| - J. D. Jackson, Classical Electrodynamics, Chapter 6 (potentials and gauge transformations) |
There was a problem hiding this comment.
Have we checked this reference? If so this looks good.
There was a problem hiding this comment.
Checked against the third edition: potentials are 6.2 and gauge transformations 6.3.
jstoobysmith
left a comment
There was a problem hiding this comment.
Approved - will merge shortly.
Motivation
Related to #1414. This adds an API map for the electromagnetic-potential API (the "API - Electromagnetic potential" issue). An API map records the implemented status and source location of each requirement, so the state of the API stays visible in-tree.
Changes
Adds
Physlib/Electromagnetism/Kinematics/API-map.yaml.The map records the electromagnetic-potential API: the
ElectromagneticPotentialstructure with its additive-group and real-scalar-action and Lorentz-group-action API, its constructors (from a scalar potential, a vector potential, and a pair of non-relativistic potentials), the distributional counterpartDistElectromagneticPotential, and the derived electric field, magnetic field (as a vector and as an antisymmetric matrix), field-strength kinetic term, and Lagrangian, each in both the function and distributional settings. The one requirement that is not implemented, identifying the potential with a connection on a U(1)-gauge bundle, is marked not done with location N/A, since the library only remarks on it in documentation.Testing
Ran the API-map linter:
The map passes: every declared source file and name resolves, and no completed entry is missing a location.