add new snow compaction option & revise README doc

hrldas/docs/README.ERA5

@@ -10,37 +10,35 @@ Dr. Tzu-Shun Lin (tslin2@ucar.edu) and Dr. Zhe Zhang (zhezhang@ucar.edu) from NC
 
 --------------------------------------------------
 
-and Compile HRLDAS
+2. Compile HRLDAS
 
-Place the HRLDAS tar file where you will be running the model. 
+2.1 Download the model code where you will be running the model:
 
-tar xvf HRLDAS-v3.x.tar
+`git clone --recurse-submodules https://github.com/NCAR/hrldas`
 
-I will refer to this location as /root_path/HRLDAS-v3.x
+2.2 Configure and Compile:
 
-In /root_path/HRLDAS-v3.x, modify user_build_options to link to the proper compilers and paths.
+`cd ./hrldas/hrldas`
 
- To compile with parallel version
-  edit the file 'user_build_options'
-  uncommment the compiler section with MPI (available for pgf90 and ifort compilers)
+`./configure`
 
- To compile with sequential version
-  edit the file 'user_build_options'
-  uncommment the compiler section without MPI
+Type your compiler option in number in the command line. A new configuration file user_build_options will appear in the directory. Go into the file and edit the correct path to necessary libraries.
 
-type 'make'
+After editing the user_build_options file, we can now compile the model with a simple command:
+
+`make`
 
 If successful, there should be two executables created
 
 HRLDAS_forcing/create_forcing.exe
 
-and 
+and
 
 run/hrldas.exe
 
 --------------------------------------------------
 
-2. Download ERA5-Land forcing data.
+3. Download ERA5-Land forcing data.
 The ERA5-Land data are in 0.1-deg resolution for global coverage and hourly interval from 1950 to present.
 
 Get the ERA5-Land raw files in GRIB1 format. They can be retrieved from here:
@@ -66,7 +64,7 @@ These two datasets are provided in GRIB1, GRIB2, and netCDF4 format. I recommend
 
 --------------------------------------------------
 
