Merge pull request #12 from ligiabernardet/doc_updates

Documentation branch: UFS Weather Model Users Guide
ufs-community · Nov 26, 2019 · d2a7720 · d2a7720
2 parents 17dd303 + 5f494dc
commit d2a7720
Show file tree

Hide file tree

Showing 24 changed files with 141 additions and 23 deletions.
diff --git a/doc/DevGuide/source/index.rst b/doc/DevGuide/source/index.rst
diff --git a/doc/DevGuide/Makefile → doc/UsersGuide/Makefile b/doc/DevGuide/Makefile → doc/UsersGuide/Makefile
diff --git a/doc/DevGuide/README.md → doc/UsersGuide/README.md b/doc/DevGuide/README.md → doc/UsersGuide/README.md
diff --git a/doc/DevGuide/build/.gitignore → doc/UsersGuide/build/.gitignore b/doc/DevGuide/build/.gitignore → doc/UsersGuide/build/.gitignore
diff --git a/doc/DevGuide/make.bat → doc/UsersGuide/make.bat b/doc/DevGuide/make.bat → doc/UsersGuide/make.bat
diff --git a/doc/DevGuide/requirements.txt → doc/UsersGuide/requirements.txt b/doc/DevGuide/requirements.txt → doc/UsersGuide/requirements.txt
diff --git a/doc/UsersGuide/source/CodeOverview.rst b/doc/UsersGuide/source/CodeOverview.rst
@@ -0,0 +1,7 @@
+.. _CodeOverview:
+
+*************************
+Code Overview
+*************************
+
+Description of directories and files from repository
diff --git a/doc/UsersGuide/source/CompilingCodeWithoutApp.rst b/doc/UsersGuide/source/CompilingCodeWithoutApp.rst
@@ -0,0 +1,7 @@
+.. _CompilingCodeWithoutApp:
+
+*********************************
+Compiling the Code without an App
+*********************************
+
+How to build the code using compile.sh and not CIME
diff --git a/doc/UsersGuide/source/ContributingDevelopment.rst b/doc/UsersGuide/source/ContributingDevelopment.rst
@@ -0,0 +1,16 @@
+.. _ContributingDevelopment:
+
+*************************
+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
+
diff --git a/doc/UsersGuide/source/FAQforModelConfiguration.rst b/doc/UsersGuide/source/FAQforModelConfiguration.rst
@@ -0,0 +1,12 @@
+.. _FAQforModelConfiguration:
+
+***************************
+FAQ for Model Configuration
+***************************
+
+* How do I add a new field to the output file?
+
+* What is a “cold start” and a “warm start”?
+
+* How do I restart the model?
+
diff --git a/doc/UsersGuide/source/GitGitHub.rst b/doc/UsersGuide/source/GitGitHub.rst
@@ -0,0 +1,7 @@
+.. _GitGitHub:
+
+***********************************
+Learning How to Use git and GitHub
+***********************************
+
+Links to external resources
diff --git a/doc/DevGuide/source/Glossary.rst → doc/UsersGuide/source/Glossary.rst b/doc/DevGuide/source/Glossary.rst → doc/UsersGuide/source/Glossary.rst
diff --git a/doc/UsersGuide/source/InputsOutputs.rst b/doc/UsersGuide/source/InputsOutputs.rst
@@ -0,0 +1,17 @@
+.. _InputsOutputs:
+
+*************************
+Inputs and Outputs
+*************************
+
+* List of the inputs and outputs of the executable, including SDF, namelists, diag/field, tables, fix files,  ICs/BCs, stdout
+
+* Detailed description of 
+
+* SDF
+
+* Namelists (can have links to namelist description elsewhere)
+
+* Field table
+
+* Diag table 
diff --git a/doc/DevGuide/source/Introduction.rst → doc/UsersGuide/source/Introduction.rst b/doc/DevGuide/source/Introduction.rst → doc/UsersGuide/source/Introduction.rst
diff --git a/doc/UsersGuide/source/PlatformSupport.rst b/doc/UsersGuide/source/PlatformSupport.rst
@@ -0,0 +1,8 @@
+.. _PlatformSupport:
+
+*************************
+Platform Support
+*************************
+
+How to set up a generic platform (install compiler, configure). Include all information needed to build the dependencies.
+
diff --git a/doc/DevGuide/source/BuildRun.rst → doc/UsersGuide/source/RegTests.rst b/doc/DevGuide/source/BuildRun.rst → doc/UsersGuide/source/RegTests.rst
@@ -1,15 +1,25 @@
-.. _BuildingRunningHostModels:
+.. _RegTests:
 
