Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ReadTheDocs updates for HEMCO 3.10.0 #292

Merged
merged 9 commits into from
Nov 7, 2024
Merged

ReadTheDocs updates for HEMCO 3.10.0 #292

merged 9 commits into from
Nov 7, 2024

Conversation

yantosca
Copy link
Contributor

@yantosca yantosca commented Oct 2, 2024

Name and Institution (Required)

Name: Bob Yantosca
Institution: Harvard + GCST

Describe the update

This PR seeks to merge documentation updates for HEMCO 3.10.0 into the dev/3.10.0 branch. We have made the following general updates:

  • Moved documentation for 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.
  • Now point to relocated documentation files in the geos-chem-shared-docs repo
  • Added usage differences between GCHP and GCC for the various documentation files
  • Updated formatting to improve the page rendering and usability (i.e. using .. option:: tags, etc)
  • Added doc for the HEMCO standalone dry-run
  • Changed version numbers from 3.9.3 to 3.10.0 in all relevant locations

Related Github Issue

NOTES

Tagging @msulprizio @lizziel @yidant

docs/source/hco-ref-guide/more-examples.txt
- Removed the "Scale (or zero) emissions with a rectangular mask" example
  from the "More configuration examples" chapter.  @msulprizio pointed
  out in issue #286 that applying a scale factor to a mask does not
  currently work, and so this example also does not work properly.

CHANGELOG.md
- Updated accordingly

Signed-off-by: Bob Yantosca <[email protected]>
docs/source/geos-chem-shared-docs
- Updated GNU 10.2.0 -> GNU 12.2.0 in Spack guide

docs/source/hco-sa-guide/login-env.rst
- Update environment file sample + text for GNU 12.2.0 compilers

docs/source/hco-sa-guide/software.rst
- The "skip ahead" link now poionts to the "Download the source code"
  chapter.

runHEMCO.sh
- Now pipe output to log file
- Also updated default SLURM partitions

Signed-off-by: Bob Yantosca <[email protected]>
This commit informs the HEMCO superproject about the following
commits pushed to the geos-chem-shared-docs submodule:

a68981b Update [email protected] -> [email protected] in load-libraries-guide.rst

This updates the GCC compiler version from 10.2.0 to 12.2.0 in the
various documentation pages.

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]>
This commit informs the HEMCO superproject about the following
commits that were pushed to the GitHub geos-chem-shared-docs repo:

8ed145c Fixed typo in doc/geoschem-config.rst
9c7903d Add GCHP vs. GCC usage differences in HEMCO_Diagn.rc doc
b5420bb Add info about usage differences between GCHP & GCC
679cf4c Update geoschem-config.rst and phot-chem.rst
7a3e9db Created doc folder for common docs (not supplemental-guides)

Signed-off-by: Bob Yantosca <[email protected]>
@yantosca yantosca added TODO: Documentation Improvements or additions to documentation no-diff-to-benchmark This update will have no impact on benchmark simulations labels Oct 2, 2024
@yantosca yantosca added this to the 3.10.0 milestone Oct 2, 2024
@yantosca yantosca self-assigned this Oct 2, 2024
This commit informs the HEMCO 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 GEOS-Chem 14.5.0 release.

Signed-off-by: Bob Yantosca <[email protected]>
docs/source/geos-chem-shared-docs
- Submodule update to cd0f4ad (Updates for GC Input Data portal etc)

docs/source/hco-sa-guide/download-data.rst
- Add text about the new GEOS-Chem Input Data portal
- Add toctree with links to dry-run doc, Globus doc, and
  bashdatacatalog doc

docs/source/hco-sa-guide/hco-sa-dry-run.rst
- Added this page, based on the GEOS-Chem Classic dry-run doc

docs/source/hco-sa-guide/hco-sa-globus
- Added this placeholder page

docs/source/index.rst
- Added "GEOS-Chem Input Data on AWS" to supplemental guides toctree

run/download_data.py
run/download_data.yml
- Added these files, from GEOS-Chem 14.5.0 dry-run

CHANGELOG.md
- Updated accordingly

Signed-off-by: Bob Yantosca <[email protected]>
docs/source/geos-chem-shared-docs:
- RTD update: Link to dry-run instructions from GC Input Data doc

Signed-off-by: Bob Yantosca <[email protected]>
CHANGELOG.md
CMakeLists.txt
docs/source/conf.py
src/Core/hco_error_mod.F90
- Changed version numbers from 3.9.3 to 3.10.0

docs/source/hco-ref-guide/known-bugs.rst
- Added links to Github for open and resolved bugs

docs/source/hco-ref-guide/version-history
- Updated link text
- Added link to GitHub releases page

docs/source/hco-sa-guide/download-code.rst
- Added --recurse-submodules to git clone command
- Removed text about checking out a different branch

docs/source/hco-sa-guide/hardware.rst
- Removed link to geos-chem-cloud RTD page (it's obsolete)
- Added breaks after each list item for readability

docs/source/hco-sa-guide/hco-sa-dry-run.rst
- Added code for line break character

docs/source/hco-sa-guide/hco-sa-globus
- Renamed to hco-sa-globus.rst

docs/source/hco-sa-guide/hco-sa-globus.rst
- Added text

Signed-off-by: Bob Yantosca <[email protected]>
@yantosca yantosca marked this pull request as ready for review November 7, 2024 17:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-diff-to-benchmark This update will have no impact on benchmark simulations TODO: Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants