Skip to content

Commit

Permalink
User's guide cleanup and minor improvements.
Browse files Browse the repository at this point in the history
  • Loading branch information
theurich committed Nov 8, 2023
1 parent a55dfc5 commit 2162304
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 8 deletions.
2 changes: 1 addition & 1 deletion src/doc/ESMF_builddetail.tex
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ \subsubsection{Source code configuration}
the build system provides a path to the correct files during
source code compilation.

\subsection{Porting the ESMF to New Platforms}
\subsection{Porting ESMF to New Platforms}

The ESMF build system can be ported to other Unix platforms by adding a new
platform specific makefile fragment and two associated configuration files.
Expand Down
11 changes: 6 additions & 5 deletions src/doc/ESMF_quickstart.tex
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@ \section{Quick Start}
\ref{sec:TechOver2} and \ref{sec:CLTs}, respectively.

With a growing user community requiring access to ESMF, central computing
resources (such as ORNL for the {\it Jaguar} and {\it Kraken} supercomputers)
have recently started providing system wide ESMF installations. The availablity
resources have started providing system wide ESMF installations. The availablity
of center-managed ESMF installations dramatically increases the ease of use of
ESMF. Practically it means that if you are working on a system (such as
{\it Jaguar}) that offers a standard ESMF installation, you do not have to
Expand Down Expand Up @@ -52,7 +51,9 @@ \subsection{Building ESMF}
\item Type {\tt make check } to run self-tests to verify
the build was successful.
\end{enumerate}
See the following sections for more information on each of these steps.
See the following subsections for more information on each of these steps. Also
consult section \ref{sec:TechOver} for a complete discussion of the the ESMF
build process.

\subsubsection{Environment variables}

Expand All @@ -66,8 +67,8 @@ \subsubsection{Environment variables}

The shell environment variables listed below are the ones most
frequently used. There are others which address needs on specific
platforms or are needed under more unusual circumstances;
see Section \ref{sec:TechOver} for the full list.
platforms or are needed under more unusual circumstances;
see section \ref{sec:TechOver} for the full list.
\begin{description}

\item[ESMF\_DIR]
Expand Down
4 changes: 2 additions & 2 deletions src/doc/ESMF_techoverview.tex
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ \section{Using Bundled ESMF Command Line Tools}

\newpage

\section{Building and Installing the ESMF}
\section{Building and Installing ESMF}
\label{sec:TechOver}

This section goes into more detail about how to build and install the ESMF
Expand All @@ -27,7 +27,7 @@ \section{Building and Installing the ESMF}
\input{ESMF_install}


\section{Porting the ESMF}
\section{Porting ESMF}
\label{sec:TechOverPort}

This section goes into more detail about the ESMF build system and how to
Expand Down

0 comments on commit 2162304

Please sign in to comment.