-****************************************
-Building and Running the UFS Weather Model
-****************************************
+******************************************
+Regression Tests for Development
+******************************************
 
-.. _UFSAtmo:
+* Motivation
 
-UFS Atmosphere
-====================
+* Description of the default tests
+
+* Directory structure for inputs and outputs
+
+* How to run a subset of tests
+
+* Baselines: existing baselines, creating new baselines, comparing against a new baseline
+
+* Running regression tests
+
+* Checking the results
+
+* Adding a regression test
 
-Another option for a CCPP host model is the UFS Atmosphere, located in the umbrella repository NEMSfv3gfs.
 
 System Requirements, Libraries, and Compilers
 ---------------------------------------------

diff --git a/doc/UsersGuide/source/SDFandNamelistExamplePractices.rst b/doc/UsersGuide/source/SDFandNamelistExamplePractices.rst
@@ -0,0 +1,10 @@
+.. _SDFandNamelistExamplePractices:
+
+********************************************
+SDF and Namelist Best Practices and Examples
+********************************************
+
+* GFS v15 configuration for four supported resolutions
+
+* GFS v16 beta configuration for four supported resolutions
+
diff --git a/doc/UsersGuide/source/Template.rst b/doc/UsersGuide/source/Template.rst
@@ -0,0 +1,7 @@
+.. _Intro:
+
+*************************
+Intro
+*************************
+
+Text
diff --git a/doc/UsersGuide/source/TransitioningFromVLAB.rst b/doc/UsersGuide/source/TransitioningFromVLAB.rst
@@ -0,0 +1,8 @@
+.. _TransitioningFromVLAB:
+
+*************************
+Transitioning from VLab
+*************************
+
+How to transition branches from gerrit to GitHub
+
diff --git a/doc/DevGuide/source/_static/README → doc/UsersGuide/source/_static/README b/doc/DevGuide/source/_static/README → doc/UsersGuide/source/_static/README
diff --git a/doc/DevGuide/source/_templates/README → doc/UsersGuide/source/_templates/README b/doc/DevGuide/source/_templates/README → doc/UsersGuide/source/_templates/README
diff --git a/doc/DevGuide/source/conf.py → doc/UsersGuide/source/conf.py b/doc/DevGuide/source/conf.py → doc/UsersGuide/source/conf.py
diff --git a/doc/UsersGuide/source/index.rst b/doc/UsersGuide/source/index.rst
@@ -0,0 +1,24 @@
+.. UFS Weather Model Users Guide, created by
+   sphinx-quickstart on Tue Oct 29 09:07:29 2019.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to the UFS Weather Model User's Guide
+========================================================
+
+.. toctree::
+   :numbered:
+   :maxdepth: 3
+
+   Introduction
+   PlatformSupport
+   CodeOverview
+   InputsOutputs
+   SDFandNamelistExamplePractices
+   FAQforModelConfiguration
+   ContributingDevelopment
+   CompilingCodeWithoutApp
+   RegTests
+   GitGitHub
+   TransitioningFromVLAB
+   Glossary
diff --git a/doc/DevGuide/source/references.bib → doc/UsersGuide/source/references.bib b/doc/DevGuide/source/references.bib → doc/UsersGuide/source/references.bib