Skip to content

Commit 0b0fbff

Browse files
authored
Feature/doc updates into release/public-v1 (#127)
* Update path to fix files and sample model data on AWS * Updated links to several model archives * Update links for final versions and make a few small edits * Update link to Chpt 10 * Final tweaks * Updated link for UFS_UTILS doc * Update DOI publish date in README * Update wording of citation in Introduction * First pass at addressing Dom's comments. More to come, especially related to platform environments. * More small edits. More to come. * A few more updates. Still more to come. * Getting closer to addressing all of Dom's concerns. * Another small edit * A few more edits to the graphics chapter to add an example command line for the diff plot * Updated some remaining concens raised by Dom. This will now be tested and the final issues will be added prior to a PR. * More updates to the graphics chapter * Added subsections for easier reading
1 parent 0602eb0 commit 0b0fbff

10 files changed

+220
-124
lines changed

docs/UsersGuide/source/CodeReposAndDirs.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ workflow is run, is shown in :numref:`Table %s <ExptDirStructure>`.
157157
+---------------------------+-------------------------------------------------------------------------------------------------------+
158158
| data_table | Cycle-independent input file (empty) |
159159
+---------------------------+-------------------------------------------------------------------------------------------------------+
160-
| field_table | Scalar fields in the `forecast model |
160+
| field_table | Tracers in the `forecast model |
161161
| | <https://ufs-weather-model.readthedocs.io/en/ufs-v2.0.0/InputsOutputs.html#field-table-file>`_ |
162162
+---------------------------+-------------------------------------------------------------------------------------------------------+
163163
| FV3LAM_wflow.xml | Rocoto XML file to run the workflow |

docs/UsersGuide/source/ConfigNewPlatform.rst

+18-14
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ The first step to installing on a new machine is to install :term:`NCEPLIBS` (ht
1414

1515
* C and C++ compilers compatible with the Fortran compiler
1616

17-
* gcc v9+, ifort v18+, and clang (MacOS) have been tested
17+
* gcc v9+, ifort v18+, and clang v9+ (macOS, native Apple clang or LLVM clang) have been tested
1818

1919
* Python v3.6+
2020

21-
* Prerequisite packages must be downloaded: jinja2, yaml and f90nml, as well as pygrib if the user would like to use the provided graphics scripts
21+
* Prerequisite packages must be downloaded: jinja2, yaml and f90nml, as well as a number of additional Python modules (see :numref:`Section %s <SW-OS-Requirements>`) if the user would like to use the provided graphics scripts
2222

2323
* Perl 5
2424

@@ -28,16 +28,20 @@ The first step to installing on a new machine is to install :term:`NCEPLIBS` (ht
2828

2929
* CMake v3.15+ is needed for building NCEPLIBS, but versions as old as 3.12 can be used to build NCEPLIBS-external, which contains a newer CMake that can be used for the rest of the build.
3030

31-
For Linux systems, as long as the above software is available, you can move on to the next step: installing the :term:`NCEPLIBS-external` package.
32-
33-
For MacOS systems, you will also need to set the stack size to “unlimited”.
31+
For both Linux and macOS, you will need to set the stack size to "unlimited" (if allowed) or the largest possible value.
3432

3533
.. code-block:: console
3634
35+
# Linux, if allowed
36+
ulimit -s unlimited
37+
38+
# macOS, this corresponds to 65MB
3739
ulimit -S -s unlimited
3840
39-
Additionally, some extra software is needed: ``wget``, ``coreutils``, ``pkg-config``, and ``gnu-sed``.
40-
It is recommended that you install this software using the Homebrew package manager for MacOS (https://brew.sh/):
41+
For Linux systems, as long as the above software is available, you can move on to the next step: installing the :term:`NCEPLIBS-external` package.
42+
43+
For macOS systems, some extra software is needed: ``wget``, ``coreutils``, ``pkg-config``, and ``gnu-sed``.
44+
It is recommended that you install this software using the Homebrew package manager for macOS (https://brew.sh/):
4145

4246
* brew install wget
4347

@@ -160,7 +164,7 @@ At this point there are just a few more variables that need to be set prior to b
160164
export CMAKE_CXX_COMPILER=mpicxx
161165
export CMAKE_Fortran_COMPILER=mpifort
162166
163-
If you are using your machine’s built-in MPI compilers, it is recommended you set the ``CMAKE_*_COMPILER`` flags to full paths to ensure that the correct MPI aliases are used. Finally, one last environment variable, ``CMAKE_Platform``, must be set. This will depend on your machine; for example, on a MacOS operating system with GNU compilers:
167+
If you are using your machine’s built-in MPI compilers, it is recommended you set the ``CMAKE_*_COMPILER`` flags to full paths to ensure that the correct MPI aliases are used. Finally, one last environment variable, ``CMAKE_Platform``, must be set. This will depend on your machine; for example, on a macOS operating system with GNU compilers:
164168

165169
.. code-block:: console
166170
@@ -198,7 +202,7 @@ Running the graphics scripts in ``${WORKDIR}/ufs-srweather-app/regional_workflow
198202

199203
For the final step of creating and running an experiment, the exact methods will depend on if you are running with or without a workflow manager (Rocoto).
200204

201-
Running Without a Workflow Manager: Generic Linux and MacOS Platforms
205+
Running Without a Workflow Manager: Generic Linux and macOS Platforms
202206
=====================================================================
203207
Now that the code has been built, you can stage your data as described in :numref:`Section %s <DownloadingStagingInput>`.
204208

@@ -244,7 +248,7 @@ From here, you can run each individual task of the UFS SRW App using the provide
244248
cp ${WORKDIR}/ufs-srweather-app/regional_workflow/ush/wrappers/*sh .
245249
cp ${WORKDIR}/ufs-srweather-app/regional_workflow/ush/wrappers/README.md .
246250
247-
The ``README.md`` file will contain instructions on the order that each script should be run in. An example of wallclock times for each task for an example run (2017 Macbook Pro, MacOS Catalina, 25km CONUS domain, 48hr forecast) is listed in :numref:`Table %s <WallClockTimes>`.
251+
The ``README.md`` file will contain instructions on the order that each script should be run in. An example of wallclock times for each task for an example run (2017 Macbook Pro, macOS Catalina, 25km CONUS domain, 48hr forecast) is listed in :numref:`Table %s <WallClockTimes>`.
248252

249253
.. _WallClockTimes:
250254

@@ -341,7 +345,7 @@ Those requirements highlighted in **bold** are included in the NCEPLIBS-external
341345

342346
* 4GB memory (CONUS 25km domain)
343347

344-
* Fortran compiler with full Fortran 2003 standard support
348+
* Fortran compiler with full Fortran 2008 standard support
345349

346350
* C and C++ compiler
347351

@@ -361,13 +365,13 @@ Those requirements highlighted in **bold** are included in the NCEPLIBS-external
361365

362366
* **netCDF (C and Fortran libraries)**
363367
* **HDF5**
364-
* **ESMF**
368+
* **ESMF** 8.0.0
365369
* **Jasper**
366370
* **libJPG**
367371
* **libPNG**
368372
* **zlib**
369373

370-
MacOS-specific prerequisites:
374+
macOS-specific prerequisites:
371375

372376
* brew install wget
373377
* brew install cmake
@@ -381,4 +385,4 @@ Optional but recommended prerequisites:
381385
* Bash v4+
382386
* Rocoto Workflow Management System (1.3.1)
383387
* **CMake v3.15+**
384-
* Python package pygrib for graphics
388+
* Python packages scipy, matplotlib, pygrib, cartopy, and pillow for graphics

docs/UsersGuide/source/ConfigParameters.inc

+10-8
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@
55
Grid Generation Parameters
66
==========================
77
``GRID_GEN_METHOD``: (Default: “”)
8-
This variable specifies the method to use to generate a regional grid in the horizontal. The only supported value of this parameter is “ESGgrid”, in which case the Extended Schmidt Gnomonic grid generation method developed by Jim Purser of EMC will be used.
8+
This variable specifies the method to use to generate a regional grid in the horizontal. The only supported value of this parameter is “ESGgrid”, in which case the Extended Schmidt Gnomonic grid generation method developed by Jim Purser(1) of EMC will be used.
9+
10+
(1)Purser, R. J., D. Jovic, G. Ketefian, T. Black, J. Beck, J. Dong, and J. Carley, 2020: The Extended Schmidt Gnomonic Grid for Regional Applications. Unified Forecast System (UFS) Users’ Workshop. July 27-29, 2020.
911

1012
.. note::
1113

@@ -49,11 +51,11 @@ Computational Forecast Parameters
4951
``BLOCKSIZE``: (Default: “”)
5052
The amount of data that is passed into the cache at a time.
5153

52-
Here, we set these parameters to null strings. This is so that, for any one of these parameters:
54+
Here, we set these parameters to null strings. This is so that, for any one of these parameters:
5355

54-
#. If the experiment is using a predefined grid, then if the user sets the parameter in the user-specified experiment configuration file (``EXPT_CONFIG_FN``), that value will be used in the forecast(s). Otherwise, the default value of the parameter for that predefined grid will be used.
56+
#. If the experiment is using a predefined grid and the user sets the parameter in the user-specified experiment configuration file (``EXPT_CONFIG_FN``), that value will be used in the forecast(s). Otherwise, the default value of the parameter for that predefined grid will be used.
5557

56-
#. If the experiment is not using a predefined grid (i.e. it is using a custom grid whose parameters are specified in the experiment configuration file), then the user must specify a value for the parameter in that configuration file. Otherwise, the parameter will remain set to a null string, and the experiment generation will fail because the generation scripts check to ensure that all the parameters defined in this section are set to non-empty strings before creating the experiment directory.
58+
#. If the experiment is not using a predefined grid (i.e. it is using a custom grid whose parameters are specified in the experiment configuration file), then the user must specify a value for the parameter in that configuration file. Otherwise, the parameter will remain set to a null string, and the experiment generation will fail, because the generation scripts check to ensure that all the parameters defined in this section are set to non-empty strings before creating the experiment directory.
5759

5860
Write-Component (Quilting) Parameters
5961
=====================================
@@ -91,7 +93,7 @@ Currently supported ``PREDEF_GRID_NAME`` options are "RRFS_CONUS_25km," "RRFS_CO
9193
Pre-existing Directory Parameter
9294
================================
9395
``PREEXISTING_DIR_METHOD``: (Default: “delete”)
94-
This variable determines the method to use to deal with pre-existing directories [e.g ones generated by previous calls to the experiment generation script using the same experiment name (``EXPT_SUBDIR``) as the current experiment]. This variable must be set to one of "delete", "rename", and "quit". The resulting behavior for each of these values is as follows:
96+
This variable determines the method to deal with pre-existing directories [e.g ones generated by previous calls to the experiment generation script using the same experiment name (``EXPT_SUBDIR``) as the current experiment]. This variable must be set to one of "delete", "rename", and "quit". The resulting behavior for each of these values is as follows:
9597

9698
* "delete": The preexisting directory is deleted and a new directory (having the same name as the original preexisting directory) is created.
9799

@@ -128,12 +130,12 @@ These parameters set flags (and related directories) that determine whether the
128130

129131
Surface Climatology Parameter
130132
=============================
131-
``SFC_CLIMO_FIELDS``: (Default: “("facsf" "maximum_snow_albedo" "slope_type" "snowfree_albedo" "soil_type" "substrate_temperature" "vegetation_greenness" "vegetation_type")”
133+
``SFC_CLIMO_FIELDS``: (Default: “("facsf" "maximum_snow_albedo" "slope_type" "snowfree_albedo" "soil_type" "substrate_temperature" "vegetation_greenness" "vegetation_type")”)
132134
Array containing the names of all the fields for which the ``MAKE_SFC_CLIMO_TN`` task generates files on the native FV3-LAM grid.
133135

134136
Fixed File Parameters
135137
=====================
136-
Set parameters associated with the fixed (i.e. static) files. For the main NOAA HPC platforms, as well as Cheyenne, Odin, and Stampede, fixed files are prestaged in locations on each machine with paths defined in the ``setup.sh`` script.
138+
Set parameters associated with the fixed (i.e. static) files. For the main NOAA HPC platforms, as well as Cheyenne, Odin, and Stampede, fixed files are prestaged with paths defined in the ``setup.sh`` script.
137139

138140
``FIXgsm``: (Default: “”)
139141
System directory in which the majority of fixed (i.e. time-independent) files that are needed to run the FV3-LAM model are located.
@@ -221,7 +223,7 @@ Set parameters associated with the fixed (i.e. static) files. For the main NOAA
221223
``CYCLEDIR_LINKS_TO_FIXam_FILES_MAPPING``: (Default: see below)
222224
.. code-block:: console
223225
224-
("aerosol.dat | global_climaeropac_global.txt" \
226+
("aerosol.dat | global_climaeropac_global.txt" \
225227
"co2historicaldata_2010.txt | fix_co2_proj/global_co2historicaldata_2010.txt" \
226228
"co2historicaldata_2011.txt | fix_co2_proj/global_co2historicaldata_2011.txt" \
227229
"co2historicaldata_2012.txt | fix_co2_proj/global_co2historicaldata_2012.txt" \

0 commit comments

Comments
 (0)