Skip to content

docs(classical-mechanics): add configuration API maps#1444

Open
Robby955 wants to merge 2 commits into
leanprover-community:masterfrom
Robby955:api-map-classical-mechanics
Open

docs(classical-mechanics): add configuration API maps#1444
Robby955 wants to merge 2 commits into
leanprover-community:masterfrom
Robby955:api-map-classical-mechanics

Conversation

@Robby955

Copy link
Copy Markdown
Contributor

Motivation

Related to #1414, tracking maps for the configuration-space APIs in #846, #863 and #883. An API map records the implemented status and source location of each requirement for an API, so the gap between a planned API and the current library stays visible in-tree.

Changes

Adds three maps under Physlib/ClassicalMechanics/: HarmonicOscillator/Geometric/API-map.yaml, Lagrangian/API-map.yaml and Pendulum/API-map.yaml.

The harmonic-oscillator map covers the geometric configuration-space development that exists (ConfigurationSpace, its manifold structure, the coordinate homeomorphism and diffeomorphism, trajectories and kinetic energy). The pendulum map marks the sliding-pendulum pieces that exist and leaves the manifold structure, the map to Space, trajectories and the lagrangian as not done. The general configuration-space map enumerates the per-system state of the library, with the double-pendulum stub marked not done.

References cite Landau and Lifshitz, Mechanics, 3rd ed., Chapter 1.

Testing

Ran the API-map linter:

python3 scripts/api_map_linter.py --repo .

Every declared source file and name resolves; no completed entry is missing a location.

@github-actions

Copy link
Copy Markdown
Contributor

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 awaiting-author label to your PR, once you have addressed the review comments, please remove that label by adding a comment with -awaiting-author. This helps us keep track of reviews.

@github-actions github-actions Bot added the t-classical-mechanics Classical mechanics label Jul 19, 2026
@Robby955
Robby955 marked this pull request as ready for review July 19, 2026 21:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

t-classical-mechanics Classical mechanics

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant