Skip to content

Commit

Permalink
Updates to the documentation (#35)
Browse files Browse the repository at this point in the history
  • Loading branch information
arunchawla-NOAA authored Mar 2, 2020
1 parent b7b7585 commit 63d8808
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 7 deletions.
10 changes: 9 additions & 1 deletion doc/configuring.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,15 @@ There are a number of format options for each line:
supported values of the connection options is documented in the
NUOPC reference manual.

Here is an example of a run sequence specification with two time scales:
A very simple run sequence is running only the atmospheric uncoupled model.
The run sequence looks like:

# Run Sequence #
runSeq::
ATM
::

A more complex example is when components are exchanging information at two time scales:

# Run Sequence #
runSeq::
Expand Down
9 changes: 4 additions & 5 deletions doc/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,23 @@ Introduction to NEMS {#introduction}
====================

The NOAA Environmental Modeling System (NEMS) is the infrastructure
underlying a **coupled modeling system** that supports predictions of
underlying NOAA's [Unified Forecast System (UFS)] (https://ufscommunity.org/) a fully coupled modeling framework that supports predictions of
Earth's environment at a range of time scales. Examples of other
coupled modeling systems are the
[Community Earth System Model (CESM)](http://www.cesm.ucar.edu)
and the
[Met Office Unified Model] (http://www.metoffice.gov.uk/research/modelling-systems/unified-model)

NEMS includes infrastructure for coupling model components
representing major Earth system domains and processes.
**A model component** is a software representation of a physical
domain or process, for example sea ice. It is often developed by a
team of specialists in that domain. Model coupling is a software
representation of feedbacks between physical processes. It involves
modifying the exported fields of a component through grid, unit,
temporal, and other transformations so that they can be used as the
inputs for another component.
inputs for another component. These components are managed through repositories, primarily on GitHub.

NEMS includes infrastructure for coupling model components
representing major Earth system domains and processes. **External
model components** have a primary repository on GitHub.
In general, model components are
coupled through the NEMS mediator (in other coupled modeling systems
this is often called the "coupler"). NEMS also includes some
Expand Down
2 changes: 1 addition & 1 deletion doc/nemsmain.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ NEMS Documentation

This website describes the coupling infrastructure and
techniques used in the
[NOAA Environmental Modeling System (NEMS)](https://www.emc.ncep.noaa.gov/emc/pages/infrastructure/nems.php).
[NOAA Environmental Modeling System (NEMS)](https://www.emc.ncep.noaa.gov/emc/pages/infrastructure/nems.php) which forms the back bone of the Unified Forecast System (UFS).
NEMS coupling infrastructure is based on the
[Earth System Modeling Framework (ESMF)](http://www.earthsystemmodeling.org/)
and
Expand Down

0 comments on commit 63d8808

Please sign in to comment.