-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Initial content of Getting Started and 0.1.0 Release Notes (#64)
* first draft of Getting Started info including what to expect and how to obtain prerequisites Docker or Apptainer * added list of issues/PRs that have been completed for the 0.1.0 release * fixed doc complaint by creating unique links
- Loading branch information
1 parent
fdbb986
commit 982c44c
Showing
2 changed files
with
96 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,84 @@ | ||
*************** | ||
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 <https://www.docker.com/>`_ or `Apptainer <https://apptainer.org>`_ | ||
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 <https://docs.docker.com/engine/install/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 installation instructions for the tools. | ||
|
||
Docker: `Get Docker <https://docs.docker.com/get-docker>`_ | ||
Apptainer: `Installing Apptainer <https://apptainer.org/docs/admin/main/installation.html>`_ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters