Skip to content
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.

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

Doc updates from v2.0.0 #96

Merged
merged 5 commits into from
Apr 26, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion doc/Doxyfile.IN
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ PROJECT_NUMBER = "--PROJECT_NUMBER--"
# for a project that appears at the top of each page and should give viewer a
# quick idea about the purpose of the project. Keep the description short.

PROJECT_BRIEF = "This is a living document and may be updated at any time."
#PROJECT_BRIEF = "This is a living document and may be updated at any time."

# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
# in the documentation. The maximum height of the logo should not exceed 55
Expand Down
7 changes: 3 additions & 4 deletions doc/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ The architecture allows for multiple `EARTH_COMP` instances.
NEMS includes atmosphere, ocean, ice, wave, land,
aerosol/chemistry, and hydrologic models, with coupling interface and
utilities based on the
[Earth System Modeling Framework (ESMF)](https://www.earthsystemcog.org/projects/esmf/).
[Earth System Modeling Framework (ESMF)](https://www.earthsystemmodeling.org).
MinsukJi-NOAA marked this conversation as resolved.
Show resolved Hide resolved
The NEMS applications also utilize intreopereability conventions
introduced by the
[National Unified Operational Prediction Capability (NUOPC)](https://www.earthsystemcog.org/projects/nuopc/).
[National Unified Operational Prediction Capability (NUOPC)](https://www.earthsystemmodeling.org/nuopc/).

Key architecture features are:

Expand All @@ -24,8 +24,7 @@ Key architecture features are:

* The NEMS mediator component is an integral part of the NEMS
software. The mediator source code is managed alongside the NEMS
source code, is integrated into the NEMS make system and is built
when the NEMS executable is built.
source code and is built when the NEMS executable is built.

* Component models are treated by NEMS as external
dependencies. Their source code is managed outside of NEMS,
Expand Down
4 changes: 2 additions & 2 deletions doc/cap-doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@ Cap Documentation {#cap-page}
=================

Caps are codes that act as adaptors, enabling models to use
[NUOPC](https://www.earthsystemcog.org/projects/nuopc/)
[NUOPC](https://www.earthsystemmodeling.org/nuopc/)
standard component interfaces. They are called caps because they "sit
on top" of user code and call into it. They contain translations of
native model data structures into ESMF data structures.

For documentation of caps, see the
[Earth System Prediction Suite (ESPS)](https://www.earthsystemcog.org/projects/esps/)
[Earth System Prediction Suite (ESPS)](https://earthsystemprediction.gov/About/ESPS)
site. Find the components on the table on the landing page, and
follow the corresponding Code Access and Documentation link. Not all
listed components have documented caps. The ESPS is a collection of
Expand Down
12 changes: 6 additions & 6 deletions doc/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Introduction to NEMS {#introduction}
====================

The NOAA Environmental Modeling System (NEMS) is the infrastructure
underlying NOAA's [Unified Forecast System (UFS)] (https://ufscommunity.org/) a fully coupled modeling framework 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)
Expand Down Expand Up @@ -42,14 +42,14 @@ in others it may be the Modular Ocean Model (MOM).
Infrastructure
--------------

[NEMS is built using the Earth System Modeling Framework (ESMF)](https://www.earthsystemcog.org/projects/esmf/)
NEMS is built using the [Earth System Modeling Framework (ESMF)](https://www.earthsystemmodeling.org)
infrastructure software. ESMF provides utilities like generation of
interpolation weights and utilities for calendar and timee management,
interpolation weights and utilities for calendar and time management,
and also wrappers that create a standard component calling
interface. This enables model components developed at different sites
to be coupled more easily.

[The National Unified Operational Prediction Capability (NUOPC) Layer] (https://earthsystemcog.org/projects/nuopc/)
The [National Unified Operational Prediction Capability (NUOPC) Layer] (https://earthsystemmodeling.org/nuopc/)
adds additional rules about how ESMF models interact and increases
their interoperability. The NUOPC Layer covers aspects from the level
of build dependencies, to standardization of initialization phases,
Expand All @@ -70,7 +70,7 @@ as the Global Ensemble Forecast System (GEFS).
Coupled NEMS includes atmosphere, ocean, ice, wave, land,
aerosol/chemistry, and hydrologic models, with coupling interface and
utilities based on the
[Earth System Modeling Framework (ESMF)](https://www.earthsystemcog.org/projects/esmf/).
[Earth System Modeling Framework (ESMF)](https://www.earthsystemmodeling.org).
The NEMS applications also utilize intreopereability conventions
introduced by the
[National Unified Operational Prediction Capability (NUOPC)](https://www.earthsystemcog.org/projects/nuopc/).
[National Unified Operational Prediction Capability (NUOPC)](https://www.earthsystemmodeling.org/nuopc/).
12 changes: 4 additions & 8 deletions doc/nemsmain.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,15 @@ 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), which forms the back bone of the Unified Forecast System (UFS).
[NOAA Environmental Modeling System (NEMS)](https://www.emc.ncep.noaa.gov/emc/pages/infrastructure/nems.php), which forms the backbone of the Unified Forecast System (UFS).
NEMS coupling infrastructure is based on the
[Earth System Modeling Framework (ESMF)](http://www.earthsystemmodeling.org/)
and
[National Unified Operational Prediction Capability (NUOPC)](https://www.earthsystemcog.org/projects/nuopc/)
Layer code and conventions. The software is under active development,
and is incorporating atmosphere, ocean, ice, wave and other models. The
coupled system will be used for weather and longer range predictions.
[National Unified Operational Prediction Capability (NUOPC)](https://www.earthsystemmodeling.org/nuopc/)
Layer code and conventions. The software incorporates atmosphere, ocean, ice, wave and other models. The coupled system will be used for weather and longer range predictions.

Everything in this doxgen-generated webpage is created from files
within the NEMS repository. That documentation is versioned with the
code -- every time the code is updated, we update the documentation to
match. Further information outside this website can be found in links
within the NEMS repository. Further information outside this website can be found in links
within the above paragraph.

* @subpage documentation
2 changes: 1 addition & 1 deletion doc/prep_inputs.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ def main():
project_name='NEMS App '+app_name
else:
#project_number=nems_loc+'@'+nems_rev
project_number='Version 1.1.0'
project_number='Version 2.0.0'
project_name=NEMS_PROJECT_NAME

with open('Doxyfile','wt') as dw:
Expand Down