[WIP] Add comprehensive internal-only parameters analysis for issue #555#556
Draft
[WIP] Add comprehensive internal-only parameters analysis for issue #555#556
Conversation
- Created analyze_internal_only_parameters.py script to scan data model files - Generated table comparing with sample_config.yml instead of benchmark1.yml - Found 24 total internal-only parameters (11 in sample_config, 13 not) - Provides CSV table and markdown report for analysis - Script can be re-run as data model evolves Key findings: - 11 parameters present in sample_config.yml need review - 13 parameters are true internal state variables - Parameters span state.py (22) and model.py (2) Addresses GitHub issue #555: Identify complete list of internal-only parameters 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Updated analyze_internal_only_parameters.py to exclude description from CSV - Regenerated internal_only_parameters_table.csv with cleaner format - Kept descriptions in markdown report for full analysis - CSV now has: param_name, file_location, in_sample_config, sample_config_location, unit 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Updated script to remove descriptions from all tables in markdown report - Simplified format: Parameter | In sample_config.yml | Unit - Cleaner, more focused output for both CSV and markdown - Maintains all essential information without verbose descriptions 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Removed unit column from all markdown tables - Removed "Location in sample_config.yml" column from present parameters table - Simplified format: Parameter | In sample_config.yml (main tables) - Simplified format: Parameter | File (detailed tables) - Much cleaner, focused output showing only essential information 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
Co-authored-by: dayantur <71443948+dayantur@users.noreply.github.com>
|
🤖 I've automatically formatted the code in this PR using:
Please pull the latest changes before making further edits. |
sunt05
reviewed
Jul 25, 2025
There was a problem hiding this comment.
Just a note - this is a temporary file – to be cleaned up upon wrapping up this work.
|
Some more audit trail - this field was first introduced in #439 . |
sunt05
changed the title
sunt05
reviewed
Jul 25, 2025
|
|
||
| ## Parameters Present in sample_config.yml | ||
|
|
||
| These parameters are marked as internal-only but appear in the sample configuration: |
There was a problem hiding this comment.
All of these can be moved out of the user-facing YAML.
sunt05
changed the title
- Document criteria for identifying internal-only parameters - List all 24 currently identified internal parameters - Provide recommendations for additional parameters (tair_av, hdd_id) - Clarify which parameters should remain user-accessible (state, SPARTACUS, snowfallcum) - Flag diagnose parameter for further discussion - Include implementation notes for developers Addresses #555
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
2 participants
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.
This PR created a complete analysis system to identify and catalog internal-only parameters.
Features:
Key findings:
Script automatically compares against sample_config.yml instead of benchmark1.yml and can be re-run as the data model evolves.
Addresses GitHub issue #555: Identify complete list of internal-only parameters.