Skip to content

Initial commit for converting UFS WM UG to rst. #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ligiabernardet merged 2 commits into from
Jan 15, 2020
Merged

Initial commit for converting UFS WM UG to rst. #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4925844
- Update Glossary.rst
Jan 14, 2020
14311e8
- Add more acronyms to Acronyms.rst
Jan 14, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
98 changes: 98 additions & 0 deletions doc/UsersGuide/source/Acronyms.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
.. _Acronyms:

*************************
Acronyms
*************************

.. table::
:widths: 20 80

+----------------+---------------------------------------------------+
| Abbreviation | Explanation |
+================+===================================================+
| AOML | NOAA's Atlantic Oceanographic and Meteorological |
| | Laboratory |
+----------------+---------------------------------------------------+
| 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 |
+----------------+---------------------------------------------------+
| ESRL | NOAA Earth System Research Laboratory |
+----------------+---------------------------------------------------+
| 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 |
+----------------+---------------------------------------------------+
| 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 |
+----------------+---------------------------------------------------+
| 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 |
+----------------+---------------------------------------------------+
7 changes: 0 additions & 7 deletions doc/UsersGuide/source/GitGitHub.rst
View file
Open in desktop

This file was deleted.

103 changes: 15 additions & 88 deletions doc/UsersGuide/source/Glossary.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. _Glossary:

*************************
Glossary
*************************

Expand All @@ -14,47 +17,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,
Expand All @@ -63,7 +33,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)
Expand All @@ -72,75 +42,32 @@ 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

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
and predictive time scales from sub-hourly analyses to seasonal predictions. It is
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
Loading