Add benchmark script to create species changes tables for GEOS-Chem wiki #337
Conversation
This file contains 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
gcpy/benchmark/modules/benchmark_species_changes.py - Added this script to compute a table of species that have changed between each version, along with corresponding metadata CHANGELOG.md - Updated accordingly Signed-off-by: Bob Yantosca <[email protected]>
gcpy/benchmark/modules/benchmark_species_changes.py - Add Pydoc headers - Add code to generate the wiki tables for "Species added" and "Species removed" - Print out the list of species with changed attributes (you then can use this info to manually create the table) - Now use argparse to handle input arguments Signed-off-by: Bob Yantosca <[email protected]>
gcpy/benchmark/modules/benchmark_species_changes.py - Renamed function "create_wiki_tables" to "make_benchmark_species_changes_wiki_tables" Signed-off-by: Bob Yantosca <[email protected]>
yantosca
added
category: Feature Request
lizziel
requested changes
Oct 3, 2024
gcpy/benchmark/modules/benchmark_species.py - Added a new line (\n) after the line with bgcolor, in order to have the table render properly. Signed-off-by: Bob Yantosca <[email protected]>
gcpy/benchmark/modules/benchmark_species_changes.py
- Add "\n" after cellpadding in the first table header line
- Add bgcolor tag for each header column
- Now use proper Heading 3 tag ("=== ===")
Signed-off-by: Bob Yantosca <[email protected]>
|
Thanks @lizziel. Running this command: python -m gcpy.benchmark.modules.benchmark_species_changes \
--ref-label "14.5.0-alpha.5" \
--ref-log "14.5.0-alpha.5/runlog.txt" \
--dev-label "14.5.0-alpha.9" \
--dev-log "14.5.0-alpha.9/runlog.txt" \
--spcdb-dir "14.5.0-alpha.9" \
--output-file "wiki_tables.txt"gives this output Species with changes (also check advected species) ALK4N2 {'DryDepId': {'Ref': False, 'Dev': True}}
ALK4P {'DryDepId': {'Ref': False, 'Dev': True}}
PPN {'PhotolId': {'Ref': False, 'Dev': True}}
RCOOH {'DryDepId': {'Ref': False, 'Dev': True}, 'WetDepId': {'Ref': False, 'Dev': True}}and also writes these tables Which looks like this: and this We can skip posting a table to the wiki if it has no species added/removed. |
lizziel
approved these changes
Oct 4, 2024
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.
Name and Institution (Required)
Name: Bob Yantosca
Institution: Harvard + GCST
Describe the update
This PR adds a script to print tables (in MediaWiki format) of GEOS-Chem species that were added or removed between two GEOS-Chem benchmark versions. It is called with e.g.:
We also have modified the "Added" entries in the
CHANGELOG.mdfile so that they start with the verb "Added".Expected changes
This PR is a zero-diff update w/r/t existing benchmark functionality. It adds a script that can be manually called to generate tables of species that have changed between benchmarks.