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.

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

Doc updates #37

Merged
merged 2 commits into from
Jan 27, 2020
Merged

Doc updates #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5209ec6
Remove placeholder chapter for Regression Tests. Add content to chapt…
ligiabernardet Jan 27, 2020
760e4da
Improve directory description. Change URL for FMS authoritative repos…
ligiabernardet Jan 27, 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
11 changes: 5 additions & 6 deletions doc/UsersGuide/source/CodeOverview.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down
11 changes: 1 addition & 10 deletions doc/UsersGuide/source/ContributingDevelopment.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
1 change: 0 additions & 1 deletion doc/UsersGuide/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,5 @@ Welcome to the UFS Weather Model User's Guide
FAQforModelConfiguration
ContributingDevelopment
CompilingCodeWithoutApp
RegTests
Acronyms
Glossary