Skip to content

Update links and version numbers from 1.0.0 to 1.1.0 #187

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
JulieSchramm merged 5 commits into from
Sep 1, 2020
Merged

Update links and version numbers from 1.0.0 to 1.1.0 #187

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f73034c
Update links and version numbers from 1.0.0 to 1.1.0
Aug 18, 2020
023dd57
Fix tag name of CCPP Scientific Documentation from 4.1 to 4.1.0.
Aug 19, 2020
dffaced
Change CCPP Scientific Documentation from v4.1 to v4.1.0
Aug 20, 2020
c6fa9c4
Merge branch 'release/public-v1' into feature/update_links
Aug 31, 2020
5da81a4
Remove Chapter 6 (Contributing Development)
Aug 31, 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
2 changes: 0 additions & 2 deletions doc/UsersGuide/source/Acronyms.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,6 @@ Acronyms
| RRTMG | Rapid Radiative Transfer Model for Global |
| | Circulation Models |
+----------------+---------------------------------------------------+
| RT | Regression test |
+----------------+---------------------------------------------------+
| SAS | Simplified Arakawa-Schubert |
+----------------+---------------------------------------------------+
| SDF | Suite Definition File |
Expand Down
16 changes: 8 additions & 8 deletions doc/UsersGuide/source/BuildingAndRunning.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@ There are two categories of libraries that are needed:
Most have an NCEPLIBS prefix in the repository, e.g. NCEPLIBS-bacio. Select tools from the UFS
Utilities repository (UFS-UTILS) are also included in this category. A list of the bundled
libraries tested with this WM release is in the top-level ``README`` of the `NCEPLIBS repository
<https://github.com/NOAA-EMC/NCEPLIBS/tree/ufs-v1.0.0>`_ (**be sure to look at the tag in that repository that
<https://github.com/NOAA-EMC/NCEPLIBS/tree/ufs-v1.1.0>`_ (**be sure to look at the tag in that repository that
matches the tag on this WM release**).

#. Third-party libraries (NCEPLIBS-external). These are libraries that were developed external to
the UFS Weather Model. They are general software packages that are also used by other models in
the community. Building these is optional, since existing builds of these libraries can be pointed
to instead. A list of the external libraries tested with this WM release is in the top-level ``README``
of the `NCEPLIBS-external repository <https://github.com/NOAA-EMC/NCEPLIBS-external/tree/ufs-v1.0.0>`_. Again, be
of the `NCEPLIBS-external repository <https://github.com/NOAA-EMC/NCEPLIBS-external/tree/ufs-v1.1.0>`_. Again, be
sure to look at the tag in that repository that matches the tag on this WM release.

.. note::
Expand All @@ -34,16 +34,16 @@ to build NCEPLIBS and NCEPLIBS-external or are working on a system that is alrea
pre-configured platforms, the libraries are already available.

If you do have to build the libraries, it is a good idea to check the platform- and compiler-specific
``README`` files in the doc/ directory of the `NCEPLIBS-external repository <https://github.com/NOAA-EMC/NCEPLIBS-external/tree/ufs-v 1.0.0>`_
``README`` files in the doc/ directory of the `NCEPLIBS-external repository <https://github.com/NOAA-EMC/NCEPLIBS-external/tree/ufs-v 1.1.0>`_
as a first step, to see if your system or one similar to it is included. These files have detailed
instructions for building NCEPLIBS-external, NCEPLIBS, and the UFS Weather Model. They may be all the
documentation you need. Be sure to use the tag that corresponds to this version of the WM, and define a
WORK directory path before you get started.

