Skip to content

Commit

Permalink
Update changelog, add ExtData docs link, and minor fixes/edits
Browse files Browse the repository at this point in the history
Signed-off-by: Lizzie Lundgren <elundgren@seas.harvard.edu>
  • Loading branch information
lizziel committed Nov 8, 2024
1 parent 210a489 commit d929c28
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 14 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,13 @@ This file documents all notable changes to the GCHP wrapper repository starting
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).

## [Unreleased] - TBD
### Changed
- Updated compiler requirements to specify max GNU version is 12
- Updated documentation for version 14.5.0

### Added
- Added documentation about GEOS convection change affecting meteorology starting June 1, 2020

### Fixed
- Updated `docs/requirements.txt` to use `jinja2==3.1.4` (fixes a security issue)

Expand Down
14 changes: 3 additions & 11 deletions docs/source/getting-started/quick-start.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,17 +73,9 @@ the prompts:
The convection scheme used for GEOS-FP met generation changed
from RAS to Grell-Freitas with impact on GEOS-FP meteorology
files starting June 1, 2020, specifically enhanced vertical
transport. In addition, there is a bug in convective
precipitation flux following the switch where all values are
zero. While this bug is automatically fixed by computing fluxes
online for runs starting on or after June 1 2020, the fix
assumes meteorology year corresponds to simulation year. Due to
these issues we recommend splitting up GEOS-FP runs in time such
that a single simulation does not run across June
1, 2020. Instead. set one run to stop on June 1 2020 and then
restart a new run from there. If you wish to use a GEOS-FP
meteorology year different from your simulation year please
create a GEOS-Chem GitHub issue for assistance.
transport. If you plan to do simulations across this boundary
consider using MERRA2 instead. For more information see
`GEOS-Chem GitHub issue #1409<https://github.com/geoschem/geos-chem/issues/1409/>`_.

=======================
3. Configure your build
Expand Down
2 changes: 1 addition & 1 deletion docs/source/user-guide/compiling.rst
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ useful information for troubleshooting.
:literal:`CMAKE_PREFIX_PATH` variable.

For example, if you got an error saying "Could not find ESMF", and
ESMF is installedto :file:`/software/ESMF`, you would do
ESMF is installed to :file:`/software/ESMF`, you would do

.. code-block:: console
Expand Down
4 changes: 2 additions & 2 deletions docs/source/user-guide/config-files/ExtData_rc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ ExtData.rc
for GCHP. Explanatory information about the file is located at the top
of the configuration file in all run directories. The file format is
the same as that used in the GEOS model, and GMAO/NASA documentation
for it can be found at the ExtData component page on the GEOS-5
wiki. Note that this file will be retired in GCHP v15.0 when MAPL
for it can be found at the 'ExtData component page on the GEOS-5
wiki <https://geos5.org/wiki/index.php?title=Using_the_ExtData_component&mobileaction=toggle_view_desktop/>`_. Note that this file will be retired in GCHP v15.0 when MAPL
version 3 is integrated into GCHP. It will be replaced with a YAML
format file with a simplified and easier to understand interface.

Expand Down

0 comments on commit d929c28

Please sign in to comment.