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
* 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
Copy file name to clipboardexpand all lines: docs/UsersGuide/source/ConfigNewPlatform.rst
+18-14
Original file line number
Diff line number
Diff line change
@@ -14,11 +14,11 @@ The first step to installing on a new machine is to install :term:`NCEPLIBS` (ht
14
14
15
15
* C and C++ compilers compatible with the Fortran compiler
16
16
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
18
18
19
19
* Python v3.6+
20
20
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
22
22
23
23
* Perl 5
24
24
@@ -28,16 +28,20 @@ The first step to installing on a new machine is to install :term:`NCEPLIBS` (ht
28
28
29
29
* 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.
30
30
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.
34
32
35
33
.. code-block:: console
36
34
35
+
# Linux, if allowed
36
+
ulimit -s unlimited
37
+
38
+
# macOS, this corresponds to 65MB
37
39
ulimit -S -s unlimited
38
40
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/):
41
45
42
46
* brew install wget
43
47
@@ -160,7 +164,7 @@ At this point there are just a few more variables that need to be set prior to b
160
164
export CMAKE_CXX_COMPILER=mpicxx
161
165
export CMAKE_Fortran_COMPILER=mpifort
162
166
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:
164
168
165
169
.. code-block:: console
166
170
@@ -198,7 +202,7 @@ Running the graphics scripts in ``${WORKDIR}/ufs-srweather-app/regional_workflow
198
202
199
203
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).
200
204
201
-
Running Without a Workflow Manager: Generic Linux and MacOS Platforms
205
+
Running Without a Workflow Manager: Generic Linux and macOS Platforms
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>`.
248
252
249
253
.. _WallClockTimes:
250
254
@@ -341,7 +345,7 @@ Those requirements highlighted in **bold** are included in the NCEPLIBS-external
341
345
342
346
* 4GB memory (CONUS 25km domain)
343
347
344
-
* Fortran compiler with full Fortran 2003 standard support
348
+
* Fortran compiler with full Fortran 2008 standard support
345
349
346
350
* C and C++ compiler
347
351
@@ -361,13 +365,13 @@ Those requirements highlighted in **bold** are included in the NCEPLIBS-external
361
365
362
366
* **netCDF (C and Fortran libraries)**
363
367
* **HDF5**
364
-
* **ESMF**
368
+
* **ESMF** 8.0.0
365
369
* **Jasper**
366
370
* **libJPG**
367
371
* **libPNG**
368
372
* **zlib**
369
373
370
-
MacOS-specific prerequisites:
374
+
macOS-specific prerequisites:
371
375
372
376
* brew install wget
373
377
* brew install cmake
@@ -381,4 +385,4 @@ Optional but recommended prerequisites:
381
385
* Bash v4+
382
386
* Rocoto Workflow Management System (1.3.1)
383
387
* **CMake v3.15+**
384
-
* Python package pygrib for graphics
388
+
* Python packages scipy, matplotlib, pygrib, cartopy, and pillow for graphics
Copy file name to clipboardexpand all lines: docs/UsersGuide/source/ConfigParameters.inc
+10-8
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,9 @@
5
5
Grid Generation Parameters
6
6
==========================
7
7
``GRID_GEN_METHOD``: (Default: “”)
8
-
This variable specifies the method to use to generate a regional grid in the horizontal. The only supported valueof 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 valueof 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.
The amount of data that is passed into the cache at a time.
51
53
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:
53
55
54
-
#. If the experiment is using a predefined grid, thenif 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 valueof the parameter for that predefined grid will be used.
56
+
#. If the experiment is using a predefined gridand 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 valueof the parameter for that predefined grid will be used.
55
57
56
-
#. If the experiment isnot 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 valuefor the parameter in that configuration file. Otherwise, the parameter will remain setto 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 setto non-empty strings before creating the experiment directory.
58
+
#. If the experiment isnot 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 valuefor the parameter in that configuration file. Otherwise, the parameter will remain setto 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 setto non-empty strings before creating the experiment directory.
57
59
58
60
Write-Component (Quilting) Parameters
59
61
=====================================
@@ -91,7 +93,7 @@ Currently supported ``PREDEF_GRID_NAME`` options are "RRFS_CONUS_25km," "RRFS_CO
91
93
Pre-existing Directory Parameter
92
94
================================
93
95
``PREEXISTING_DIR_METHOD``: (Default: “delete”)
94
-
This variable determines the method touse todeal 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 setto one of"delete", "rename", and"quit". The resulting behavior for each of these values isas 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 setto one of"delete", "rename", and"quit". The resulting behavior for each of these values isas follows:
95
97
96
98
* "delete": The preexisting directory is deleted and a new directory (having the same nameas the original preexisting directory) is created.
97
99
@@ -128,12 +130,12 @@ These parameters set flags (and related directories) that determine whether the
Array containing the names ofall the fields for which the ``MAKE_SFC_CLIMO_TN`` task generates files on the native FV3-LAM grid.
133
135
134
136
Fixed File Parameters
135
137
=====================
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.
137
139
138
140
``FIXgsm``: (Default: “”)
139
141
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
221
223
``CYCLEDIR_LINKS_TO_FIXam_FILES_MAPPING``: (Default: see below)
0 commit comments