From 4925844825b66949921e946af4e3712a3964943a Mon Sep 17 00:00:00 2001 From: Julie Schramm Date: Tue, 14 Jan 2020 09:16:25 -0700 Subject: [PATCH 1/2] - Update Glossary.rst - Add Acronyms.rst - Remove PlatformSupport.rst; this will be included with the app. - Update conf.py to correct name of document for latex build. - Remove TransitioningFromVLAB.rst, GitGitHub.rst and Template.rst. Both html and latex builds succeed. --- doc/UsersGuide/source/Acronyms.rst | 89 ++++++++++++++++ doc/UsersGuide/source/GitGitHub.rst | 7 -- doc/UsersGuide/source/Glossary.rst | 100 +++--------------- doc/UsersGuide/source/PlatformSupport.rst | 8 -- doc/UsersGuide/source/Template.rst | 7 -- .../source/TransitioningFromVLAB.rst | 8 -- doc/UsersGuide/source/conf.py | 12 +-- doc/UsersGuide/source/index.rst | 3 +- 8 files changed, 108 insertions(+), 126 deletions(-) create mode 100644 doc/UsersGuide/source/Acronyms.rst delete mode 100644 doc/UsersGuide/source/GitGitHub.rst delete mode 100644 doc/UsersGuide/source/PlatformSupport.rst delete mode 100644 doc/UsersGuide/source/Template.rst delete mode 100644 doc/UsersGuide/source/TransitioningFromVLAB.rst diff --git a/doc/UsersGuide/source/Acronyms.rst b/doc/UsersGuide/source/Acronyms.rst new file mode 100644 index 0000000000..e059c04245 --- /dev/null +++ b/doc/UsersGuide/source/Acronyms.rst @@ -0,0 +1,89 @@ +.. _Acronyms: + +************************* +Acronyms +************************* + +.. table:: + :widths: 20 80 + + +----------------+---------------------------------------------------+ + | Abbreviation | Explanation | + +================+===================================================+ + | API | Application Programming Interface | + +----------------+---------------------------------------------------+ + | b4b | Bit-for-bit | + +----------------+---------------------------------------------------+ + | CCPP | Common Community Physics Package | + +----------------+---------------------------------------------------+ + | CPP | C preprocessor | + +----------------+---------------------------------------------------+ + | dycore | Dynamical core | + +----------------+---------------------------------------------------+ + | EDMF | Eddy-Diffusivity Mass Flux | + +----------------+---------------------------------------------------+ + | EMC | Environmental Modeling Center | + +----------------+---------------------------------------------------+ + | ESMF | The Earth System Modeling Framework | + +----------------+---------------------------------------------------+ + | FMS | Flexible Modeling System | + +----------------+---------------------------------------------------+ + | FV3 | Finite-Volume Cubed Sphere | + +----------------+---------------------------------------------------+ + | GFDL | Geophysical Fluid Dynamics Laboratory | + +----------------+---------------------------------------------------+ + | GFS | Global Forecast System | + +----------------+---------------------------------------------------+ + | GSD | Global Systems Division | + +----------------+---------------------------------------------------+ + | HTML | Hypertext Markup Language | + +----------------+---------------------------------------------------+ + | LSM | Land Surface Model | + +----------------+---------------------------------------------------+ + | MPI | Message Passing Interface | + +----------------+---------------------------------------------------+ + | NCAR | National Center for Atmospheric Research | + +----------------+---------------------------------------------------+ + | NEMS | National Oceanic and Atmospheric Administration | + | | (NOAA) Environmental Modeling System | + +----------------+---------------------------------------------------+ + | NOAA | National Oceanic and Atmospheric Administration | + +----------------+---------------------------------------------------+ + | OpenMP | Open Multi-Processing | + +----------------+---------------------------------------------------+ + | PBL | Planetary Boundary Layer | + +----------------+---------------------------------------------------+ + | png | Portable Network Graphic | + +----------------+---------------------------------------------------+ + | PR | Pull request | + +----------------+---------------------------------------------------+ + | PROD | Compiler optimization flags for production mode | + +----------------+---------------------------------------------------+ + | REPRO | Compiler optimization flags for reproduction mode | + | | (bit-for-bit testing) | + +----------------+---------------------------------------------------+ + | RRTMG | Rapid Radiative Transfer Model for Global | + | | Circulation Models | + +----------------+---------------------------------------------------+ + | RT | Regression test | + +----------------+---------------------------------------------------+ + | SAS | Simplified Arakawa-Schubert | + +----------------+---------------------------------------------------+ + | SDF | Suite Definition File | + +----------------+---------------------------------------------------+ + | sfc | Surface | + +----------------+---------------------------------------------------+ + | SHUM | Perturbed boundary layer specific humidity | + +----------------+---------------------------------------------------+ + | SKEB | Stochastic Kinetic Energy Backscatter | + +----------------+---------------------------------------------------+ + | SPPT | Stochastically Perturbed Physics Tendencies | + +----------------+---------------------------------------------------+ + | TKE | Turbulent Kinetic Energy | + +----------------+---------------------------------------------------+ + | UFS | Unified Forecast System | + +----------------+---------------------------------------------------+ + | VLab | Virtual Laboratory | + +----------------+---------------------------------------------------+ + | WM | Weather Model | + +----------------+---------------------------------------------------+ diff --git a/doc/UsersGuide/source/GitGitHub.rst b/doc/UsersGuide/source/GitGitHub.rst deleted file mode 100644 index 3d6c0bec40..0000000000 --- a/doc/UsersGuide/source/GitGitHub.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. _GitGitHub: - -*********************************** -Learning How to Use git and GitHub -*********************************** - -Links to external resources diff --git a/doc/UsersGuide/source/Glossary.rst b/doc/UsersGuide/source/Glossary.rst index 7f5a6191a3..e5fed54dfb 100644 --- a/doc/UsersGuide/source/Glossary.rst +++ b/doc/UsersGuide/source/Glossary.rst @@ -14,47 +14,14 @@ Glossary *CCPP-Physics* The pool of CCPP-compliant physics schemes; also refers to a software repository of the same name - Dynamic CCPP build - A CCPP build type in which the *CCPP-Framework* and *CCPP-physics* libraries are - dynamically linked to the executable and all CCPP-compliant schemes available in the library - can be invoked at runtime. This build type is available for both the SCM and the UFS Atmosphere - - "Fast" physics - Physical parameterizations that require tighter coupling with the dynamical core than “slow” - physics (due to the approximated processes within the parameterization acting on a shorter - timescale) and that benefit from a smaller time step. The distinction is useful for greater - accuracy, numerical stability, or both. In the UFS Atmosphere, a saturation adjustment is - used in some suites and is called directly from the dynamical core for tighter coupling - - Group - A set of physics schemes within a suite definition file (SDF) that are called together - without intervening computations from the host application - - Group *cap* - Autogenerated interface between a group of physics schemes and the host model. They are used - only in the static CCPP build, and effectively replace the code from *CCPP-Framework* that - provides the flexibility of the dynamic CCPP build - - Host model/application - An atmospheric model that allocates memory, provides metadata for the variables passed into - and out of the physics, and controls time-stepping - - Interstitial scheme - A modularized piece of code to perform data preparation, diagnostics, or other “glue” - functions that allows primary schemes to work together as a suite. They can be categorized - as “scheme-specific” or “suite-level”. Scheme-specific interstitial schemes augment a - specific primary scheme (to provide additional functionality). Suite-level interstitial - schemes provide additional functionality on top of a class of primary schemes, connect - two or more schemes together, or provide code for conversions, initializing sums, or - applying tendencies, for example. - - Multi-suite static CCPP build - A static CCPP build type in which a set of physics suites is specified - at compile time from which one can be chosen at runtime. + FMS + The Flexible Modeling System (FMS) is a software framework for supporting the efficient + development, construction, execution, and scientific interpretation of atmospheric, + oceanic, and climate system models. NEMS The NOAA Environmental Modeling System - a software infrastructure that supports - NCEP/EMC’s forecast products. The coupling software is based on ESMF and the NUOPC layer. + NCEP/EMC’s forecast products. NUOPC The National Unified Operational Prediction Capability is a consortium of Navy, NOAA, @@ -63,7 +30,7 @@ Glossary partners are working toward a common model architecture - a standard way of building models - in order to make it easier to collaboratively build modeling systems. - Parameterization + Parameterization or physics scheme The representation, in a dynamic model, of physical effects in terms of admittedly oversimplified parameters, rather than realistically requiring such effects to be consequences of the dynamics of the system (AMS Glossary) @@ -72,10 +39,6 @@ Glossary Autogenerated interface between an individual physics scheme and the host model. Used only in the dynamic CCPP build - Primary scheme - A parameterization, such as PBL, microphysics, convection, and radiation, that fits the - traditionally-accepted definition, as opposed to an interstitial scheme - PROD Compiler flags used by NCEP for operational runs of the UFS Atmosphere and by EMC for regression tests of the code @@ -83,49 +46,16 @@ Glossary REPRO Compiler flags used by EMC to guarantee reproducibility of the UFS Atmosphere code - Scheme - A CCPP-compliant parameterization (primary scheme) or auxiliary code (interstitial scheme) - - SDF - Suite Definition File (SDF) is an external file containing information about the + Suite Definition File (SDF) + An external file containing information about the construction of a physics suite. It describes the schemes that are called, in which order they are called, whether they are subcycled, and whether they are assembled into groups to be called together - Set - A collection of physics schemes that do not share memory (e.g. fast and slow physics) - - "Slow" physics - Physical parameterizations that can tolerate looser coupling with the dynamical core - than “fast” physics (due to the approximated processes within the parameterization - acting on a longer timescale) and that often use a longer time step. Such parameterizations - are typically grouped and calculated together (through a combination of process- and - time-splitting) in a section of an atmospheric model that is distinct from the dynamical - core in the code organization - - Standard_name - Variable names based on CF conventions (http://cfconventions.org) that are uniquely - identified by the *CCPP-compliant* schemes and provided by a host model - - Static CCPP build - A build type in which the *CCPP-Framework* and the *CCPP-physics* libraries - are statically linked to the executable and only the suites determined at compile time - can be invoked at runtime. This build type is only available for the UFS Atmosphere - - Subcycling - Executing a physics scheme more frequently (with a shorter timestep) than the rest of - the model physics or dynamics - Suite A collection of primary physics schemes and interstitial schemes that are known to work well together - Suite *cap* - Autogenerated interface between an entire suite of physics schemes and the host model. - They are used only in the static CCPP build and consist of calls to autogenerated group - caps. They may be used to call an entire suite at once or to call a specific group within - a physics suite - UFS A Unified Forecast System (UFS) is a community-based, coupled comprehensive Earth system modeling system. The UFS numerical applications span local to global domains @@ -133,14 +63,8 @@ Glossary designed to support the Weather Enterprise and to be the source system for NOAA's operational numerical weather prediction applications - UFS Atmosphere - The atmospheric model component of the UFS. Its fundamental parts are the dynamical - core and the physics - - VLab - Virtual Laboratory - a service and information technology framework, that enables - NOAA employees and their partners to share ideas, collaborate, engage in software - development, and conduct applied research (https://www.nws.noaa.gov/mdl/vlab/) + Weather Model + A prognostic model that can be used for short- and medium-range research and + operational forecasts. It can be an atmosphere-only model or be an atmospheric + model coupled with one or more additional components, such as a wave or ocean model. - .xsd file extension - XML schema definition diff --git a/doc/UsersGuide/source/PlatformSupport.rst b/doc/UsersGuide/source/PlatformSupport.rst deleted file mode 100644 index 0214b013b0..0000000000 --- a/doc/UsersGuide/source/PlatformSupport.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. _PlatformSupport: - -************************* -Platform Support -************************* - -How to set up a generic platform (install compiler, configure). Include all information needed to build the dependencies. - diff --git a/doc/UsersGuide/source/Template.rst b/doc/UsersGuide/source/Template.rst deleted file mode 100644 index caca82cb62..0000000000 --- a/doc/UsersGuide/source/Template.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. _Intro: - -************************* -Intro -************************* - -Text diff --git a/doc/UsersGuide/source/TransitioningFromVLAB.rst b/doc/UsersGuide/source/TransitioningFromVLAB.rst deleted file mode 100644 index be715d56af..0000000000 --- a/doc/UsersGuide/source/TransitioningFromVLAB.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. _TransitioningFromVLAB: - -************************* -Transitioning from VLab -************************* - -How to transition branches from gerrit to GitHub - diff --git a/doc/UsersGuide/source/conf.py b/doc/UsersGuide/source/conf.py index 289d512c96..acb99585c4 100644 --- a/doc/UsersGuide/source/conf.py +++ b/doc/UsersGuide/source/conf.py @@ -20,7 +20,7 @@ # -- Project information ----------------------------------------------------- project = 'UFS Weather Model Developers Guide' -copyright = '2019' +copyright = '2020' author = ' ' # The short X.Y version @@ -140,14 +140,14 @@ def setup(app): # Latex figure (float) alignment # # 'figure_align': 'htbp', - # 'maketitle': r'\newcommand\sphinxbackoftitlepage{For referencing this document please use: \newline \break Schramm, J., L. Bernardet, L. Carson, G. Firl, D. Heinzeller, L. Pan, and M. Zhang, 2019. CCPP Technical Documentation Release v3.0.0. 91pp. Available at https://dtcenter.org/GMTB/v3.0/ccpp\_tech\_guide.pdf.}\sphinxmaketitle' + # 'maketitle': r'\newcommand\sphinxbackoftitlepage{For referencing this document please use: \newline \break Schramm, J., L. Bernardet, L. Carson, G. Firl, D. Heinzeller, L. Pan, and M. Zhang, 2020. UFS Weather Model User's Guide Release v1.0.0. Npp. Available at https://dtcenter.org.}\sphinxmaketitle' } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'CCPPtechnical.tex', 'CCPP Technical Documentation', + (master_doc, 'UFS_WM_Users_Guide.tex', 'UFS Weather Model Users Guide', author,'manual'), ] @@ -157,7 +157,7 @@ def setup(app): # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'CCPPtechnical', 'CCPP Technical Documentation', + (master_doc, 'UFS_WM_Users_Guide', 'UFS Weather Model Users Guide', [author], 1) ] @@ -168,8 +168,8 @@ def setup(app): # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'CCPPtechnical', 'CCPP Technical Documentation', - author, 'CCPPtechnical', 'One line description of project.', + (master_doc, 'UFS_WM_Users_guide', 'UFS Weather Model Users Guide', + author, 'UFS_WM_Users_Guide', 'One line description of project.', 'Miscellaneous'), ] diff --git a/doc/UsersGuide/source/index.rst b/doc/UsersGuide/source/index.rst index 84e2a6df76..784c91c3ed 100644 --- a/doc/UsersGuide/source/index.rst +++ b/doc/UsersGuide/source/index.rst @@ -11,7 +11,6 @@ Welcome to the UFS Weather Model User's Guide :maxdepth: 3 Introduction - PlatformSupport CodeOverview InputsOutputs SDFandNamelistExamplePractices @@ -20,5 +19,5 @@ Welcome to the UFS Weather Model User's Guide CompilingCodeWithoutApp RegTests GitGitHub - TransitioningFromVLAB Glossary + Acronyms From 14311e84eeda79eec4165e6aa6aa1c60ed55e06f Mon Sep 17 00:00:00 2001 From: Julie Schramm Date: Tue, 14 Jan 2020 11:24:34 -0700 Subject: [PATCH 2/2] - Add more acronyms to Acronyms.rst - Add reference to top of Glossary.rst for linking - Add rst version of Introduction.rst from Google Docs --- doc/UsersGuide/source/Acronyms.rst | 9 +++ doc/UsersGuide/source/Glossary.rst | 3 + doc/UsersGuide/source/Introduction.rst | 92 +++++++++++++++++++++++++- doc/UsersGuide/source/index.rst | 3 +- 4 files changed, 102 insertions(+), 5 deletions(-) diff --git a/doc/UsersGuide/source/Acronyms.rst b/doc/UsersGuide/source/Acronyms.rst index e059c04245..d529e7cf4f 100644 --- a/doc/UsersGuide/source/Acronyms.rst +++ b/doc/UsersGuide/source/Acronyms.rst @@ -10,6 +10,9 @@ Acronyms +----------------+---------------------------------------------------+ | Abbreviation | Explanation | +================+===================================================+ + | AOML | NOAA's Atlantic Oceanographic and Meteorological | + | | Laboratory | + +----------------+---------------------------------------------------+ | API | Application Programming Interface | +----------------+---------------------------------------------------+ | b4b | Bit-for-bit | @@ -26,6 +29,8 @@ Acronyms +----------------+---------------------------------------------------+ | ESMF | The Earth System Modeling Framework | +----------------+---------------------------------------------------+ + | ESRL | NOAA Earth System Research Laboratory | + +----------------+---------------------------------------------------+ | FMS | Flexible Modeling System | +----------------+---------------------------------------------------+ | FV3 | Finite-Volume Cubed Sphere | @@ -44,11 +49,15 @@ Acronyms +----------------+---------------------------------------------------+ | NCAR | National Center for Atmospheric Research | +----------------+---------------------------------------------------+ + | NCEP | National Centers for Environmental Predicction | + +----------------+---------------------------------------------------+ | NEMS | National Oceanic and Atmospheric Administration | | | (NOAA) Environmental Modeling System | +----------------+---------------------------------------------------+ | NOAA | National Oceanic and Atmospheric Administration | +----------------+---------------------------------------------------+ + | NSSL | National Severe Storms Laboratory | + +----------------+---------------------------------------------------+ | OpenMP | Open Multi-Processing | +----------------+---------------------------------------------------+ | PBL | Planetary Boundary Layer | diff --git a/doc/UsersGuide/source/Glossary.rst b/doc/UsersGuide/source/Glossary.rst index e5fed54dfb..b01d440a61 100644 --- a/doc/UsersGuide/source/Glossary.rst +++ b/doc/UsersGuide/source/Glossary.rst @@ -1,3 +1,6 @@ +.. _Glossary: + +************************* Glossary ************************* diff --git a/doc/UsersGuide/source/Introduction.rst b/doc/UsersGuide/source/Introduction.rst index ef0584f582..8d341058df 100644 --- a/doc/UsersGuide/source/Introduction.rst +++ b/doc/UsersGuide/source/Introduction.rst @@ -4,10 +4,96 @@ Introduction ************************* -In this documentation you can find information about how to use the ufs-mrweather-app code and how to contribute your development back. +The Unified Forecast System (:term:`UFS`) :term:`Weather Model` (WM) is a prognostic model that can be +used for short- and medium-range research and operational forecasts, as exemplified by +its use in the operational Global Forecast System (GFS) of the National Oceanic and +Atmospheric Administration (NOAA). The UFS WM v1.0 is the first public release of this +software and represents a snapshot of a continuously evolving system undergoing open +development. More information about the UFS can be found in its portal at https://ufscommunity.org/. -Note that the procedures listed here differ from those distributed with the UFS Medium-Range Weather Application public release. The information in this guide is geared toward model developers and code contributors +Key architectural elements of the UFS WM, along with links to external detailed documentation +for those elements, are listed below: -This is how you cite a reference :cite:`Bernardet2018`. +- The Finite-Volume Cubed-Sphere (FV3) dynamical core. + +- The Flexible Modeling System (:term:`FMS`), a software infrastructure used for functions such as + parallelization (https://www.gfdl.noaa.gov/fms/). + +- The Common-Community Physics Package (:term:`CCPP`) library of + physical parameterizations (:term:`Parameterization or physics scheme`) and the + framework to use it with the model + (https://dtcenter.org/community-code/common-community-physics-package-ccpp). + +- The stochastic physics capability, including the Stochastic Kinetic Backscatter Scheme (SKEBS), + the Stochastically Perturbed Parameterization Tendencies (SPPT) scheme, the perturbed boundary + layer humidity (SHUM) scheme, and the cellular automata method. + +- The NOAA Environmental Modeling System (:term:`NEMS`) model driver used to create the main program + (https://docs.google.com/document/d/1-kFhPBf7GBTUd5SaB5D_3OUGX_93pWKP21QgTh4y6ok/edit#heading=h.dah4y9bxn10l). + +- The libraries needed to build the system, such as: + - National Centers for Environmental Prediction (NCEP) Libraries + - Earth System Modeling Framework (ESMF; https://www.earthsystemcog.org/projects/esmf/) + - System libraries + +- The build system used to compile the code and generate the executable. + +- The regression tests used to maintain software integrity as innovations are added. + +For the UFS WM v1.0 release, the following aspects are supported: + +- Global configuration with resolutions of C96 (~100 km), C192 (~50 km), C384 (25 km), and C768 (~13 km) + +- Sixty-four vertical levels at predetermined locations. + +- Two physics suites (:term:`suite`), corresponding to GFS v15.2 (operational at the time of the release) and + GFS v16beta (October 2019 version, in preparation for operational implementation in 2021). + +- Ability to run with or without SKEBS, SPPT, and SHUM. + +- **Ability to initialize from GFS files in Gridded Binary v2 (GRIB2) format for past dates, + starting January 1, 2018, when the preprocessing utility chgres is employed. Dates before + that may work, but are not guaranteed.** + +- Output files in Network Common Data Form (NetCDF) format. + +The GFS v15.2 physics suite uses the following physical parameterization: the Simplified Arakawa Schubert shallow and deep convective schemes, the Geophysical Fluid Dynamics Laboratory (GFDL) microphysics scheme, the Noah Land Surface Model (LSM), the Rapid Radiative Transfer Model for Global Circulation Models (RRTMG) radiation scheme, the hybrid eddy-diffusivity mass-flux (EDMF) planetary boundary layer (PBL) scheme based on the Smagorinsky K theory, and an orographic gravity wave drag (GWD) parameterization. In the GFS v16beta suite, a moist TKE-based EDMF scheme replaces the K-based one and a non-stationary GWD parameterization is added. It should be noted that the public release code reflects the state of development as of the fall of 2019, and therefore the parameterizations contains innovations beyond what is currently in operations. In other words, the GFDL microphysics distributed for use in GFS v15.2 and GFS v16beta is the same scheme and contains development beyond what was transitioned to operations for GFS v15 in June 2019. It should also be noted that further changes are expected to the GFS v16 suite before it is implemented in operations in 2021. + +The UFS WM v1 code is portable and can be used with Linux and Mac operating systems with Intel and GNU compilers. It has been tested in a variety of platforms widely used by atmospheric scientists, such as the NOAA research Hera system, the National Center for Atmospheric Research (NCAR) Cheyenne system, the National Science Foundation Stampede system, and Mac laptops. + +.. note:: + + At this time, the following aspects are unsupported: standalone regional domains, configurations in which a mediator is used to couple the atmospheric model to models of other earth domains (such as ocean, ice, and waves), horizontal resolutions other than the supported ones, different number or placement of vertical levels, physics suites other than GFS v15.2 and GFS v16beta the *cellular automata* stochastic scheme, initialization from sources other than GFS, the use of different file formats for input and output, and the use of the model in different computational platforms. It is expected that the UFS WM supported capabilities will be expanded in future releases. + +It should be noted that the UFS WM is a component of the UFS Medium-Range Weather Application, which also contains pre- and post-processing components, a comprehensive build system, and workflows for configuration and execution of the application. At this time, the UFS WM is only supported to the general community for use as part of the UFS Medium-Range Weather Application. However, those wishing to contribute development to the UFS WM should become familiar with the procedures for running the model as a standalone component and for executing the regression tests to make sure no inadvertent changes to the results have been introduced during the development process. + +Support for the UFS WM is provided through the UFS Forum by the Developmental Testbed Center (DTC) and other groups involved in UFS development, such as NOAA’s Environmental Modeling Center (EMC), NOAA research laboratories (GFDL, NSSL, ESRL, and AOML), and NCAR. UFS users and developers are encouraged not only to post questions, but also to help address questions posted by other members of the community. + +This WM User’s Guide is organized as follows: + +- :numref:`Chapter %s ` (Code Overview) provides a description of the various + code repositories from which source code is pulled and an overview of the directory structure. + +- :numref:`Chapter %s ` (Inputs and Outputs) lists the model inputs and outputs + and has a description of the key files. + +- :numref:`Chapter %s ` (SDF and namelist samples and best practices) + contains a description of the :term:`Suite Definition File (SDF)` and namelists needed to configure the model + for running with the GFS v15.2 and GFS v16beta physics suites. + +- :numref:`Chapter %s ` (FAQ on model configuration) contains information on + miscellaneous topics pertaining to using the model in configurations that differ from the default. + +The next three chapters: + +- :numref:`Chapter %s ` (Contributing development) +- :numref:`Chapter %s ` (Compiling the WM code without an application) +- :numref:`Chapter %s ` (Regression tests for development) + +go beyond the capabilities supported in the public release to cover code management for conducting +development and proposing contributions back to the authoritative code repositories. Finally, +:numref:`Chapters %s ` and :numref:`%s ` contain a list of acronyms and a glossary. + +.. This is how you cite a reference :cite:`Bernardet2018`. .. bibliography:: references.bib diff --git a/doc/UsersGuide/source/index.rst b/doc/UsersGuide/source/index.rst index 784c91c3ed..8d4a5576db 100644 --- a/doc/UsersGuide/source/index.rst +++ b/doc/UsersGuide/source/index.rst @@ -18,6 +18,5 @@ Welcome to the UFS Weather Model User's Guide ContributingDevelopment CompilingCodeWithoutApp RegTests - GitGitHub - Glossary Acronyms + Glossary