From 72bd1dcdc18db01e833801f3834a453e32753895 Mon Sep 17 00:00:00 2001 From: George McCabe <23407799+georgemccabe@users.noreply.github.com> Date: Mon, 1 Jul 2024 11:59:17 -0600 Subject: [PATCH 1/3] first draft of Getting Started info including what to expect and how to obtain prerequisites Docker or Apptainer --- docs/Users_Guide/gettingstarted.rst | 79 +++++++++++++++++++++++++++++ 1 file changed, 79 insertions(+) diff --git a/docs/Users_Guide/gettingstarted.rst b/docs/Users_Guide/gettingstarted.rst index 41173f4..af24d18 100644 --- a/docs/Users_Guide/gettingstarted.rst +++ b/docs/Users_Guide/gettingstarted.rst @@ -1,3 +1,82 @@ *************** Getting Started *************** + +What to Expect +============== + +This guide contains instructions to demonstrate how to use containers to +run WRF to generate model output and METplus to perform verification of the +WRF output using observations. + +Future work will add instructions to easily generate plots of the WRF and +METplus output to visualize the results. + +Prerequisites +============= + +Container Software +------------------ + +`Docker `_ or `Apptainer `_ +is required to run I-WRF. These tools may already be installed. + +To check if Docker is already available, the following command should display +the usage statement:: + + docker --help + +To check if Apptainer is already available, the following command should display +the usage statement:: + + apptainer --help + +Refer to the relevant section below for instructions to obtain this software +on various supported environments. + +NCAR HPC +^^^^^^^^ + +On the NCAR supercomputers Casper and Derecho, +Apptainer is available as a module. To load apptainer, run the following:: + + module load apptainer + + +Jetstream2 +^^^^^^^^^^ + +If running on a Jetstream2 instance, Docker must be installed on the instance. +The `instructions for installing Docker Engine on Ubuntu `_ +are very thorough and make a good reference, but we only need to perform a subset of those steps. +These commands run a script that sets up the Docker software repository on your instance, +then installs Docker:: + + curl --location https://bit.ly/3R3lqMU > install-docker.sh + source install-docker.sh + +If a text dialog is displayed asking which services should be restarted, type ``Enter``. +When the installation is complete, you can verify that the Docker command line tool works by asking for its version:: + + docker --version + +The Docker daemon should start automatically, but it sometimes runs into issues. +First, check to see if the daemon started successfully:: + + sudo systemctl --no-pager status docker + +If you see a message saying the daemon failed to start because a "Start request repeated too quickly", +wait a few minutes and issue this command to try again to start it:: + + sudo systemctl start docker + +If the command seems to succeed, confirm that the daemon is running using the status command above. +Repeat these efforts as necessary until it is started. + + +User Workstation +^^^^^^^^^^^^^^^^ + +To install `Docker `_ or +`Apptainer `_ +on a personal workstation, please refer to the tool's installation instructions. From 2e66b7902ff62915afb7d8009321c138ed3689b6 Mon Sep 17 00:00:00 2001 From: George McCabe <23407799+georgemccabe@users.noreply.github.com> Date: Mon, 1 Jul 2024 12:10:54 -0600 Subject: [PATCH 2/3] added list of issues/PRs that have been completed for the 0.1.0 release --- docs/Users_Guide/release-notes.rst | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/docs/Users_Guide/release-notes.rst b/docs/Users_Guide/release-notes.rst index 542e2f8..b2a1cfe 100644 --- a/docs/Users_Guide/release-notes.rst +++ b/docs/Users_Guide/release-notes.rst @@ -9,6 +9,20 @@ When applicable, release notes are followed by the GitHub issue number which des enhancement, or new feature (`I-WRF GitHub issues `_). Important issues are listed **in bold** for emphasis. -I-WRF Version alpha release notes (YYYYMMDD) +I-WRF Version 0.1.0 release notes (YYYYMMDD) -------------------------------------------- +* Define outline for User's Guide to display content + (`#37 `_) +* Determine where to store Docker images + (`#7 `_) +* Enhance MET tools to read native WRF output + (`#5 `_) +* Update container to use Intel OneAPI when WRF 4.5.2 is available + (`#45 `_) +* Obtain observation data for Hurricane Matthew test case + (`#47 `_) +* Run Hurricane Matthew test case in METplus container + (`#48 `_) +* Initial publication of instructions for running I-WRF on Jetstream2 + (`#54 `_) From 321f605084a8c876b63616fd6f76318be09ccfab Mon Sep 17 00:00:00 2001 From: George McCabe <23407799+georgemccabe@users.noreply.github.com> Date: Mon, 1 Jul 2024 12:13:51 -0600 Subject: [PATCH 3/3] fixed doc complaint by creating unique links --- docs/Users_Guide/gettingstarted.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/Users_Guide/gettingstarted.rst b/docs/Users_Guide/gettingstarted.rst index af24d18..d2a1fe6 100644 --- a/docs/Users_Guide/gettingstarted.rst +++ b/docs/Users_Guide/gettingstarted.rst @@ -77,6 +77,8 @@ Repeat these efforts as necessary until it is started. User Workstation ^^^^^^^^^^^^^^^^ -To install `Docker `_ or -`Apptainer `_ -on a personal workstation, please refer to the tool's installation instructions. +To install Docker or Apptainer on a personal workstation, +please refer to the installation instructions for the tools. + +Docker: `Get Docker `_ +Apptainer: `Installing Apptainer `_