Skip to content

Commit

Permalink
Merge GCHP 14.4.2 back into the 14.5.0 development stream
Browse files Browse the repository at this point in the history
This merge brings the GCHP 14.4.2 release into the GCHP
14.5.0 development stream.  14.4.2 is a zero-diff update.  The
CHANGELOG.md has been updated accordingly.

Signed-off-by: Bob Yantosca <[email protected]>
  • Loading branch information
yantosca committed Jul 24, 2024
2 parents dfbd38d + 8560108 commit ce7df31
Show file tree
Hide file tree
Showing 10 changed files with 32 additions and 23 deletions.
15 changes: 10 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,19 @@
# Changelog

This file documents all notable changes to the GCHP wrapper repository starting in version 14.0.0. See also CHANGELOG files for individual submodules, such as:
- src/GCHP_GridComp/GEOSChem_GridComp/geos-chem/CHANGELOG.md
- src/GCHP_GridComp/GEOSChem_GridComp/HEMCO/CHANGELOG.md
- src/GCHP_GridComp/GEOSChem_GridComp/Cloud-J/CHANGELOG.md
- src/GCHP_GridComp/GEOSChem_GridComp/HETP/CHANGELOG.md
- src/MAPL/CHANGELOG.md
- `src/GCHP_GridComp/GEOSChem_GridComp/geos-chem/CHANGELOG.md`
- `src/GCHP_GridComp/GEOSChem_GridComp/HEMCO/CHANGELOG.md`
- `src/GCHP_GridComp/GEOSChem_GridComp/Cloud-J/CHANGELOG.md`
- `src/GCHP_GridComp/GEOSChem_GridComp/HETP/CHANGELOG.md`
- `src/MAPL/CHANGELOG.md`

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [14.4.2] - 2024-07-24
### Changed
- Updated Cloud-J submodule to 7.7.2
- Disable support for FAST-JX for all simulations except Hg

## [14.4.1] - 2024-06-28
### Fixed
- Fixed formatting error in `.github/workflows/stale.yml` that caused the Mark Stale Issues action not to run
Expand Down
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
cmake_minimum_required (VERSION 3.13)
project (gchp_ctm
VERSION 14.4.1
VERSION 14.4.2
LANGUAGES Fortran CXX C
)

