RTD update: Remove "Scale (or zero) emissions w/ a rectangular mask"

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]>
geoschem · Aug 14, 2024 · a657308 · a657308
1 parent 41605bd
commit a657308
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 47 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
 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
+### Removed
+- Example "Scale (or zero) emissions with a rectangular mask" from ReadTheDocs. This is currently not working.
+
 ## [3.9.3] - 2024-08-13
 ### Fixed
 - Added brackets around `exempt-issue-labels` list in `.github/workflows/stale.yml`

diff --git a/docs/source/hco-ref-guide/more-examples.rst b/docs/source/hco-ref-guide/more-examples.rst
@@ -90,53 +90,6 @@ These steps can also be used to scale emissions for different regions
 (e.g. provinces, states) by providing HEMCO with a mask file
 containing the regions to be scaled.
 
-
-.. _cfg-ex-scl-rec-mask:
-
-Scale (or zero) emissions with a rectangular mask
--------------------------------------------------
-
-.. important::
-
-   If you are using HEMCO versions prior to 3.5.0, you may encounter a
-   bug when trying to follow this example. See Github issue:
-   https://github.com/geoschem/HEMCO/issues/153 for a workaround.
-
-Another way to scale all emissions over a country (or set them to
-zero) is to apply a rectangular mask.
-
-For example, to set all emissions over Australia and surrounding
-islands to zero, add this line to the :ref:`hco-cfg-masks` section of
-:ref:`the HEMCO configuration file <hco-cfg>`:
-
-.. code-block:: kconfig
-
-    1010 AUS_MASK 105.0/-46.0/160.0/-10.0 - 2000/1/1/0 C xy 1 1 105/-46/160/–10
-
-Here you directly provide the lower left and upper right corner of the
-mask region mask instead of a netCDF file:
-:literal:`lon1/lat1/lon2/lat2` You can then combine this mask with
-a scale factor of zero to eliminate any emissions over that area.
-
-In :ref:`Base emissions <hco-cfg-base>`
-
-.. code-block:: kconfig
-
-    0 HTAP_NO_IND /path/to/HTAP_NO_INDUSTRY.generic.01x01.nc emi_no 2008-2010/1-12/1/0 C xy kg/m2/s NO 1/27/25/501 1/2 4
-
-In :ref:`Scale Factors <hco-cfg-scalefac>`:
-
-.. code-block:: kconfig
-
-   501 SCALE_AUS 0.0 - - - xy unitless 1 1010
-
-In :ref:`hco-cfg-masks`:
-
-.. code-block:: kconfig
-
-   # Defines a rectangular region that should cover AUS + surrounding islands
-   1010 AUS_MASK 105.0/-46.0/160.0/-10.0 – 2000/1/1/0 C xy 1 1 105.0/-46.0/160.0/-10.0
-
 .. _cfg-ex-scl-spc:
 
 Scale emissions by species