From f62bdc797470ea61c31606a3e54aa9a13dee1079 Mon Sep 17 00:00:00 2001 From: junwang-noaa <37633869+junwang-noaa@users.noreply.github.com> Date: Thu, 5 Mar 2020 13:56:14 -0500 Subject: [PATCH] Doc: update links in Introduction of User's Guide (#77) * 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. --- doc/UsersGuide/source/Introduction.rst | 26 +++++++++++--------------- 1 file changed, 11 insertions(+), 15 deletions(-) diff --git a/doc/UsersGuide/source/Introduction.rst b/doc/UsersGuide/source/Introduction.rst index 2cdd026ab0..39e652d275 100644 --- a/doc/UsersGuide/source/Introduction.rst +++ b/doc/UsersGuide/source/Introduction.rst @@ -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 `_. -- 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 `_ (: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 `_ (: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 `_, 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 `_ (: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 `_ + - `Earth System Modeling Framework (ESMF) `_ + - `External libraries `_ - The build system used to compile the code and generate the executable.