If your platform is not included in these platform- and compiler-specific ``README`` files, there is a more
generic set of instructions in the ``README`` file at the top level of the `NCEPLIBS-external repository
<https://github.com/NOAA-EMC/NCEPLIBS-external/tree/ufs-v 1.0.0>`_, and at the top level of the `NCEPLIBS repository
<https://github.com/NOAA-EMC/NCEPLIBS/tree/ufs-v 1.0.0>`_. It may still be a good idea to look at some of the platform-
<https://github.com/NOAA-EMC/NCEPLIBS-external/tree/ufs-v1.1.0>`_, and at the top level of the `NCEPLIBS repository
<https://github.com/NOAA-EMC/NCEPLIBS/tree/ufs-v1.1.0>`_. It may still be a good idea to look at some of the platform-
and compiler-specific ``README`` files as a guide. Again, be sure to use the tag that corresponds to this version of the WM.

The top-level ``README`` in the NCEPLIBS-external repository includes a troubleshooting section that may be helpful.
Expand All @@ -57,13 +57,13 @@ set up specifically for issues related to build dependencies.
Downloading the Weather Model Code
==================================

To clone the ufs-weather-model repository for this v1.0.0 release, execute the following commands:
To clone the ufs-weather-model repository for this v1.1.0 release, execute the following commands:

.. code-block:: console

git clone https://github.com/ufs-community/ufs-weather-model.git ufs-weather-model
cd ufs-weather-model
git checkout ufs-v1.0.0
git checkout ufs-v1.1.0
git submodule update --init --recursive

Compiling the model will take place within the `ufs-weather-model` directory you just created.
Expand Down Expand Up @@ -149,7 +149,7 @@ If you are not running on one of the pre-configured platforms, you will need to
in a different way.

If you used one of the platform- and compiler-specific ``README`` files in the ``doc/`` directory of NCEPLIBS-external
to build the prerequisite libraries, there is a script in the ``NCEPLIBS-ufs-v1.0.0/bin`` directory called
to build the prerequisite libraries, there is a script in the ``NCEPLIBS-ufs-v1.1.0/bin`` directory called
``setenv_nceplibs.sh`` that will set the NCEPLIBS-external variables for you.

Of course, you can also set the values of these variables yourself if you know where the paths are on your system.
Expand Down
129 changes: 0 additions & 129 deletions doc/UsersGuide/source/ContributingDevelopment.rst
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion doc/UsersGuide/source/FAQ.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ How do I build and run a single test of the UFS Weather Model?

An efficient way to build and run the UFS Weather Model is to use the regression test
(``rt.sh``). This script is widely used by model developers on Tier 1 and 2 platforms
and is described in :numref:`Section %s <ConductingRegTests>`. The advantages to this approach are:
and is described in the UFS WM GitHub `wiki <https://github.com/ufs-community/ufs-weather-model/wiki/Making-code-changes-in-the-UFS-weather-model-and-its-subcomponents>`_. The advantages to this approach are:

- It does not require a workflow, pre- or post-processing steps.
- The batch submission script is generated.
Expand Down
6 changes: 3 additions & 3 deletions doc/UsersGuide/source/InputNML.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@ physics options are chosen.

The following link describes the various physics-related namelist records:

https://dtcenter.org/GMTB/v4.0/sci_doc/CCPPsuite_nml_desp.html
https://dtcenter.org/GMTB/v4.1.0/sci_doc/CCPPsuite_nml_desp.html

The following link describes the stochastic physics namelist records:

https://stochastic-physics.readthedocs.io/en/ufs-v1.0.0/namelist_options.html
https://stochastic-physics.readthedocs.io/en/release-ufs-v1.1.0/namelist_options.html
Copy link
Copy Markdown
Collaborator

@ligiabernardet ligiabernardet Aug 19, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two lines above there is a link to https://dtcenter.org/GMTB/v4.0/sci_doc/CCPPsuite_nml_desp.html that needs to be updated to v4.1.1


The following link describes some of the other namelist records (dynamics, grid, etc):

https://www.gfdl.noaa.gov/wp-content/uploads/2017/09/fv3_namelist_Feb2017.pdf
https://noaa-emc.github.io/FV3_Dycore_ufs-v1.1.0/html/index.html

The namelist section ``&interpolator_nml`` is not used in this release, and any modifications to
it will have no effect on the model results.
Expand Down
Loading