Feature/AquaCropv7.2 integration

ldt/configs/ldt.config.adoc

@@ -100,6 +100,7 @@ Surface model types:  "LSM"
 |RDHM.3.5.6 |Sacramento+snow17
 |GeoWRSI.2 |GeoWRSI, v2.0
 |SiB2 |SiB v2
+|AquaCrop.7.2 |AquaCrop 7.2
 ifdef::devonly[]
 |FASST |FASST
 |CABLE |CABLE
@@ -2987,6 +2988,49 @@ SiB2 resolution (dx):               0.05
 SiB2 resolution (dy):               0.05
 ....
 
+`AquaCrop crop type data source:` specifies the data source for the crop types. Only current option is "`CONSTANT`".
+
+`AquaCrop crop library directory:` specifies the location of the crop library directory containing the AC_Crop.Inventory file and the AC_Crop.List directory containing the crop files.
+
+`AquaCrop crop type:` specifies the crop type used for the "`CONSTANT`" crop type data source option.
+
+`AquaCrop number of soil layers:` specifies the number of soil layers (from top to bottom).
+
+`AquaCrop soil layer thickness:` specifies the thickness of each soil layer.
+
+`AquaCrop temperature climatology directory:` specifies the directory containing the monthly climatologies of minimum and maximum temperatures used for the a priori parametrization of the fertility. The files are provided as formatted monthly .txt files for Tmin and Tmax.
+
+`AquaCrop reference year for climatology`: specifies the reference year to be used for the a priori parametrization of the fertility (usually set to the center of the period used to compute the climatologies).
+
+`AquaCrop temperature climatology spatial transform`: specifies the spatial transformation for the climatologies of minimum and maximum temperatures. Options include:
+
+[cols="<,<",]
+|===
+|Value |Description
+
+|none |Data on same grid as LDT domain
+|neighbor |Reinterpolate by selecting nearest gridcell neighbor
+|bilinear |Reinterpolate by using bilinear interpolation
+|===
+
+.Example _ldt.config_ entry
+....
+##AquaCrop crop file directories
+AquaCrop crop type data source: "CONSTANT"
+AquaCrop crop library directory: ./crop_params_dir/
+AquaCrop crop type: "crop_type"
+
+##AquaCrop soil layers
+AquaCrop number of soil layers: 2
+AquaCrop soil layer thickness: 0.3 0.9
+
+##AquaCrop tmin/tmax climatology
+AquaCrop temperature climatology directory: ./climatologies_dir/
+AquaCrop reference year for climatology: 2011
+AquaCrop temperature climatology spatial transform: "bilinear"
+....
+
+
 ==== WRSI model parameter files
 
 `WRSI landmask file:` specifies the location of the GeoWRSI 2.0 land mask file (default file is in *BIL format).

ldt/make/Filepath