-3. Pre-processing ERA5-Land foring data
+4. Pre-processing ERA5-Land foring data
 
 Prepare_ERA5-Land_Forcing.sh: extract the individual variables from the ERA5 files
 (this extracting program was originaally written with python, while users might have encountered issues with discrepancies between python version 2 and 3. Thus, we decide to adapt to a shell code Prepare_ERA5-Land_Forcing.sh provided by Alessandro Anav (alessandro.anav@enea.it), that is also faster and simpler in extracting ERA5-land forcing data in one step. We really appreciate the user's contribution!)
@@ -75,7 +73,7 @@ Note: You will need eccodes module, cdo module, and shell program for this step.
 
 Or you will need to install eccodes: An installation guide for eccodes is provided by ECMWF at this link: https://confluence.ecmwf.int/display/ECC/ecCodes+installation and also see this discussion page provided by Ehsan Jalilvand (ehsanj@msu.edu): https://github.com/NCAR/hrldas/discussions/111
 
-3.1 Extract individial variables from the ERA5-Land GRIB files
+4.1 Extract individial variables from the ERA5-Land GRIB files
 
 In Prepare_ERA5-Land_Forcing.sh, users only need to modify one place to successfully run the shell code, that is to provide the input file names, shown below.
 
@@ -94,7 +92,7 @@ Note: for running the shell code for pre-processing, an additional last time ste
 --------------------------------------------------
 
 
-3.2 extract_era5_init.py: extract the initial-only fields (**SKT, SD, STL1-4, SWV1-4**) from the ERA5-Land GRIB file 
+4.2 extract_era5_init.py: extract the initial-only fields (**SKT, SD, STL1-4, SWV1-4**) from the ERA5-Land GRIB file 
 
 **Note**: in the ERA5-Land data documentation (https://codes.ecmwf.int/grib/param-db/?id=141), the variable snow depth water equivalent (SWE) is with short name **sd**. It is easy to get confused with another variable snow depth that has a short name **sde**. The model requires snow water equivalent, hence **sd** is the correct variable to download and process. 
 
@@ -107,7 +105,7 @@ Run the python code:
 
 --------------------------------------------------
 
-3.3 Run the HRLDAS pre-processor code.
+4.3 Run the HRLDAS pre-processor code.
 
 At this point, you should have all the ERA5 output extracted into different directories at /extracted_ERA5_data_path/. Now it's finally time to run the first step of the HRLDAS.
 
@@ -119,7 +117,7 @@ cp run/examples/ERA5/namelist.input.ERA5 .
 
 --------------------------------------------------
 
-3.3.1 Modify the namelist
+4.3.1 Modify the namelist
 Note: I have made changes to this namelist here. Please see an updated version in /HRLDAS_forcing/run/example/ERA5/namelist.input.ERA5
 Modifying the namelist.input.ERA5 to your case. The following is a short description of each line in the file. A longer description is available in README.namelist
 
@@ -161,7 +159,7 @@ Modifying the namelist.input.ERA5 to your case. The following is a short descrip
 
 Note: for ERA5 there will be no need to include a secondary SW and precipitation file, so just set them to be the same
 
-3.3.2 Run the pre-processor
+4.3.2 Run the pre-processor
 
 Note: please use create_forcing_netcdf.F for this purpose. 
 `cp create_forcing_netcdf.F create_forcing.F`
@@ -173,13 +171,13 @@ Run the pre-processor with the ERA5 namelist
 
 In your OUTPUTDIR, you should now have all your LDASIN files.
 
-4. Run HRLDAS
+5. Run HRLDAS
 
 The hard part is over. Go to the HRLDAS Run directory:
 
 cd /hrldas/hrldas/run
 
-4.1 Modify the namelist
+5.1 Modify the namelist
 
 There is an example namelist.hrldas in the examples/ERA5/ directory. Copy this to the run/ directory
 
@@ -234,7 +232,7 @@ See the full documentation for a complete description of items, but these are th
 
 Note the newest version HRLDAS can cope with different soil layer thickness, so don't need to change soil thickness: https://github.com/NCAR/hrldas/commit/ba09bf052c22f1e0fcbb93065998f3903ce2c033
 
-4.2 Run the HRLDAS
+5.2 Run the HRLDAS
 
 ./hrldas.exe
 

hrldas/docs/README.NARR

@@ -8,37 +8,35 @@ Steps for running a HRLDAS simulation using NARR for forcing. Confirm that your
 
 2. Compile HRLDAS
 
-Place the HRLDAS tar file where you will be running the model. 
+2.1 Download the model code where you will be running the model:
 
-tar xvf HRLDAS-v3.x.tar
+`git clone --recurse-submodules https://github.com/NCAR/hrldas`
 
-I will refer to this location as /root_path/HRLDAS-v3.x
+2.2 Configure and Compile:
 
-In /root_path/HRLDAS-v3.x, modify user_build_options to link to the proper compilers and paths.
+`cd ./hrldas/hrldas`
 
- To compile with parallel version
-  edit the file 'user_build_options'
-  uncommment the compiler section with MPI (available for pgf90 and ifort compilers)
+`./configure`
 
- To compile with sequential version
-  edit the file 'user_build_options'
-  uncommment the compiler section without MPI
+Type your compiler option in number in the command line. A new configuration file user_build_options will appear in the directory. Go into the file and edit the correct path to necessary libraries.
 
-type 'make'
+After editing the user_build_options file, we can now compile the model with a simple command:
+
+`make`
 
 If successful, there should be two executables created
 
 HRLDAS_forcing/create_forcing.exe
 
-and 
+and
 
 run/hrldas.exe
 
 --------------------------------------------------
 
 3. Prepare NARR-based forcing data.
 
-This step can be quite involved for a first-time user. It involves converting NARR output in GRIB format to HRLDAS forcing files in NetCDF format. This will be done in the /root_path/HRLDAS-v3.x/HRLDAS_forcing/ directory. In that directory you will find another directory named run/examples/NARR that contains some useful scripts for doing the NARR steps below.
+This step can be quite involved for a first-time user. It involves converting NARR output in GRIB format to HRLDAS forcing files in NetCDF format. This will be done in the /root_path/hrldas/HRLDAS_forcing/ directory. In that directory you will find another directory named run/examples/NARR that contains some useful scripts for doing the NARR steps below.
 
 Required programs and libraries:
 
@@ -193,7 +191,7 @@ In your OUTPUTDIR, you should now have all your LDASIN files.
 
 The hard part is over. Go to the HRLDAS Run directory:
 
-cd /root_path/HRLDAS-v3.x/run
+cd /root_path/hrldas/run
 
 4.1 Modify the namelist
 

hrldas/docs/README.NLDAS

@@ -8,37 +8,35 @@ Steps for running a HRLDAS simulation using NLDAS for forcing. Confirm that your
 
 2. Compile HRLDAS
 
-Place the HRLDAS tar file where you will be running the model. 
+2.1 Download the model code where you will be running the model:
 
-tar xvf HRLDAS-v3.x.tar
+`git clone --recurse-submodules https://github.com/NCAR/hrldas`
 
-I will refer to this location as /root_path/HRLDAS-v3.x
+2.2 Configure and Compile:
 
-In /root_path/HRLDAS-v3.x, modify user_build_options to link to the proper compilers and paths.
+`cd ./hrldas/hrldas`
 
- To compile with parallel version
-  edit the file 'user_build_options'
-  uncommment the compiler section with MPI (available for pgf90 and ifort compilers)
+`./configure`
 
- To compile with sequential version
-  edit the file 'user_build_options'
-  uncommment the compiler section without MPI
+Type your compiler option in number in the command line. A new configuration file user_build_options will appear in the directory. Go into the file and edit the correct path to necessary libraries.
 
-type 'make'
+After editing the user_build_options file, we can now compile the model with a simple command:
+
+`make`
 
 If successful, there should be two executables created
 
 HRLDAS_forcing/create_forcing.exe
 
-and 
+and
 
 run/hrldas.exe
 
 --------------------------------------------------
 
 3. Prepare NLDAS-based forcing data.
 
-This step can be quite involved for a first-time user. It involves converting NLDAS output in GRIB format to NetCDF forcing files in HRLDAS format. This will be done in the /root_path/HRLDAS-v3.x/HRLDAS_forcing/ directory. In that directory you will find another directory named examples/ that contains some useful scripts for doing the NLDAS steps below.
+This step can be quite involved for a first-time user. It involves converting NLDAS output in GRIB format to NetCDF forcing files in HRLDAS format. This will be done in the /root_path/hrldas/HRLDAS_forcing/ directory. In that directory you will find another directory named examples/ that contains some useful scripts for doing the NLDAS steps below.
 
 Required programs and libraries:
 
@@ -103,7 +101,7 @@ If you are space-limited, at this point you can remove the raw NLDAS files. You
 
 At this point, you should have all the NARR output extracted into different directories at /extracted_NARR_data_path/. Now it's finally time to run the first step of the HRLDAS.
 
-cd /root_path/HRLDAS-v3.x/HRLDAS_COLLECT_DATA/run
+cd /root_path/hrldas/HRLDAS_COLLECT_DATA/run
 
 In the examples/NARR/ directory there is a namelist.input file that is consistent with the NARR procedure described above. You can modify this file for your case and place it in the pre-processor run directory:
 
@@ -164,7 +162,7 @@ In your OUTPUTDIR, you should now have all your LDASIN files.
 
 The hard part is over. Go to the HRLDAS Run directory:
 
-cd /root_path/HRLDAS-v3.x/run
+cd /root_path/hrldas/run
 
 4.1 Modify the namelist
 

hrldas/docs/README.single_point

@@ -3,31 +3,32 @@ Steps for running a HRLDAS simulation using the example single-point Bondville f
 
 The file ../HRLDAS_forcing/run/examples/single_point/bondville.dat can be modified for you location. If the format of the data in the file is changed, modification of the source code (create_point_data.f90) may be required.
 
-1. Download HRLDAS and configure
 
-git clone https://github.com/NCAR/hrldas-release.git
+1 & 2. Download and Compile HRLDAS
 
-In the following, hrldas_root = /root_path/hrldas-release/HRLDAS
+2.1 Download the model code where you will be running the model:
 
-In hrldas_root, run configure to get a sample user_build_options for your system.
+`git clone --recurse-submodules https://github.com/NCAR/hrldas`
 
-For this single point example, use a serial compile option.
+2.2 Configure and Compile:
 
-Modify library paths and any other compiler flags necessary for your system.
+`cd ./hrldas/hrldas`
 
---------------------------------------------------
+`./configure`
 
-2. Compile HRLDAS
+Type your compiler option in number in the command line. A new configuration file user_build_options will appear in the directory. Go into the file and edit the correct path to necessary libraries.
 
-type 'make'
+After editing the user_build_options file, we can now compile the model with a simple command:
+
+`make`
 
 If successful, there should be two executables created
 
-/hrldas_root/HRLDAS_forcing/create_forcing.exe  (you won't need this for point-based forcing)
+HRLDAS_forcing/create_forcing.exe
 
-and 
+and
 
-/hrldas_root/run/hrldas.exe
+run/hrldas.exe
 
 --------------------------------------------------
 

hrldas/docs/README.vector

@@ -2,31 +2,29 @@
 Steps for running a HRLDAS simulation using user-provided single- or multiple-point forcing.
 
 
-1. Compile HRLDAS
+1 & 2. Download and Compile HRLDAS
 
-Place the HRLDAS tar file where you will be running the model. 
+2.1 Download the model code where you will be running the model:
 
-tar xvf HRLDAS-v3.x.tar
+`git clone --recurse-submodules https://github.com/NCAR/hrldas`
 
-I will refer to this location as /root_path/HRLDAS-v3.x
+2.2 Configure and Compile:
 
-In /root_path/HRLDAS-v3.x, modify user_build_options to link to the proper compilers and paths.
+`cd ./hrldas/hrldas`
 
- To compile with parallel version
-  edit the file 'user_build_options'
-  uncommment the compiler section with MPI (available for pgf90 and ifort compilers)
+`./configure`
 
- To compile with sequential version
-  edit the file 'user_build_options'
-  uncommment the compiler section without MPI
+Type your compiler option in number in the command line. A new configuration file user_build_options will appear in the directory. Go into the file and edit the correct path to necessary libraries.
 
-type 'make'
+After editing the user_build_options file, we can now compile the model with a simple command:
+
+`make`
 
 If successful, there should be two executables created
 
-HRLDAS_forcing/create_forcing.exe  (you won't need this for point-based forcing)
+HRLDAS_forcing/create_forcing.exe
 
-and 
+and
 
 run/hrldas.exe
 

hrldas/run/Makefile

@@ -93,6 +93,7 @@ OBJS = \
         ../../noahmp/src/SnowLayerDivideMod.o \
         ../../noahmp/src/SnowLayerWaterComboMod.o \
         ../../noahmp/src/SnowpackCompactionMod.o \
+        ../../noahmp/src/SnowpackCompactionAR24Mod.o \
         ../../noahmp/src/SnowpackHydrologyMod.o \
         ../../noahmp/src/SnowWaterMainMod.o \
         ../../noahmp/src/SoilHydraulicPropertyMod.o \

hrldas/run/README.namelist

@@ -188,6 +188,10 @@
                                                              !   1 -> BATS
 		                                             ! **2 -> CLASS
 
+ SNOW_COMPACTION_OPTION            = 2                       ! options for ground snowpack compaction [default = 2]
+                                                             !   1 -> original scheme from Anderson 1976
+                                                             !   2 -> updated scheme from Abolafia-Rosenzweigh et al. (2024)
+
  SNOW_THERMAL_CONDUCTIVITY         = 1                       ! options for snow thermal conductivity   [default = 1]
                                                              ! **1 -> Stieglitz (Yen,1965) scheme
                                                              !   2 -> Anderson (1976) scheme

hrldas/run/examples/ERA5/namelist.hrldas.ERA5

@@ -35,6 +35,7 @@
  SUPERCOOLED_WATER_OPTION          = 1
  RADIATIVE_TRANSFER_OPTION         = 3
  SNOW_ALBEDO_OPTION                = 2
+ SNOW_COMPACTION_OPTION            = 2
  PCP_PARTITION_OPTION              = 1
  SNOW_THERMAL_CONDUCTIVITY         = 1
  TBOT_OPTION                       = 2
@@ -49,7 +50,7 @@
  TILE_DRAINAGE_OPTION              = 0
 
  FORCING_TIMESTEP = 3600
- NOAH_TIMESTEP    = 3600
+ NOAH_TIMESTEP    = 1800
  OUTPUT_TIMESTEP  = 3600
 
  SPLIT_OUTPUT_COUNT = 1

hrldas/run/examples/GLDAS/namelist.hrldas.GLDAS

@@ -35,6 +35,7 @@
  SUPERCOOLED_WATER_OPTION          = 1
  RADIATIVE_TRANSFER_OPTION         = 3
  SNOW_ALBEDO_OPTION                = 2
+ SNOW_COMPACTION_OPTION            = 2
  PCP_PARTITION_OPTION              = 1
  SNOW_THERMAL_CONDUCTIVITY         = 1
  TBOT_OPTION                       = 2

hrldas/run/examples/NARR/namelist.hrldas.NARR

@@ -35,6 +35,7 @@
  SUPERCOOLED_WATER_OPTION          = 1
  RADIATIVE_TRANSFER_OPTION         = 3
  SNOW_ALBEDO_OPTION                = 2
+ SNOW_COMPACTION_OPTION            = 2
  PCP_PARTITION_OPTION              = 1
  SNOW_THERMAL_CONDUCTIVITY         = 1
  TBOT_OPTION                       = 2