Skip to content

Deprecate and remove the VIC-Hydro option #2597

Open
1 of 1 issue completed
Open

Description

@ekluzek

The VIC-Hydro option was put in 12 years ago as an experimental optional hydrology method. It has NOT been used by default and is NOT tuned for the latest physics. It also requires additional fields on the surface datasets. And as such we've only supported it for two resolutions out of the box. We haven't heard about users using it as well. VIC hydrology is also not something being actively developed currently either. And as such we are planning on deprecating and removing the VIC option.

Definition of Done:

  • Remove the extra complexity in mksurfdata_esmf and it's python scripts to handle it
  • Remove building of special datasets with VIC fields on them (we should do this as part of the ctsm5.3.0 dataset update)
  • Add it to the README files as a deprecated feature along with the other deprecated features
  • Remove VIC-hydro from our testlists
  • Remove from compsets
  • Change the namelist option so it dies with a warning that can be overridden
  • Remove the namelist option from the code, so it's hardwired to false
  • Remove the code to handle VIC

Activity

  1. added
    code healthimproving internal code structure to make easier to maintain (sustainability)
    on Jun 13, 2024
  2. ekluzek commented on Sep 25, 2024

    @ekluzek
    ContributorAuthor

    The first four items were accomplished as part of ctsm5.3.0

  3. slevis-lmwg commented on Oct 16, 2024

    @slevis-lmwg
    Contributor

    I cleaned up some unnecessary use_vichydro=.true. / .false. options in #2834 while updating namelist_defaults_ctsm.xml.

  4. ekluzek commented on Jul 17, 2026

    @ekluzek
    ContributorAuthor

    Here's some instances of VIC in the current code:

    bld/CLMBuildNamelist.pm
    bld/namelist_files/namelist_definition_ctsm.xml
    doc/source/tech_note/Introduction/CLM50_Tech_Note_Introduction.rst
    doc/source/users_guide/overview/getting-help.rst
    doc/source/users_guide/setting-up-and-running-a-case/customizing-the-clm-configuration.rst
    src/biogeophys/HydrologyDrainageMod.F90
    src/biogeophys/HydrologyNoDrainageMod.F90
    src/biogeophys/SaturatedExcessRunoffMod.F90
    src/biogeophys/SoilHydrologyInitTimeConstMod.F90
    src/biogeophys/SoilHydrologyMod.F90
    src/biogeophys/SoilHydrologyType.F90
    src/biogeophys/SoilStateType.F90
    src/main/clm_varcon.F90
    src/main/clm_varpar.F90
    tools/contrib/modify_singlept_site
    tools/mksurfdata_esmf/src/CMakeLists.txt
    tools/mksurfdata_esmf/src/mkVICparamsMod.F90
    tools/mksurfdata_esmf/src/mkfileMod.F90
    tools/mksurfdata_esmf/src/mkinputMod.F90
    tools/mksurfdata_esmf/src/mksurfdata.F90
    tools/mksurfdata_esmf/src/mkvarctl.F90
    
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    code healthimproving internal code structure to make easier to maintain (sustainability)

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions