From 792671f8a91af1847015a78d8cae9d5b9d8b4fc0 Mon Sep 17 00:00:00 2001 From: Yu-Hsiang Lan Date: Wed, 22 Oct 2025 10:26:47 -0500 Subject: [PATCH] Mention compilation success message in quickstart this will be a checkpoint for new users to trouble shoot their build system. --- source/quickstart.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/source/quickstart.rst b/source/quickstart.rst index 5e11f32..f93d85e 100644 --- a/source/quickstart.rst +++ b/source/quickstart.rst @@ -72,6 +72,19 @@ Then follow the next set of commands to download the example cases and run one $ tail logfile # prints the last few lines of the solver output to the terminal $ visnek eddy_uv # produces the eddy_uv.nek5000 file + +``makenek`` should print out the following message if the compilation successes. +If not, check the error message and troubleshoot from there (also recorded in ``build.log``). + +.. code-block:: console + + ############################################################# + # Compilation successful! # + ############################################################# + text data bss dec hex filename + 1730502 39876 124109568 125879946 780c68a nek5000 + + As the case runs, it will generate multiple ``eddy_uv0.fXXXXX`` files. These are the restart checkpoint and visualization data files. The metadata file, ``eddy_uv.nek5000``, can be opened with either VisIt or ParaView, which will look for the data files in the same directory as the ``eddy_uv.nek5000`` file.