Skip to content

Commit

Permalink
Merge PR #53 (Remove obsolete options from CH4 menu in docs)
Browse files Browse the repository at this point in the history
This merge brings PR #53 (Remove obsolete options from CH4 menu in
geoschem-config.rst, by @msulprizio) into the GEOS-Chem
"no-diff-to-benchmark" development stream.

This is a corresponding documentation update for geos-chem PR #2218.

Signed-off-by: Bob Yantosca <[email protected]>
  • Loading branch information
yantosca committed Mar 28, 2024
2 parents 3fae736 + d68501b commit 88d74e3
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 43 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),

### Changed
- Now use short submodule names (i.e. without the full path) in `.gitmodules`
- Remove obsolete CH4 menu options from config file documentation

## [14.3.0] - 2024-02-07
### Changed
Expand Down
43 changes: 0 additions & 43 deletions docs/source/gcclassic-user-guide/geoschem-config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1609,52 +1609,9 @@ the inversion parameters that you specify.
# ... preceding sub-sections omitted ...
analytical_inversion:
activate: false
emission_perturbation: 1.0
state_vector_element_number: 0
use_emission_scale_factor: false
use_OH_scale_factors: false
perturb_OH_boundary_conditions: false
CH4_boundary_condition_ppb_increase_NSEW: [0.0, 0.0, 0.0, 0.0]
.. option:: activate

Activates (:literal:`true`) or deactivates (:literal:`false`) the
analytical inversion.

Default value: :literal:`false`

.. option:: emission perturbation

Specifies a unitless factor by which emissions for this state
vector element will be perturbed.

Default value: :literal:`1.0` (no perturbation)

.. option:: state_vector_element_number

Specifies the element of the state vector corresponding to this
simulation.

Default value: :literal:`0`

.. option:: use_emission_scale_factor

Activates (:literal:`true`) or deactivates (:literal:`false`)
scaling methane emissions by a fixed factor. This scale factor is
specified in the :ref:`HEMCO_Config.rc <cfg-hco-cfg>` file.

Default value: :literal:`false`

.. option:: use_oh_scale_factors

Activates (:literal:`true`) or deactivates (:literal:`false`)
perturbation of OH in analytical inversions of methane. The OH
scale factors are specified in the :literal:`OH_SF` entry of
:ref:`HEMCO_Config.rc <cfg-hco-cfg>` file.

Default value: :literal:`false`

.. option:: perturb_CH4_boundary_conditions

Activates (:literal:`true`) or deactivatees (:literal:`false`)
Expand Down

0 comments on commit 88d74e3

Please sign in to comment.