Check for parameter and options consistency, add parameters docs - #784
Draft
trontrytel wants to merge 2 commits into
Draft
trontrytel wants to merge 2 commits into
trontrytel wants to merge 2 commits into
Conversation
Move the option/parameter consistency check from Microphysics1M to Utilities.consistent_params so MicrophysicsNonEq can use it too, and apply it to every process method that reads mp.process_params: - 1M: the six accretion methods and the three cloud liquid freezing options (the single freezing arms also accept the combined HomogeneousAndHeterogeneous parameters) - NonEq: CloudLiquidFormation, ConstantTimescale, TemperatureDependent NamedTuple parameter sets are matched by key set rather than by NamedTuple type, since ClimaParams.get_parameter_values does not preserve the name_map order. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
New "Parameters interface" section in the docs: - Parameters.md: how parameter structs are built from ClimaParams, the 1M process options, overriding values, the packaged override TOML files, usage logging, and how to add a new parameter. - generate_parameters_reference.jl: run from make.jl, it parses the constructors in src/parameters, constructs each one to record the parameters it actually reads (ClimaParams "used_in" tags), and writes a reference page mapping every ClimaParams parameter to the struct fields it feeds, with defaults and descriptions. A name_map entry that the code does not read fails the docs build. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
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
1 participant
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.
No description provided.