You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/SW4-Installation.tex
+11-11Lines changed: 11 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -341,7 +341,7 @@ \subsubsection{How do I setup the {\tt make.inc} file?}
341
341
the C++ compiler, Fortran compiler, or linker, on your system.
342
342
343
343
\subsection{Building \emph{SW4} with PROJ, HDF5, and ZFP support}
344
-
The PROJ libraray enables the more advanced geographical mapping keywords in the {\tt grid} command and is also required by the {\tt rfile, sfile} and {\tt gmg} commands. To enable the {\tt sfile}, {\tt ssioutput}, and {\tt gmg} commands, you have to also install the {\tt HDF5} library. To use ZFP compression for the {\tt ssioutput} command, {\tt ZFP} and {\tt H5Z-ZFP} are required. See Section \ref{sec:proj} for installing these libraries.
344
+
The PROJ library enables the more advanced geographical mapping keywords in the {\tt grid} command and is also required by the {\tt rfile, sfile} and {\tt gmg} commands. To enable the {\tt sfile}, {\tt ssioutput}, and {\tt gmg} commands, you have to also install the {\tt HDF5} library. To use ZFP compression for the {\tt ssioutput} command, {\tt ZFP} and {\tt H5Z-ZFP} are required. See Section \ref{sec:proj} for installing these libraries.
345
345
346
346
Once you have successfully installed the PROJ, and optionally the HDF5 and ZFP libraries, it should be easy to re-configure \emph{SW4} to use them. Simply edit your configuration file (\verb+make.inc+) by adding the following lines to the top of the file, setting the {\tt proj}, {\tt hdf5}, and {\tt zfp} keywords to
347
347
{\tt yes} or {\tt no}, as appropriate.
@@ -366,7 +366,7 @@ \subsection{Building \emph{SW4} with PROJ, HDF5, and ZFP support}
366
366
\verb+debug+ directories.
367
367
368
368
\subsection{Testing the \emph{SW4} installation}
369
-
The \emph{SW4} source code distribution includes a python(3) script for running several tests and
369
+
The \emph{SW4} source code distribution includes a Python (3) script for running several tests and
370
370
checking the solutions against previously verified results. Note that the same set of tests can be
371
371
performed when \emph{SW4} is built with CMake, see Section~\ref{cha:ctest-sw4}.
372
372
@@ -438,7 +438,7 @@ \section{Installing \emph{SW4} with CMake}\label{cha:installing-cmake-sw4}
438
438
The two dots after {\tt cmake [options]} are essential and instructs it to look in the parent
439
439
directory for the {\tt CMakeLists.txt} file.
440
440
441
-
The \verb+cmake+ command searches for the necessary libraries and other dependencies, then creates
441
+
The \verb+cmake+ command searches for the necessary libraries and other dependencies then creates
442
442
makefiles that are appropriate for your system. You then run \verb+make+ to compiles and link
443
443
\emph{SW4} using these makefiles. For details about the exact commands being used in compilation,
444
444
run \texttt{make VERBOSE=1}. Once SW4 has been successfully built, you will see the
@@ -534,15 +534,15 @@ \subsection{CMake Options}
534
534
535
535
Sometimes CMake doesn't pick up the correct compiler. Say, for example that the C++ compiler on your
536
536
system is called {\tt mpicxx} and the Fortran compiler is {\tt mpiifort}. You can tell {\tt cmake}
537
-
to use those compilers by setting the following envoronment variables {\em before} running cmake
537
+
to use those compilers by setting the following environment variables {\em before} running cmake
538
538
(assuming a {\tt csh} shell),
539
539
\begin{verbatim}
540
540
> setenv CXX mpicxx
541
541
> setenv FC mpiifort
542
542
\end{verbatim}
543
543
544
544
\subsection{CTest}\label{cha:ctest-sw4}
545
-
The \emph{SW4} CMake configuration includes several test cases that are used to verify the correctness
545
+
The \emph{SW4} CMake configuration includes several test cases used to verify the correctness
546
546
of the \emph{SW4} installation. Each test consists of two parts. First it runs a case using an input
547
547
file in the \verb+pytest+ directory. Secondly, it checks that the results are within
548
548
a reasonable error tolerance from previously recorded results.
To restart from a previously written checkpoint file, add the \verb+restartfile+ key word and the checkpoint file name to the \verb+checkpoint+ command:
Note that when using the \verb+checkpoint+ command in combination with the \verb+rec+, \verb+rechdf5+, and \verb+ssioutput+ commands, it is advisable to align their write intervals, such that the latest time-series data are also written at the time writing a checkpoint file. For example, a user may set \verb+writeEvery=1000+ (default) in the \verb+rechdf5+ command, and set \verb+dumpInterval=400+ in the \verb+ssioutput+ command, and set \verb+cycleInterval=40000+, as 40000 is divisible by both 1000 and 4000.
same meaning as the corresponding parameters in the image command.
4216
4216
The \verb+ssioutput+ command produces files with extension \verb+.ssi+.
4217
-
To reduce the output size, we have enabled the support to utilize ZFP \url{https://github.com/LLNL/zfp} and SZ \url{https://github.com/szcompressor/SZ} lossy compression. They can reduce the output size without significant precision loss. We found setting \verb+zfp_accuracy=0.01+ can reduce the output size by a factor of 40. Note ZFP and H5Z-ZFP must be installed and linked with SW4 to use this option, see the Installation Guide for detailed installation instructions.
4217
+
To reduce the output size, we have enabled the support to utilize ZFP \url{https://github.com/LLNL/zfp} and SZ \url{https://github.com/szcompressor/SZ} lossy compression. They can reduce the output size without significant precision loss. We found setting \verb+zfp-accuracy=0.01+ can reduce the output size by a factor of 40. Note ZFP and H5Z-ZFP must be installed and linked with SW4 to use this option, see the Installation Guide for detailed installation instructions.
4218
4218
4219
4219
4220
4220
The option {\bf dumpInterval=...} affects the maximum
0 commit comments