Repository navigation
feat(data): the unit and the meaning of every parameter, in the metadata (T2 of #449) - #461
Merged
Merged
Conversation
…problem page A new metadata field `:parameter_info`, optional until every problem has it; checked by test_parameter_info, shown by the generated Parameters section. Refs #449 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Refs #449 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Refs #449 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Refs #449 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Refs #449 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Refs #449 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Refs #449 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Refs #449 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Refs #449 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Refs #449 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Refs #449 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Refs #449 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Refs #449 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Refs #449 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Refs #449 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Refs #449 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Refs #449 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Refs #449 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Refs #449 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Refs #449 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Refs #449 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Refs #449 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Refs #449 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…er sections `:parameter_info` is required: every parameter has its unit and meaning in the metadata, and the page shows them in the generated Parameters section. The hand-written parameter sections of the descriptions are removed (their values were a second copy, and 5 pages had two "Parameters" sections); the outline test refuses one. Refs #449 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
16 of 53 tasks
…er-info # Conflicts: # ext/MetaData/mountain_car.jl
3 of 4 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Refs #449 (T2, option (a) chosen by the maintainer). Stacked on #460: its base is
fix/t2-review; retarget it tomainonce #460 is merged. Applied conventions:ct-conventions v0.14.0,ct-agents v0.5.0.One source of truth for the parameters. Before this PR, the values were written in the metadata and again in hand-written tables in 17 descriptions. The page of a problem already generated a
### Parameterssection from the metadata, so 5 pages had two. Now the metadata hold the unit and the meaning of each parameter, and the page shows them.Changes
:parameter_info, a required field of the metadata: one entry per parameter, in the order of:parameters.unitisnothingfor a dimensionless parameter, or for one whose unit the sources do not give (the academic problems,jackson,robot,insurance…).test_parameter_info): the keys are exactly the parameters, each entry is(unit, meaning)with a non-empty meaning.parameters_sectionindocs/problems.jl): Parameter | Default value | Unit | Meaning.balanced_field: values of a mid-size jet, from Dymos) moves to the introduction.Found on the way (for T3)
Some parameters are not read by the models; their meaning says so:
brachistochrone:u_min,u_max(±π) are read, but the OptimalControl and JuMP models bound the control by ±1.57 written in the code (andtfby 0.1 and 20).balanced_field:v_min,v_maxare not read;α_minis read but unused (the models use0 ≤ α, andv ≥ 1,tf ≥ 0.1in the code).space_shuttle:α_t0is used neither by the models nor by the initial guess.The formatter also wrapped the long
:statuslines of 4 metadata files.Test plan
Pkg.test(; test_args=["core"]): 2812 passed, 1 broken (the existing@test_skipoftest_discovery_cache.jl).rocket: the four columns, with–for no unit.🤖 Generated with Claude Code