@@ -1 +1 @@
-dirs := .  ../main ../core ../interp ../plugins ../lib/bil ../lib/xmrg ../params/mask ../params/landcover ../params/soils ../params/topo ../params/albedo ../params/gfrac ../params/LAISAI ../params/slopetype ../params/tbot ../params/pet ../params/climateparms ../params/crop_parms ../params/irrigation ../params/catchment ../params/CLM2 ../params/GeoWRSI ../params/FLAKE ../params/HYMAP ../params/JULES ../params/Mosaic ../params/Noah ../params/RDHM ../params/RUC ../params/SACHTET ../params/Snow17 ../params/SnowModel ../params/SiB2 ../params/VIC ../params/glacier ../runmodes/ANNproc ../runmodes/DApreproc ../runmodes/LSMparamproc ../runmodes/EnsRstpreproc ../runmodes/NUWRFpreproc ../runmodes/Metforcproc ../runmodes/MetTimeDScale ../runmodes/climoRstproc ../runmodes/rstTransformProc ../runmodes/StatDscaleMetForc ../runmodes/OPTUEproc/ ../domains/latlon ../domains/gaussian ../domains/hrap ../domains/lambert ../domains/polar ../domains/merc ../domains/easev2 ../DAobs/MCD15A2H_LAI ../DAobs/LISlsmSMobs ../DAobs/LISlsmPrecipobs ../DAobs/LISlsmTEFFobs ../DAobs/synthetic_sm ../DAobs/NASA_AMSRE_sm ../DAobs/LPRM_AMSREsm ../DAobs/LPRMvod ../DAobs/ESACCI_sm ../DAobs/WindSat_sm ../DAobs/GRACE_tws ../DAobs/GRACEQL_tws ../DAobs/SMOPS ../DAobs/ASCAT_TUW ../DAobs/SMOS_L2sm ../DAobs/SMOS_NESDIS ../DAobs/GCOMW_AMSR2L3snd ../DAobs/GCOMW_AMSR2L3sm ../DAobs/Aquarius_L2sm ../DAobs/simGRACE_JPL ../DAobs/SMMR_SNWD ../DAobs/SSMI_SNWD ../DAobs/ANSA_SNWD ../DAobs/NASA_SMAPsm ../DAobs/SMOS_NRTNN_L2sm ../DAobs/NASA_SMAPvod ../DAobs/GLASSlai ../DAobs/THySM ../DAobs/GEOS_FP_TEFFobs ../DAobs/SMAP_E_OPLsm ../DAobs/VIIRS_GVF ../DAobs/CDFS_GVF ../RESTRICTED/usaf/usaf ../metforcing/agrradps ../metforcing/cmap ../metforcing/cmorph ../metforcing/ecmwf ../metforcing/gdas ../metforcing/geos5fcst ../metforcing/gfs ../metforcing/gldas ../metforcing/gswp1 ../metforcing/gswp2 ../metforcing/merra2 ../metforcing/era5 ../metforcing/nam242 ../metforcing/narr ../metforcing/princeton ../metforcing/nldas2 ../metforcing/WRFoutv2 ../metforcing/WRFAKdom ../metforcing/stg2 ../metforcing/stg4 ../metforcing/3B42RTV7 ../metforcing/3B42V6 ../metforcing/3B42V7 ../metforcing/RFE2Daily ../metforcing/RFE2gdas ../metforcing/chirps2 ../MetforcScale ../ANNdata/LISlsmSM ../ANNdata/synthetic_sm ../ANNdata/LPRM_AMSREsm ../ANNdata/MODIS_LST ../ANNdata/MOD10A1 ../ANNdata/GHCNsnwd ../ANNdata/GCOMW_AMSR2_TB ../statDscale/BayesianMerging ../statDscale/Climo ../params/CLM45 ../USAFSI ../SMAP_E_OPL ../runmodes/USAFSI ../runmodes/LISHydropreproc ../runmodes/SMAP_E_OPL ../params/Crocus ../runmodes/obsSim ../obsSim/NatureRun/LISout/ ../obsSim/OSSEmask/LISout/ ../obsSim/OSSEmask/AMSR2/ ../obsSim/OSSEmask/TSMM/ ../obsSim/OSSEmask/MODIS/ ../obsSim/OSSEmask/Sentinel1A/
+dirs := .  ../main ../core ../interp ../plugins ../lib/bil ../lib/xmrg ../params/mask ../params/landcover ../params/soils ../params/topo ../params/albedo ../params/gfrac ../params/LAISAI ../params/slopetype ../params/tbot ../params/pet ../params/climateparms ../params/crop_parms ../params/irrigation ../params/catchment ../params/CLM2 ../params/GeoWRSI ../params/FLAKE ../params/HYMAP ../params/JULES ../params/Mosaic ../params/Noah ../params/AquaCrop ../params/RDHM ../params/RUC ../params/SACHTET ../params/Snow17 ../params/SnowModel ../params/SiB2 ../params/VIC ../params/glacier ../runmodes/ANNproc ../runmodes/DApreproc ../runmodes/LSMparamproc ../runmodes/EnsRstpreproc ../runmodes/NUWRFpreproc ../runmodes/Metforcproc ../runmodes/MetTimeDScale ../runmodes/climoRstproc ../runmodes/rstTransformProc ../runmodes/StatDscaleMetForc ../runmodes/OPTUEproc/ ../domains/latlon ../domains/gaussian ../domains/hrap ../domains/lambert ../domains/polar ../domains/merc ../domains/easev2 ../DAobs/MCD15A2H_LAI ../DAobs/LISlsmSMobs ../DAobs/LISlsmPrecipobs ../DAobs/LISlsmTEFFobs ../DAobs/synthetic_sm ../DAobs/NASA_AMSRE_sm ../DAobs/LPRM_AMSREsm ../DAobs/LPRMvod ../DAobs/ESACCI_sm ../DAobs/WindSat_sm ../DAobs/GRACE_tws ../DAobs/GRACEQL_tws ../DAobs/SMOPS ../DAobs/ASCAT_TUW ../DAobs/SMOS_L2sm ../DAobs/SMOS_NESDIS ../DAobs/GCOMW_AMSR2L3snd ../DAobs/GCOMW_AMSR2L3sm ../DAobs/Aquarius_L2sm ../DAobs/simGRACE_JPL ../DAobs/SMMR_SNWD ../DAobs/SSMI_SNWD ../DAobs/ANSA_SNWD ../DAobs/NASA_SMAPsm ../DAobs/SMOS_NRTNN_L2sm ../DAobs/NASA_SMAPvod ../DAobs/GLASSlai ../DAobs/THySM ../DAobs/GEOS_FP_TEFFobs ../DAobs/SMAP_E_OPLsm ../DAobs/VIIRS_GVF ../DAobs/CDFS_GVF ../RESTRICTED/usaf/usaf ../metforcing/agrradps ../metforcing/cmap ../metforcing/cmorph ../metforcing/ecmwf ../metforcing/gdas ../metforcing/geos5fcst ../metforcing/gfs ../metforcing/gldas ../metforcing/gswp1 ../metforcing/gswp2 ../metforcing/merra2 ../metforcing/era5 ../metforcing/nam242 ../metforcing/narr ../metforcing/princeton ../metforcing/nldas2 ../metforcing/WRFoutv2 ../metforcing/WRFAKdom ../metforcing/stg2 ../metforcing/stg4 ../metforcing/3B42RTV7 ../metforcing/3B42V6 ../metforcing/3B42V7 ../metforcing/RFE2Daily ../metforcing/RFE2gdas ../metforcing/chirps2 ../MetforcScale ../ANNdata/LISlsmSM ../ANNdata/synthetic_sm ../ANNdata/LPRM_AMSREsm ../ANNdata/MODIS_LST ../ANNdata/MOD10A1 ../ANNdata/GHCNsnwd ../ANNdata/GCOMW_AMSR2_TB ../statDscale/BayesianMerging ../statDscale/Climo ../params/CLM45 ../USAFSI ../SMAP_E_OPL ../runmodes/USAFSI ../runmodes/LISHydropreproc ../runmodes/SMAP_E_OPL ../params/Crocus ../runmodes/obsSim ../obsSim/NatureRun/LISout/ ../obsSim/OSSEmask/LISout/ ../obsSim/OSSEmask/AMSR2/ ../obsSim/OSSEmask/TSMM/ ../obsSim/OSSEmask/MODIS/ ../obsSim/OSSEmask/Sentinel1A/

