ReadTheDocs updates for GCHP 14.5.0 #448
Draft
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
docs/source/geos-chem-shared-docs - Changed compiler from [email protected] to [email protected] in guides docs/source/user-configuration-files.rst docs/source/user-guide/rundir-init.rst docs/source/user-guide/running.rst - Updated formatting and fixed issues flagged by Sphinx Signed-off-by: Bob Yantosca <[email protected]>
docs/requirements.txt - Use jinja 3.1.4 as there is a dependabot security warning for the previous version 3.1.3. CHANGELOG.md - Updated accordingly Signed-off-by: Bob Yantosca <[email protected]>
- Now point to geoschem_config.yml, HEMCO_Config.rc, and HEMCO_Diagn.rc, species_database.yml, and aerosol/chem/photolysis configuration files in the documentation in geos-chem-shared-docs/doc folder - Updated the configuration file overview page accordingly - Now use ".. option::" tags for easier searching of items - Reformatted text using ReST best practices - Trimmed trailing whitespace Signed-off-by: Bob Yantosca <[email protected]>
docs/source/user-guide/config-files/cap_restart - Fixed typo ":ref:`set-common-run-settings.sh`" -> ":ref:`set-common-run-settings-sh`". Signed-off-by: Bob Yantosca <[email protected]>
docs/source/user-guide/config-files/cap_restart - Updated the text so that it flows better and is less awkward Signed-off-by: Bob Yantosca <[email protected]>
docs/source/geos-chem-shared-docs - Added GCHP vs. GCC usage differences section in HEMCO_Diagn.rc doc docs/source/user-guide/configuration-files.rst - Now use reference links to the setCommonRunSettings.sh doc in the NOTE at the top of the page - Now split the configuration files into "Commonly-updated configuration files" and "Less commonly-updated configuration files" to make it clear that some config files don't normally need to be updated except under certain circumstances. - Trimmed whitespace Signed-off-by: Bob Yantosca <[email protected]>
docs/source/geos-chem-shared-docs: - Fixed typo ":ref:`ExtData.rc`" -> ":file:`ExtData.rc`" Signed-off-by: Bob Yantosca <[email protected]>
yantosca
added
TODO: Documentation
This was referenced Oct 2, 2024
docs/source/user-guide/compiling.rst docs/source/user-guide/getting-input-data.rst docs/source/user-guide/running.rst - Updated formatting using ReST best practices - Link to pages with references where expedient - Trim trailing whitespace Signed-off-by: Bob Yantosca <[email protected]>
This commit informs the GCHP superproject about the following commits that were pushed to the geos-chem-shared-docs repository: 65b2a35 Merge "docs/update_guides_for_gchp" into "main" 7f0cfbb Merge PR #3 (Add doc/tutorial for GEOS-Chem input data on AWS) These are documentation updates for the 14.5.0 release. Signed-off-by: Bob Yantosca <[email protected]>
Current MAPL does not reliably build with GCC 13. Signed-off-by: Lizzie Lundgren <[email protected]>
docs/source/geos-chem-shared-docs - Submodule update to cd0f4ad, w/ recent doc updates for 14.5.0 docs/source/getting-started/quick-start.rst - Add "Important" box for GEOS-FP convection - Now use consistent $ prompt in examples docs/source/index.rst - Update toctree link to the GEOS-Chem Input Data on AWS, which was renamed to geos-chem-shared-docs/doc/gcid-portal-overview.rst docs/HEMCO_Config.rc docs/HEMCO_Diagn.rc - Removed; Documentation for these is in geos-chem-shared-docs now docs/source/user-guide/config-files/HISTORY.rc - Fixed incorrect option name: "ref_date:" -> "ref_date" docs/source/user-guide/config-files/setCommonRunSettings.sh - Fixed incorrect option name: "extdata" -> "extdata-rc" docs/source/user-guide/debugging.rst - Added |br| break definition - Fixed links to the debug-guide and error-guide in geos-chem-shared-docs - Updated code formatting to fit w/in 80 cols (mostly) - Trimmed trailing whitespace docs/source/user-guide/getting-input-data.rst - Add text and link to new GEOS-Chem Input Data portal doc - Updated code formatting to fit w/in 80 cols (mostly) - Trimmed trailing whitespace docs/source/user-guide/rundir-config.rst - Removed "-----" breaks - Updated code formatting to fit w/in 80 cols (mostly) - Now use proper heading section delimiters - Trimmed trailing whitespace docs/source/user-guide/rundir-init.rst - Add "Important" box for GEOS-FP convection Signed-off-by: Bob Yantosca <[email protected]>
docs/source/geos-chem-shared-docs - RTD update: Link to dy-run instructions from GC Input Data doc Signed-off-by: Bob Yantosca <[email protected]>
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 seeks to merge documentation updates for GCHP 14.5.0 into the dev/14.5.0 branch. We have made the following general updates:
geoschem_config.yml,HEMCO_Diagn.rc,HEMCO_Config.rc,species_database.yml, and the aerosol/chemistry/photolysis configuration files to the https://github.com/geoschem/geos-chem-shared-docs repo... option::tags, etc)Related Github Issue
NOTES
For now I will leave this as a draft PR as we will might have more minor updates to push. But feel free to make comments & request changes on this PR now. Tagging @msulprizio @lizziel @yidant