From 5209ec6be6e2760d99bc54c5fdf8846c09de9884 Mon Sep 17 00:00:00 2001 From: "ligia.bernardet" Date: Sun, 26 Jan 2020 21:23:03 -0700 Subject: [PATCH 1/2] Remove placeholder chapter for Regression Tests. Add content to chapter for Contributing Development explaining that it is under development. At this time, the chapter on Contributing Development contains information abojut RTs but those can be separated later. --- doc/UsersGuide/source/ContributingDevelopment.rst | 11 +---------- doc/UsersGuide/source/index.rst | 1 - 2 files changed, 1 insertion(+), 11 deletions(-) diff --git a/doc/UsersGuide/source/ContributingDevelopment.rst b/doc/UsersGuide/source/ContributingDevelopment.rst index 1f7a985969..db2551a79d 100644 --- a/doc/UsersGuide/source/ContributingDevelopment.rst +++ b/doc/UsersGuide/source/ContributingDevelopment.rst @@ -4,13 +4,4 @@ Contributing Development ************************* -* Overview; big picture - -* Opening issues - -* Description of development workflow (fork, branch, commit, test, PR submission, review) - -* What are the requirements for a code to be accepted? - -* What platforms are supported - +This chapter is being developed here: https://github.com/ufs-community/ufs-weather-model/pull/32 diff --git a/doc/UsersGuide/source/index.rst b/doc/UsersGuide/source/index.rst index 8d4a5576db..0c3b4d2604 100644 --- a/doc/UsersGuide/source/index.rst +++ b/doc/UsersGuide/source/index.rst @@ -17,6 +17,5 @@ Welcome to the UFS Weather Model User's Guide FAQforModelConfiguration ContributingDevelopment CompilingCodeWithoutApp - RegTests Acronyms Glossary From 760e4daaa205febd8c9497ef07d7daf294592dbb Mon Sep 17 00:00:00 2001 From: "ligia.bernardet" Date: Sun, 26 Jan 2020 21:29:39 -0700 Subject: [PATCH 2/2] Improve directory description. Change URL for FMS authoritative repository. --- doc/UsersGuide/source/CodeOverview.rst | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/doc/UsersGuide/source/CodeOverview.rst b/doc/UsersGuide/source/CodeOverview.rst index e01d2e5c91..9155e6b8a9 100644 --- a/doc/UsersGuide/source/CodeOverview.rst +++ b/doc/UsersGuide/source/CodeOverview.rst @@ -21,7 +21,7 @@ The ufs-weather-model repository supports the short- and medium-range UFS applic * - Umbrella repository for the UFS Weather Model - https://github.com/ufs-community/ufs-weather-model * - Infrastructure: Flexible Modeling System - - https://github.com/NOAA-EMC/FMS + - https://github.com/NOAA-GFDL/FMS * - Infrastructure: NOAA Environmental Modeling System - https://github.com/NOAA-EMC/NEMS * - Infrastructure: add description @@ -68,7 +68,7 @@ When the ufs-weather-model is cloned, the basic directory structure will be simi ufs-weather-model/ ├── cmake --------- cmake configuration files ├── compsets --------- configurations used by some regression tests - ├── conf --------- unused + ├── conf --------- compile options for Tier 1 and 2 platforms ├── doc --------- READMEs with build, reg-test hints ├── FMS --------- The Flexible Modeling System (FMS),a software framework ├── FV3 --------- FV3 atmosphere model @@ -84,13 +84,12 @@ When the ufs-weather-model is cloned, the basic directory structure will be simi │ │ ├── physics -------- CCPP compliant physics schemes │ │ └── suites -------- CCPP physics suite definition files (SDFs) │ ├── cpl -------- Coupling field data structures - │ ├── gfsphysics -------- unused - IPD version of physics codes + │ ├── gfsphysics │ │ ├── CCPP_layer │ │ ├── GFS_layer - │ │ └── physics - │ ├── io --------- nemsio code + │ │ └── physics --------- unused - IPD version of physics codes + │ ├── io --------- FV3 write grid comp code │ ├── ipd --------- unused - IPD driver/interfaces - │ ├── test --------- unused ├── log --------- log files from NEMS compset regression tests ├── modulefile --------- system module files for supported HPC systems ├── NEMS --------- NOAA Earth Modeling System framework