Merge pull request #11 from pjpegion/ufs_public_release

Ufs public release

.travis.yml

@@ -1,6 +1,16 @@
 # This will run on Travis' 'new' container-based infrastructure
 sudo: false 
 
+before_install:
+    - wget http://repo.continuum.io/miniconda/Miniconda-latest-Linux-x86_64.sh -O miniconda.sh
+    - chmod +x miniconda.sh
+    - "./miniconda.sh -b"
+    - export PATH=/home/travis/miniconda2/bin:$PATH
+    - conda update --yes conda
+
+install:
+    - conda install --yes sphinx
+
 # Blacklist
 branches:
   only:
@@ -22,13 +32,21 @@ addons:
 
 # Build your code e.g. by calling make
 script:
-  - doxygen
+    - doxygen
+    - pushd docs
+#   Use Sphinx to make the html docs
+    - make html
+#   Tell GitHub not to use jekyll to compile the docs
+    - touch build/html/.nojekyll
+    - popd
 
 # Generate and deploy documentation
+before_deploy:
+    - cp -r html docs/build/html/doxygen
 deploy:
   provider: pages
   skip_cleanup: true
-  local_dir: html
+  local_dir: docs/build/html
   github_token: $GH_REPO_TOKEN
   on:
     branch: ufs_public_release

docs/source/developers_guide.rst

@@ -1,13 +1,14 @@
 Developer's guide
 =================
 
-Code is housed on github at https://github.com/noaa-psd/stochastic_physics
+Code is housed on github at https://github.com/noaa-psd/stochastic_physics.
 
-please make a fork
+please make a fork and checkout the entire ufs-community weather model at https://github.com/ufs-community/ufs-weather-model and point to your fork of the stochastic_physics submodule.
 
-TBD:  standalone testing
-
-TBD: running regression test
-
-TBD: using gitflow
+Standalone testing
+""""""""""""""""""
+If you intend to make modifications to the stochastic physics source code, there is a simplified program that exercises the random pattern generator without needing to run the entire model.  Please see README.standalone in the stochastic_physics directory.
 
+Full model tests
+""""""""""""""""
+The code updates are not expected to change existing results, so the full model regression tests need to be run.  All of the tests must pass, although only a sub-set of tests are needed to consider adding changes to the stochastic_physics repository: fv3_control, fv3_stochy, fv3_ccpp_control, and fv3_ccpp_stochy.  If the results are expected to change, then there needs to be scientific evidience that the change in results are what is expected.  

docs/source/index.rst

@@ -14,5 +14,5 @@ Welcome to UFS stochastic physics's documentation!
 Source Code Documentation
 ==========================
 
-Doxygen generated `content <https://pjpegion.github.io/stochastic_physics/index.html>`_
+Doxygen generated `content <https://pjpegion.github.io/stochastic_physics/doxygen/index.html>`_
 

main.doc

@@ -30,5 +30,5 @@
  * \subsection step2 2: build the ufs-weather-model   
  * >build the system
  *
- * etc...
+ * follow the CMAKE build instructions
  */