Skip to content

Commit

Permalink
Doc: update links in Introduction of User's Guide (#77)
Browse files Browse the repository at this point in the history
* Remove FAQ chapter until we can populate it (post-release).

* Remove unused chapter

* Fixed link to supported platforms for regression tests.

* Clarify location of documentation to build NCEPLibs. Fix formatting.

* Add ability to initialize from NEMSIO format. Fix formatting issues.

* Multiple updates to documentation. Removed un-used entries from lists of acronyms and glossary, Updated links. Clarified use of 4 supported suites (previousky was 2 suites). General clean up.

* Doc: update links.
  • Loading branch information
junwang-noaa authored Mar 5, 2020
1 parent 3c48e78 commit f62bdc7
Showing 1 changed file with 11 additions and 15 deletions.
26 changes: 11 additions & 15 deletions doc/UsersGuide/source/Introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,28 +14,24 @@ development. More information about the UFS can be found in its portal at https:
Key architectural elements of the UFS WM, along with links to external detailed documentation
for those elements, are listed below:

- The Finite-Volume Cubed-Sphere (FV3) dynamical core (https://noaa-emc.github.io/FV3_Dycore_v1.0/html/index.html).
- `The Finite-Volume Cubed-Sphere (FV3) dynamical core <https://noaa-emc.github.io/FV3_Dycore_ufs-v1.0.0/html/index.html>`_.

- The Flexible Modeling System (:term:`FMS`), a software infrastructure used for functions such as
parallelization (https://www.gfdl.noaa.gov/fms/).
- `The Flexible Modeling System <https://www.gfdl.noaa.gov/fms/>`_ (:term:`FMS`), a software infrastructure used for functions such as
parallelization.

- 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 Common-Community Physics Package <https://dtcenter.org/community-code/common-community-physics-package-ccpp>`_ (:term:`CCPP`), a library of
physical parameterizations and the framework to use it with the model. :term:`Parameterization or physics scheme` is defined here.

- The stochastic physics capability, including the Stochastic Kinetic Backscatter Scheme (SKEBS),
- `The stochastic physics capability <https://stochastic-physics.readthedocs.io/en/ufs-v1.0.0/>`_, 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
(https://stochastic-physics.readthedocs.io/en/ufs-v1.0.0/).
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://noaa-emc.github.io/NEMS_doc/index.html).
- `The NOAA Environmental Modeling System <https://noaa-emc.github.io/NEMS_doc_ufs-v1.0.0/index.html>`_ (:term:`NEMS`) model driver used to create the main program.

- 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
- `National Centers for Environmental Prediction (NCEP) Libraries <https://github.com/NOAA-EMC/NCEPLIBS/wiki>`_
- `Earth System Modeling Framework (ESMF) <https://www.earthsystemcog.org/projects/esmf/>`_
- `External libraries <https://github.com/NOAA-EMC/NCEPLIBS-external/wiki>`_

- The build system used to compile the code and generate the executable.

Expand Down

0 comments on commit f62bdc7

Please sign in to comment.