Removing some options from documentation (#866)

* Removing OUTPUT_CHAN_CONN option from documentation, making an easter egg since its use is very niche

* Removing unsupported WRF_HYDRO_RAPID from documentation. Only printing WRF_HYDRO_RAPID and OUTPUT_CHAN_CONN variable values during the build process if they are turned on.

* Update docs/userguide/model-code-config.rest

Co-authored-by: Copilot <[email protected]>

Author: scrasmussen

CMakeLists.txt

@@ -146,8 +146,8 @@ if (HYDRO_D STREQUAL "1" )
 endif()
 
 # set -DWRF_HYDRO_RAPID from env
-message("WRF_HYDRO_RAPID = " ${WRF_HYDRO_RAPID} )
 if (WRF_HYDRO_RAPID STREQUAL "1" )
+        message("WRF_HYDRO_RAPID = " ${WRF_HYDRO_RAPID} )
         add_definitions(-DWRF_HYDRO_RAPID)
 endif()
 
@@ -182,8 +182,8 @@ if (WRF_HYDRO_NUDGING STREQUAL "1" )
 endif()
 
 #set -DOUTPUT_CHAN_CONN from env
-message("OUTPUT_CHAN_CONN = " ${OUTPUT_CHAN_CONN} )
 if (OUTPUT_CHAN_CONN STREQUAL "1" )
+        message("OUTPUT_CHAN_CONN = " ${OUTPUT_CHAN_CONN} )
         add_definitions(-DOUTPUT_CHAN_CONN)
         # requires nudging io module
         set(WRF_HYDRO_NUDGING_IO "1")

docs/BUILD.rst

@@ -73,8 +73,6 @@ available options are described in the following table.
 +------------------------------------+-------------------------------------------------------------------------------+
 | ``-DNWM_META=1``                   | Output NWM Metadata                                                           |
 +------------------------------------+-------------------------------------------------------------------------------+
-| ``-DOUTPUT_CHAN_CONN=1``           | For gridded channel routing, write the channel connectivity to a netcdf file  |
-+------------------------------------+-------------------------------------------------------------------------------+
 | ``-DPRECIP_DOUBLE=1``              | Double precipitation from hydro forcing                                       |
 +------------------------------------+-------------------------------------------------------------------------------+
 | ``-DNCEP_WCOSS=1``                 | Do not use unless working on the WCOSS machines                               |
@@ -85,8 +83,6 @@ available options are described in the following table.
 +====================================+===============================================================================+
 | ``-DWRF_HYDRO_NUOPC=1``            | Coupling with NUOPC, this option is not currently supported                   |
 +------------------------------------+-------------------------------------------------------------------------------+
-| ``-DWRF_HYDRO_RAPID=1``            | Coupling with the RAPID routing model, this option is not currently supported |
-+------------------------------------+-------------------------------------------------------------------------------+
 
 
 CMake Testcase

docs/userguide/model-code-config.rest

@@ -400,10 +400,8 @@ below along with a description of what each option does:
 
    HYDRO_D = 0                *Set to 1 for enhanced diagnostic output*
 
-   WRF_HYDRO_RAPID = 0         *Currently unsupported, always set to 0*
-
    SPATIAL_SOIL = 1               *Set to 1 to allow NoahMP LSM to use*
-                                    *spatially distrubuted parameteter*
+                                    *spatially distributed parameter*
                                   *vs. a table based on soil class and*
                                                   *land use categories*
 
@@ -416,9 +414,6 @@ below along with a description of what each option does:
 
    WRF_HYDRO_NUDGING = 0         *Set to 1 if using streamflow nudging*
 
-   OUTPUT_CHAN_CONN = 0            *Set to 1 to output channel network*
-                                               *diagnostic information*
-
    PRECIP_DOUBLE = 0                  *Set to 1 to double all incoming*
                               *precipitation (for debug purposes only)*