Merge branch 'release/8.7.0'

Author: oehmke

README.md

@@ -34,7 +34,7 @@ Pre-built binaries for ESMF and ESMPy are available through a number of channels
    ```
    docker run -it --rm esmf/esmf-build-release:latest
    ```
-   Replace `latest` in the above command with a valid version, like `8.6.0`, in order to access a specific ESMF version.
+   Replace `latest` in the above command with a valid version, like `8.7.0`, in order to access a specific ESMF version.
 
  * [Anaconda Conda-Forge](https://anaconda.org/conda-forge/): Under [conda-forge/esmpy](https://anaconda.org/conda-forge/esmpy). To install locally (_note Windows is not supported_), run:
    ```

src/Infrastructure/FieldBundle/src/ESMF_FieldBundle.cppF90

@@ -2183,7 +2183,7 @@ msg="This call does not work with packed FieldBundle.",&
 !------------------------------------------------------------------------------
 ^undef  ESMF_METHOD
 ^define ESMF_METHOD "ESMF_FieldBundleGetIndex()"
-!BOP
+!BOPI
 ! !IROUTINE: ESMF_FieldBundleGet - Access the Field at a specific index in a FieldBundle
 !
 ! !INTERFACE:
@@ -2214,7 +2214,7 @@ type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below
 !         Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
 !   \end{description}
 !
-!EOP
+!EOPI
 !------------------------------------------------------------------------------
     integer                       :: localrc      ! local return code
     integer                       :: l_fieldCount, i         ! helper variable

src/Infrastructure/TimeMgr/interface/ESMF_Clock.F90

@@ -447,6 +447,13 @@ function ESMF_ClockCreateNew(timeStep, startTime, keywordEnforcer, &
 ! !STATUS:
 ! \begin{itemize}
 ! \item\apiStatusCompatibleVersion{5.2.0r}
+! \item\apiStatusModifiedSinceVersion{5.2.0r}
+! \begin{description}
+! \item[8.7.0] Added argument {\tt repeatDuration}.
+!              The new argument allows the user to specify that they want the
+!              clock to be a repeat clock and repeatedly go through the same
+!              interval of time.
+! \end{description}
 ! \end{itemize}
 !
 ! !DESCRIPTION:
@@ -718,6 +725,13 @@ subroutine ESMF_ClockGet(clock, keywordEnforcer, &
 ! !STATUS:
 ! \begin{itemize}
 ! \item\apiStatusCompatibleVersion{5.2.0r}
+! \item\apiStatusModifiedSinceVersion{5.2.0r}
+! \begin{description}
+! \item[8.7.0] Added arguments {\tt repeatDuration} and {\tt repeatCount}.
+!              The argument {\tt repeatDuration} allows the user to get information
+!              about how far the clock will advance before repeating. The argument
+!              {\tt repeatCount} tells how many times the clock has repeated.
+! \end{description}
 ! \end{itemize}
 !
 ! !DESCRIPTION:
@@ -773,9 +787,11 @@ subroutine ESMF_ClockGet(clock, keywordEnforcer, &
 !          {\tt ESMF\_ClockIsReverse()}, an alternative for convenient use in
 !          "if" and "do while" constructs.
 !     \item[{[repeatDuration]}]
-!          If not 0, then how long the clock should run before going back to startTime.
+!          If not 0, then tells how long the clock will advance before going back to
+!          startTime. If 0, then the clock is not a repeat clock. 
 !     \item[{[repeatCount]}]
-!          The number of times this clock has gone back to startTime when repeating.       
+!          If this clock is a repeat clock, then gives the number of times this
+!          clock has gone back to startTime.     
 !     \item[{[name]}]
 !          The name of this clock.
 !     \item[{[rc]}]

src/Infrastructure/TimeMgr/interface/ESMF_TimeInterval.F90

@@ -3135,7 +3135,7 @@ end subroutine ESMF_ParseDurString
 #undef  ESMF_METHOD
 #define ESMF_METHOD "ESMF_TimeIntervalSetStr()"
 !BOP
-! !IROUTINE: ESMF_TimeIntervalSet - Initialize or set a TimeInterval from an ISO format string
+! !IROUTINE: ESMF_TimeIntervalSet - Initialize or set a TimeInterval from an ISO 8601 format string
 ! \label{API:TimeIntervalSetStr}
 
 ! !INTERFACE:
@@ -3151,8 +3151,8 @@ subroutine ESMF_TimeIntervalSetStr(timeinterval, timeIntervalString, rc)
 !
 !
 ! !DESCRIPTION:
-!     Sets the value of the {\tt ESMF\_TimeInterval} using a user specified
-!     string in ISO duration format P[y]Y[mm]M[d]DT[h]H[m]M[s]S. See ~\cite{ISO} and ~\cite{ISOnotes} for information about the format. In ESMF's implementation the time values can have the following types: 
+!     Sets the value of an {\tt ESMF\_TimeInterval} using a
+!     string in ISO 8601 duration format P[y]Y[mm]M[d]DT[h]H[m]M[s]S. See ~\cite{ISO} and ~\cite{ISOnotes} for information about the format. In ESMF's implementation the time values can have the following types: 
 !     \begin{description}
 !      \item[y] - the number of years expressed in up to a 64-bit integer
 !      \item[mm] - the number of months expressed in up to a 64-bit integer
@@ -3170,7 +3170,7 @@ subroutine ESMF_TimeIntervalSetStr(timeinterval, timeIntervalString, rc)
 !     \item[timeinterval]
 !          The object instance to initialize.
 !     \item[timeIntervalString]
-!          ISO format duration string (e.g. P[y]Y[mm]M[d]DT[h]H[m]M[s]S).
+!          ISO 8601 format duration string (e.g. P[y]Y[mm]M[d]DT[h]H[m]M[s]S).
 !     \item[{[rc]}]
 !          Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
 !     \end{description}
@@ -3229,7 +3229,7 @@ end subroutine ESMF_TimeIntervalSetStr
 #undef  ESMF_METHOD
 #define ESMF_METHOD "ESMF_TimeIntervalSetStrCal()"
 !BOP
-! !IROUTINE: ESMF_TimeIntervalSet - Initialize or set a TimeInterval from an ISO format string and calendar
+! !IROUTINE: ESMF_TimeIntervalSet - Initialize or set a TimeInterval from an ISO 8601 format string and calendar
 
 ! !INTERFACE:
       ! Private name; call using ESMF_TimeIntervalSet()
@@ -3245,8 +3245,8 @@ subroutine ESMF_TimeIntervalSetStrCal(timeinterval, calendar, &
 !
 !
 ! !DESCRIPTION:
-!  Sets the value of the {\tt ESMF\_TimeInterval} using a user specified
-!  string in ISO duration format P[y]Y[mm]M[d]DT[h]H[m]M[s]S. See ~\cite{ISO} and ~\cite{ISOnotes} for
+!  Sets the value of an {\tt ESMF\_TimeInterval} using a
+!  string in ISO 8601 duration format P[y]Y[mm]M[d]DT[h]H[m]M[s]S. See ~\cite{ISO} and ~\cite{ISOnotes} for
 !  information about the format. Also, see the description for the method
 ! {\tt ESMF\_TimeIntervalSetStr()}~\ref{API:TimeIntervalSetStr}
 ! for the specific types supported by ESMF for the values in the duration string. 
@@ -3265,7 +3265,7 @@ subroutine ESMF_TimeIntervalSetStrCal(timeinterval, calendar, &
 !          it contains a calendar.  Alternate to, and mutually exclusive with, 
 !          calkindflag below.  Primarily for specifying a custom calendar kind.
 !     \item[timeIntervalString]
-!          ISO format duration string (e.g. P[y]Y[mm]M[d]DT[h]H[m]M[s]S).
+!          ISO 8601 format duration string (e.g. P[y]Y[mm]M[d]DT[h]H[m]M[s]S).
 !     \item[{[rc]}]
 !          Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
 !     \end{description}
@@ -3325,7 +3325,7 @@ end subroutine ESMF_TimeIntervalSetStrCal
 #undef  ESMF_METHOD
 #define ESMF_METHOD "ESMF_TimeIntervalSetStrCalTyp()"
 !BOP
-! !IROUTINE: ESMF_TimeIntervalSet - Initialize or set a TimeInterval from an ISO format string and calendar kind
+! !IROUTINE: ESMF_TimeIntervalSet - Initialize or set a TimeInterval from an ISO 8601 format string and calendar kind
 
 ! !INTERFACE:
       ! Private name; call using ESMF_TimeIntervalSet()
@@ -3341,8 +3341,8 @@ subroutine ESMF_TimeIntervalSetStrCalTyp(timeinterval, calkindflag, &
 !
 !
 ! !DESCRIPTION:
-!  Sets the value of the {\tt ESMF\_TimeInterval} using a user specified
-!  string in ISO duration format P[y]Y[mm]M[d]DT[h]H[m]M[s]S. See ~\cite{ISO} and ~\cite{ISOnotes} for
+!  Sets the value of an {\tt ESMF\_TimeInterval} using a
+!  string in ISO 8601 duration format P[y]Y[mm]M[d]DT[h]H[m]M[s]S. See ~\cite{ISO} and ~\cite{ISOnotes} for
 !  information about the format. Also, see the description for the method
 ! {\tt ESMF\_TimeIntervalSetStr()}~\ref{API:TimeIntervalSetStr}
 ! for the specific types supported by ESMF for the values in the duration string. 
@@ -3356,7 +3356,7 @@ subroutine ESMF_TimeIntervalSetStrCalTyp(timeinterval, calkindflag, &
 !          calendar above.  More convenient way of specifying a built-in 
 !          calendar kind.
 !     \item[timeIntervalString]
-!          ISO format duration string (e.g. P[y]Y[mm]M[d]DT[h]H[m]M[s]S).
+!          ISO 8601 format duration string (e.g. P[y]Y[mm]M[d]DT[h]H[m]M[s]S).
 !     \item[{[rc]}]
 !          Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
 !     \end{description}
@@ -3414,7 +3414,7 @@ end subroutine ESMF_TimeIntervalSetStrCalTyp
 #undef  ESMF_METHOD
 #define ESMF_METHOD "ESMF_TimeIntervalSetStrStart()"
 !BOP
-! !IROUTINE: ESMF_TimeIntervalSet - Initialize or set a TimeInterval from an ISO format string and start time
+! !IROUTINE: ESMF_TimeIntervalSet - Initialize or set a TimeInterval from an ISO 8601 format string and start time
 
 ! !INTERFACE:
       ! Private name; call using ESMF_TimeIntervalSet()
@@ -3430,8 +3430,8 @@ subroutine ESMF_TimeIntervalSetStrStart(timeinterval, startTime, &
 !
 !
 ! !DESCRIPTION:
-!  Sets the value of the {\tt ESMF\_TimeInterval} using a user specified
-!  string in ISO duration format P[y]Y[mm]M[d]DT[h]H[m]M[s]S. See ~\cite{ISO} and ~\cite{ISOnotes} for
+!  Sets the value of an {\tt ESMF\_TimeInterval} using a
+!  string in ISO 8601 duration format P[y]Y[mm]M[d]DT[h]H[m]M[s]S. See ~\cite{ISO} and ~\cite{ISOnotes} for
 !  information about the format. Also, see the description for the method
 ! {\tt ESMF\_TimeIntervalSetStr()}~\ref{API:TimeIntervalSetStr}
 ! for the specific types supported by ESMF for the values in the duration string. 
@@ -3446,7 +3446,7 @@ subroutine ESMF_TimeIntervalSetStrStart(timeinterval, startTime, &
 !          in time.  If not set, and calendar also not set, calendar interval 
 !          "floats" across all calendars and times.
 !     \item[timeIntervalString]
-!          ISO format duration string (e.g. P[y]Y[mm]M[d]DT[h]H[m]M[s]S).
+!          ISO 8601 format duration string (e.g. P[y]Y[mm]M[d]DT[h]H[m]M[s]S).
 !     \item[{[rc]}]
 !          Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
 !     \end{description}

src/Infrastructure/Util/include/ESMC_Macros.h

@@ -54,10 +54,10 @@
 #define ESMF_VERSION_MINOR        7
 #define ESMF_VERSION_REVISION     0
 #define ESMF_VERSION_PATCHLEVEL   0
-#define ESMF_VERSION_PUBLIC       'F'
-#define ESMF_VERSION_BETASNAPSHOT 'T'
+#define ESMF_VERSION_PUBLIC       'T'
+#define ESMF_VERSION_BETASNAPSHOT 'F'
 
-#define ESMF_VERSION_STRING "8.7.0 beta snapshot"
+#define ESMF_VERSION_STRING "8.7.0"
 
 #endif   // ESMC_MACROS_H
 

src/Infrastructure/Util/src/ESMF_UtilTypes.F90

@@ -85,10 +85,10 @@ module ESMF_UtilTypesMod
       integer, parameter :: ESMF_VERSION_MINOR        = 7
       integer, parameter :: ESMF_VERSION_REVISION     = 0
       integer, parameter :: ESMF_VERSION_PATCHLEVEL   = 0
-      logical, parameter :: ESMF_VERSION_PUBLIC       = .false.
-      logical, parameter :: ESMF_VERSION_BETASNAPSHOT = .true.
+      logical, parameter :: ESMF_VERSION_PUBLIC       = .true.
+      logical, parameter :: ESMF_VERSION_BETASNAPSHOT = .false.
 
-      character(*), parameter :: ESMF_VERSION_STRING  = "8.7.0 beta snapshot"
+      character(*), parameter :: ESMF_VERSION_STRING  = "8.7.0"
 
 #if defined (ESMF_NETCDF)
       logical, parameter :: ESMF_IO_NETCDF_PRESENT = .true.

src/addon/NUOPC/doc/NUOPC_howtodoc.ctex

@@ -17,7 +17,7 @@
 \addtolength{\oddsidemargin}{-.75in}
 \newcommand{\mytitle}{\Large {\bf Building a NUOPC Model}}
 \newcommand{\myauthors}{\large {\it Content Standards Committee (CSC) Members}}
-\newcommand{\myversion}{ESMF 8.7.0 beta snapshot}
+\newcommand{\myversion}{ESMF 8.7.0}
 % set a standard paragraph style
 \setlength{\parskip}{0pt}
 \setlength{\parindent}{0pt}

src/addon/NUOPC/doc/NUOPC_refdoc.ctex

@@ -17,7 +17,7 @@
 \addtolength{\oddsidemargin}{-.75in}
 \newcommand{\mytitle}{\Large {\bf NUOPC Layer Reference}}
 \newcommand{\myauthors}{\large {\it Content Standards Committee (CSC) Members}}
-\newcommand{\myversion}{ESMF 8.7.0 beta snapshot}
+\newcommand{\myversion}{ESMF 8.7.0}
 % set a standard paragraph style
 \setlength{\parskip}{0pt}
 \setlength{\parindent}{0pt}

src/addon/esmpy/pyproject.toml

@@ -33,7 +33,7 @@ enabled = true
 template = "{tag}"
 dev_template = "{tag}"
 dirty_template = "{tag}"
-starting_version = "8.7.0beta" # this is a backup for pip <= 22.0 where git-versioning doesn't work
+starting_version = "8.7.0" # this is a backup for pip <= 22.0 where git-versioning doesn't work
 
 [tool.dynamic]
 version = "placeholder" # this is a placeholder for the version pulled with git-versioning

src/doc/ESMC_crefdoc.ctex

@@ -14,7 +14,7 @@
 \newcommand{\sreq}[1]{\subsection{\hspace{.2in}#1}}
 \newcommand{\ssreq}[1]{\subsubsection{\hspace{.2in}#1}}
 \newcommand{\mytitle}{\longname \docmttype ~~}
-\newcommand{\myversion}{Version 8.7.0 beta snapshot}
+\newcommand{\myversion}{Version 8.7.0}
 
 \newenvironment
 {reqlist}

src/doc/ESMF_refdoc.ctex

@@ -15,7 +15,7 @@
 \newcommand{\sreq}[1]{\subsection{\hspace{.2in}#1}}
 \newcommand{\ssreq}[1]{\subsubsection{\hspace{.2in}#1}}
 \newcommand{\mytitle}{\longname \docmttype ~~}
-\newcommand{\myversion}{Version 8.7.0 beta snapshot}
+\newcommand{\myversion}{Version 8.7.0}
 
 \input{common_commands}
 

src/doc/ESMF_usrdoc.ctex

@@ -14,7 +14,7 @@
 \newcommand{\sreq}[1]{\subsection{\hspace{.2in}#1}}
 \newcommand{\ssreq}[1]{\subsubsection{\hspace{.2in}#1}}
 \newcommand{\mytitle}{\longname \docmttype ~~}
-\newcommand{\myversion}{Version 8.7.0 beta snapshot}
+\newcommand{\myversion}{Version 8.7.0}
 
 \newenvironment
 {reqlist}