ldt/params/AquaCrop/AquaCrop_parmsMod.F90

@@ -0,0 +1,295 @@
+!-----------------------BEGIN NOTICE -- DO NOT EDIT-----------------------
+! NASA Goddard Space Flight Center
+! Land Information System Framework (LISF)
+! Version 7.5
+!
+! Copyright (c) 2024 United States Government as represented by the
+! Administrator of the National Aeronautics and Space Administration.
+! All Rights Reserved.
+!-------------------------END NOTICE -- DO NOT EDIT-----------------------
+module AquaCrop_parmsMod
+!BOP
+!
+! !MODULE: AquaCrop_parmsMod
+!
+! !DESCRIPTION:
+!  \subsubsection{Overview}
+!  This routines in this module provides routines to read the AquaCrop
+!  crop type from the AC_Crop.Inventory
+!
+! !REVISION HISTORY:
+!
+!  10 May 2024; Michel Becthold, Louise Busschaert, initial implementation
+!
+#if(defined USE_NETCDF3 || defined USE_NETCDF4)
+  use netcdf
+#endif
+  use ESMF
+  use LDT_coreMod
+  use LDT_historyMod
+  use LDT_paramDataMod
+  use LDT_logMod
+  use LDT_paramMaskCheckMod
+  use LDT_constantsMod, only : LDT_CONST_PATH_LEN
+
+  implicit none
+
+  PRIVATE
+!------------------------------------------------------------------------------
+! !PUBLIC MEMBER FUNCTIONS:
+!------------------------------------------------------------------------------
+  public :: AquaCropParms_init    !allocates memory for required structures
+  public :: AquaCropParms_writeHeader
+  public :: AquaCropParms_writeData
+
+!------------------------------------------------------------------------------
+! !PUBLIC TYPES:
+!------------------------------------------------------------------------------
+  public :: AquaCrop_struc
+
+  type, public :: aquacrop_type_dec
+      ! -  AquaCrop LSM-specific:
+      type(LDT_paramEntry) :: cropt   ! crop type
+      type(LDT_paramEntry) :: comp_size ! compartment size
+      type(LDT_paramEntry) :: tmin_cli ! tmin climatology
+      type(LDT_paramEntry) :: tmax_cli ! tmax climatology
+      integer :: nlayers !  number of soil layers
+      real :: lthickness(5) ! thickness of layers, max 5 layers for AC
+      integer :: max_comp ! fixed to 12
+      integer :: tempcli_refyr ! reference year for cli
+      character(len=LDT_CONST_PATH_LEN) :: tempclimdir
+      character(125) :: tempclimfile
+      character(125) :: tempclim_gridtransform
+  end type aquacrop_type_dec
+
+  type(aquacrop_type_dec), allocatable :: AquaCrop_struc(:)
+
+
+
+contains
+
+  subroutine AquaCropParms_init(flag)
+! !USES:
+    use LDT_fileIOMod, only : LDT_readDomainConfigSpecs
+    use LDT_logMod,    only : LDT_verify
+!
+! !DESCRIPTION:
+!
+! Allocates memory for data structures for reading 
+! the required AquaCrop datasets 
+! 
+!  The routines invoked are: 
+!  \begin{description}
+!   \item[read_CONSTANT_AC_crop]\newline
+!    calls the reader of the crop type via the Crop.Inventory
+!    (for now: only CONSTANT method is implemented) 
+!   \item[define_AC_compartments]\newline
+!    calls the calculation fo the compartment number/size
+!   \item[read_AC_Tclim]\newline
+!    calls the reader of the Tmin and Tmax climatologies
+!  \end{description}
+!
+!EOP
+   implicit none
+   integer  :: flag
+   integer  :: n,i,c,r,m,k
+   integer  :: rc
+
+    character*3 :: months(12)
+    data months /'jan','feb','mar','apr','may','jun','jul','aug',&
+                 'sep','oct','nov','dec'/
+
+! _____________________________________________________________________
+
+  allocate(AquaCrop_struc(LDT_rc%nnest))
+  do n=1,LDT_rc%nnest
+    AquaCrop_struc(n)%max_comp = 12
+    ! Set crop type
+    call set_param_attribs(Aquacrop_struc(n)%cropt, "AC_CROPT",&
+        units="-", &
+        full_name="Aquacrop crop type")
+    call ESMF_ConfigFindLabel(LDT_config,"AquaCrop crop type data source:",rc=rc)
+    call ESMF_ConfigGetAttribute(LDT_config,AquaCrop_struc(n)%cropt%source,rc=rc)
+    call LDT_verify(rc,"AquaCrop crop type data source: not defined")
+    allocate(Aquacrop_struc(n)%cropt%value(&
+            LDT_rc%lnc(n),LDT_rc%lnr(n),&
+            Aquacrop_struc(n)%cropt%vlevels))
+    select case (AquaCrop_struc(n)%cropt%source)
+      case( "CONSTANT" )
+        call read_CONSTANT_AC_crop(&
+                  n,AquaCrop_struc(n)%cropt%value(:,:,1))
+      case default
+        write(LDT_logunit,*) "[WARN] crop type data source not valid for AquaCrop."
+        write(LDT_logunit,*) "  Please select: CONSTANT"
+        write(LDT_logunit,*) "Program stopping ..."
+        call LDT_endrun
+    end select
+  ! End crop type
+
+  ! Define compartment size
+    call set_param_attribs(Aquacrop_struc(n)%comp_size, "AC_comp_size",&
+        units="m", &
+        full_name="Aquacrop compartment size")
+    Aquacrop_struc(n)%comp_size%vlevels = AquaCrop_struc(n)%max_comp
+    Aquacrop_struc(n)%comp_size%num_bins = AquaCrop_struc(n)%max_comp
+    allocate(Aquacrop_struc(n)%comp_size%value(&
+            LDT_rc%lnc(n),LDT_rc%lnr(n),&
+            Aquacrop_struc(n)%comp_size%vlevels))
+    call define_AC_compartments(n, AquaCrop_struc(n)%comp_size%value(:,:,:))
+
+
+    !! Read temperature climatology file
+    ! Read options from ldt.config
+    call ESMF_ConfigFindLabel(LDT_config,"AquaCrop temperature climatology directory:",rc=rc)
+    call ESMF_ConfigGetAttribute(LDT_config,AquaCrop_struc(n)%tempclimdir,rc=rc)
+    call LDT_verify(rc,"AquaCrop temperature climatology directory: not defined")
+
+    call ESMF_ConfigFindLabel(LDT_config,"AquaCrop reference year for climatology:",rc=rc)
+    call ESMF_ConfigGetAttribute(LDT_config,AquaCrop_struc(n)%tempcli_refyr,rc=rc)
+    call LDT_verify(rc,"AquaCrop reference year for climatology: not defined")
+
+    call ESMF_ConfigFindLabel(LDT_config,"AquaCrop temperature climatology spatial transform:",rc=rc)
+    call ESMF_ConfigGetAttribute(LDT_config,AquaCrop_struc(n)%tempclim_gridtransform,rc=rc)
+    call LDT_verify(rc,"AquaCrop temperature climatology spatial transform: not defined")
+
+    LDT_rc%monthlyData(n) = .true.
+
+    ! tmin
+    call set_param_attribs(Aquacrop_struc(n)%tmin_cli, "AC_Tmin_clim",&
+      units="K", &
+    full_name="minimum temperature climatology")
+    Aquacrop_struc(n)%tmin_cli%vlevels = 12
+    Aquacrop_struc(n)%tmin_cli%num_bins = 12
+    allocate(Aquacrop_struc(n)%tmin_cli%value(&
+            LDT_rc%lnc(n),LDT_rc%lnr(n),&
+            Aquacrop_struc(n)%tmin_cli%vlevels))
+
+    ! tmax
+    call set_param_attribs(Aquacrop_struc(n)%tmax_cli, "AC_Tmax_clim",&
+      units="K", &
+      full_name="maximum temperature climatology")
+    Aquacrop_struc(n)%tmax_cli%vlevels = 12
+    Aquacrop_struc(n)%tmax_cli%num_bins = 12
+    allocate(Aquacrop_struc(n)%tmax_cli%value(&
+            LDT_rc%lnc(n),LDT_rc%lnr(n),&
+            Aquacrop_struc(n)%tmax_cli%vlevels))
+
+    ! Call function to read monthly data
+    do k = 1,12
+      AquaCrop_struc(n)%tempclimfile = &
+          trim(AquaCrop_struc(n)%tempclimdir)//'tmin.'//&
+          trim(months(k))//'.txt'
+      call read_AC_Tclim(n, AquaCrop_struc(n)%tmin_cli%value(:,:,k))
+      AquaCrop_struc(n)%tempclimfile = &
+          trim(AquaCrop_struc(n)%tempclimdir)//'tmax.'//&
+          trim(months(k))//'.txt'
+      call read_AC_Tclim(n, AquaCrop_struc(n)%tmax_cli%value(:,:,k))
+    enddo ! end months
+
+  enddo ! End nest
+
+  end subroutine AquaCropParms_init
+
+ subroutine AquaCropParms_writeHeader(n,ftn,dimID,monthID)
+
+    use netcdf
+
+    integer   :: n,i 
+    integer   :: ftn
+    integer   :: dimID(3)
+    integer   :: monthID
+
+    integer   :: ndimID(3)  ! 3D, vlevel>1
+    character(25) :: str
+
+    ndimID(1) = dimID(1)
+    ndimID(2) = dimID(2)
+
+    call LDT_writeNETCDFdataHeader(n,ftn,dimID,&
+            Aquacrop_struc(n)%cropt)
+    call LDT_verify(nf90_def_dim(ftn,'compartment',&
+          AquaCrop_struc(n)%max_comp,ndimID(3)))
+    ndimID(1) = dimID(1)
+    ndimID(2) = dimID(2)
+    call LDT_writeNETCDFdataHeader(n,ftn,ndimID,&
+            Aquacrop_struc(n)%comp_size)
+
+    ndimID(3) = monthID
+    call LDT_writeNETCDFdataHeader(n,ftn,ndimID,&
+            Aquacrop_struc(n)%tmin_cli)
+    call LDT_writeNETCDFdataHeader(n,ftn,ndimID,&
+            Aquacrop_struc(n)%tmax_cli)
+
+    ! Add number of soil layers
+    call LDT_verify(nf90_put_att(ftn,NF90_GLOBAL,"SOIL_LAYERS", &
+        AquaCrop_struc(n)%nlayers))
+    ! Add thickness of soil layers
+    do i=1,AquaCrop_struc(n)%nlayers
+      write (str, '(i0)') i
+      call LDT_verify(nf90_put_att(ftn,NF90_GLOBAL,"THICKNESS_LAYER_"//trim(str),&
+                      AquaCrop_struc(n)%lthickness(i)))
+    ! Add Reference year for temperature climatology
+    call LDT_verify(nf90_put_att(ftn,NF90_GLOBAL,"AC_CLIM_REF_YEAR", &
+        AquaCrop_struc(n)%tempcli_refyr))
+    enddo
+
+  end subroutine AquaCropParms_writeHeader
+
+  subroutine AquaCropParms_writeData(n,ftn)
+
+    integer   :: n 
+    integer   :: ftn
+
+    call LDT_writeNETCDFdata(n,ftn,AquaCrop_struc(n)%cropt)
+    call LDT_writeNETCDFdata(n,ftn,AquaCrop_struc(n)%comp_size)
+    call LDT_writeNETCDFdata(n,ftn,AquaCrop_struc(n)%tmin_cli)
+    call LDT_writeNETCDFdata(n,ftn,AquaCrop_struc(n)%tmax_cli)
+
+  end subroutine AquaCropParms_writeData
+
+
+!BOP
+! !ROUTINE:  set_param_attribs
+! \label{set_param_attribs}
+!
+! !INTERFACE:
+  subroutine set_param_attribs(paramEntry, short_name, &
+                               units, full_name )
+
+! !DESCRIPTION:
+!   This routine reads over the parameter attribute entries
+!   in the param_attribs.txt file.
+!
+! !USES:
+   type(LDT_paramEntry),intent(inout) :: paramEntry
+   character(len=*),    intent(in)    :: short_name
+   character(len=*),     optional     :: units
+   character(len=*),     optional     :: full_name
+
+   character(20) :: unit_temp
+   character(100):: name_temp
+! ____________________________________________________
+
+   if(present(units)) then
+      unit_temp = units
+   else
+      unit_temp = "none"
+   endif
+   if(present(full_name)) then
+      name_temp = full_name
+   else
+      name_temp = trim(short_name)
+   endif
+
+   paramEntry%short_name = trim(short_name)
+   paramEntry%vlevels = 1
+   paramEntry%selectOpt = 1
+   paramEntry%source = "AquaCrop"
+   paramEntry%units = unit_temp
+   paramEntry%num_times = 1
+   paramEntry%num_bins = 1
+   paramEntry%standard_name = trim(name_temp)
+
+  end subroutine set_param_attribs
+
+end module AquaCrop_parmsMod