Expand Down
25 changes: 14 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,21 @@ Thank you for looking into contributing to GEOS-Chem! GEOS-Chem is a grass-roots
Updates to the GEOS-Chem model benefit both you and the [entire GEOS-Chem community](https://geoschem.github.io/people.html). You benefit through [coauthorship and citations](https://geoschem.github.io/new-developments.html). Priority development needs are identified at GEOS-Chem users' meetings with updates between meetings based on [GEOS-Chem Steering Committee (GCSC)](https://geoschem.github.io/steering-committee.html) input through [Working Groups](https://geoschem.github.io/working-groups.html).

## We use GitHub and ReadTheDocs
We use GitHub to host the GCHP source code, to track issues, user questions, and feature requests, and to accept pull requests: [https://github.com/geoschem/GCHP](https://github.com/geoschem/GCHP). Please help out as you can in response to issues and user questions.
We use GitHub to host the GEOS-Chem Classic source code, to track issues, user questions, and feature requests, and to accept pull requests: [https://github.com/geoschem/geos-chem](https://github.com/geoschem/geos-chem). Please help out as you can in response to issues and user questions.

GCHP Classic documentation can be found at [gchp.readthedocs.io](https://geos-chem.readthedocs.io).
GCHP documentation can be found at [gchp.readthedocs.io](https://geos-chem.readthedocs.io).

## When should I submit updates?

Submit bug fixes right away, as these will be given the highest priority. Please see "Support Guidelines" for more information.
Submit bug fixes right away, as these will be given the highest
priority. Please see **[Support Guidelines](https://gchp.readthedocs.io/en/latest/reference/SUPPORT.html)** for more information.

Submit updates (code and/or data) for mature model developments once you have submitted a paper on the topic. Your Working Group chair can offer guidance on the timing of submitting code for inclusion into GEOS-Chem.

The practical aspects of submitting code updates are listed below.

## How can I submit updates?
We use [GitHub Flow](https://guides.github.com/introduction/flow/index.html), so all changes happen through pull requests. This workflow is [described here](https://guides.github.com/introduction/flow/index.html).
We use **GitHub Flow**, so all changes happen through [pull requests](https://help.github.com/articles/creating-a-pull-request/). This workflow is [described here](https://docs.github.com/en/get-started/using-github/github-flow).

As the author you are responsible for:
- Testing your changes
Expand All @@ -33,11 +34,12 @@ As the author you are responsible for:
4. [Fork the relevant GEOS-Chem repositories](https://help.github.com/articles/fork-a-repo/) into your Github account.
5. Clone your forks of the GEOS-Chem repositories to your computer system.
6. Add your modifications into a [new branch](https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell) off the **main** branch.
7. Test your update thoroughly and make sure that it works. For structural updates we recommend performing a difference test (i.e. testing against the prior version) in order to ensure that identical results are obtained).
8. Review the coding conventions and checklists for code and data updates listed below.
9. Create a [pull request in GitHub](https://help.github.com/articles/creating-a-pull-request/).
10. The [GEOS-Chem Support Team](https://geoschem.github.io/support-team.html) will add your updates into the development branch for an upcoming GEOS-Chem version. They will also validate your updates with [benchmark simulations](http://wiki.geos-chem.org/GEOS-Chem_benchmarking).
11. If the benchmark simulations reveal a problem with your update, the GCST will request that you take further corrective action.
7. Add a sentence to the `CHANGELOG.md` file describing your update.
8. Test your update thoroughly and make sure that it works. For structural updates we recommend performing a difference test (i.e. testing against the prior version) in order to ensure that identical results are obtained).
9. Review the coding conventions and checklists for code and data updates listed below.
10. Create a [pull request in GitHub](https://help.github.com/articles/creating-a-pull-request/).
11. The [GEOS-Chem Support Team](https://geoschem.github.io/support-team.html) will add your updates into the development branch for an upcoming GEOS-Chem version. They will also validate your updates with [benchmark simulations](http://wiki.geos-chem.org/GEOS-Chem_benchmarking).
12. If the benchmark simulations reveal a problem with your update, the GCST will request that you take further corrective action.

### Coding conventions
The GEOS-Chem codebase dates back several decades and includes contributions from many people and multiple organizations. Therefore, some inconsistent conventions are inevitable, but we ask that you do your best to be consistent with nearby
Expand All @@ -48,8 +50,9 @@ code.
1. Use Fortran-90 free format instead of Fortran-77 fixed format.
2. Include thorough comments in all submitted code.
3. Include full citations for references at the top of relevant source code modules.
4. Remove extraneous code updates (e.g. testing options, other science).
5. Submit any related code or configuration files for [GCHP](https://gchp.readthedocs.io) along with code or configuration files for [GEOS-Chem Classic](https://geos-chem.readthedocs.io).
4. Check that you have updated the `CHANGELOG.md` file.
5. Remove extraneous code updates (e.g. testing options, other science).
6. Submit any related code or configuration files for [GCHP](https://gchp.readthedocs.io) along with code or configuration files for [GEOS-Chem Classic](https://geos-chem.readthedocs.io).

### Checklist for submitting data files

Expand Down
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
author = 'GEOS-Chem Support Team'

# The full version, including alpha/beta/rc tags
release = '14.4.1'
release = '14.4.2'


# -- General configuration ---------------------------------------------------
Expand Down
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ use Spack to install GCHP's dependencies if needed.

geos-chem-shared-docs/supplemental-guides/load-libraries-guide.rst
geos-chem-shared-docs/supplemental-guides/spack-guide.rst
geos-chem-shared-docs/supplemental-guides/geos-chem-input-data-on-aws.rst
supplement/setting-up-aws-parallelcluster.rst
supplement/caching-input-data.rst
supplement/containers.rst
Expand Down
2 changes: 1 addition & 1 deletion src/GCHP_GridComp/GEOSChem_GridComp/geos-chem
Submodule geos-chem updated 44 files
+22 −1 CHANGELOG.md
+15 −3 GeosCore/cldj_interface_mod.F90
+6 −3 GeosCore/diagnostics_mod.F90
+7 −0 GeosCore/gc_environment_mod.F90
+2 −2 GeosCore/hco_interface_gc_mod.F90
+18 −1 GeosCore/input_mod.F90
+15 −6 GeosCore/photolysis_mod.F90
+0 −14 GeosCore/ucx_mod.F90
+19 −17 Headers/input_opt_mod.F90
+8 −4 Headers/state_grid_mod.F90
+13 −0 History/history_mod.F90
+19 −14 History/history_netcdf_mod.F90
+310 −266 run/CESM/HEMCO_Config.rc
+1 −0 run/CESM/geoschem_config.yml
+1 −1 run/GCClassic/HEMCO_Config.rc.templates/HEMCO_Config.rc.aerosol
+1 −1 run/GCClassic/HEMCO_Config.rc.templates/HEMCO_Config.rc.fullchem
+2 −11 run/GCClassic/HISTORY.rc.templates/HISTORY.rc.CH4
+1 −10 run/GCClassic/HISTORY.rc.templates/HISTORY.rc.CO2
+1 −11 run/GCClassic/HISTORY.rc.templates/HISTORY.rc.Hg
+1 −10 run/GCClassic/HISTORY.rc.templates/HISTORY.rc.TransportTracers
+1 −6 run/GCClassic/HISTORY.rc.templates/HISTORY.rc.aerosol
+2 −11 run/GCClassic/HISTORY.rc.templates/HISTORY.rc.carbon
+1 −2 run/GCClassic/HISTORY.rc.templates/HISTORY.rc.fullchem
+1 −11 run/GCClassic/HISTORY.rc.templates/HISTORY.rc.metals
+1 −11 run/GCClassic/HISTORY.rc.templates/HISTORY.rc.tagCO
+1 −10 run/GCClassic/HISTORY.rc.templates/HISTORY.rc.tagO3
+8 −0 run/GCClassic/createRunDir.sh
+1 −0 run/GCClassic/geoschem_config.yml.templates/geoschem_config.yml.Hg
+1 −0 run/GCClassic/geoschem_config.yml.templates/geoschem_config.yml.aerosol
+1 −0 run/GCClassic/geoschem_config.yml.templates/geoschem_config.yml.fullchem
+1 −1 run/GCHP/HEMCO_Config.rc.templates/HEMCO_Config.rc.fullchem
+2 −0 run/GCHP/createRunDir.sh
+1 −0 run/GCHP/geoschem_config.yml.templates/geoschem_config.yml.fullchem
+1 −0 run/GEOS/geoschem_config.yml
+1 −0 run/WRF/fullchem/geoschem_config.yml
+2 −0 run/shared/settings/geosfp/geosfp.preprocessed_ll.txt
+2 −0 run/shared/settings/geosfp/geosfp.raw_ll.txt
+2 −0 run/shared/settings/geosit/discover/geosit.raw_cs.discover.txt
+2 −0 run/shared/settings/geosit/discover/geosit.raw_ll.discover.txt
+2 −0 run/shared/settings/geosit/geosit.preprocessed_ll.txt
+2 −0 run/shared/settings/geosit/geosit.raw_cs.txt
+2 −0 run/shared/settings/geosit/geosit.raw_ll.txt
+2 −0 run/shared/settings/merra2.txt
+2 −0 run/shared/settings/modele2.1.txt
2 changes: 1 addition & 1 deletion src/MAPL

0 comments on commit ce7df31

Please sign in to comment.