diff --git a/docs/UsersGuide/source/BackgroundInfo/Introduction.rst b/docs/UsersGuide/source/BackgroundInfo/Introduction.rst index 0766b32a2b..0ec3c42486 100644 --- a/docs/UsersGuide/source/BackgroundInfo/Introduction.rst +++ b/docs/UsersGuide/source/BackgroundInfo/Introduction.rst @@ -140,9 +140,6 @@ A list of available component documentation is shown in :numref:`Table %s `__ tools. -.. COMMENT: Anything we should add to this list? Or remove? - .. bibliography:: ../references.bib diff --git a/docs/UsersGuide/source/BuildingRunningTesting/RunSRW.rst b/docs/UsersGuide/source/BuildingRunningTesting/RunSRW.rst index f5a5858b7a..9d2b288109 100644 --- a/docs/UsersGuide/source/BuildingRunningTesting/RunSRW.rst +++ b/docs/UsersGuide/source/BuildingRunningTesting/RunSRW.rst @@ -382,10 +382,10 @@ Next, users should edit the new ``config.yaml`` file to customize it for their m EXPT_SUBDIR: test_community task_get_extrn_ics: USE_USER_STAGED_EXTRN_FILES: true - EXTRN_MDL_SOURCE_BASEDIR_ICS: /path/to/UFS_SRW_App/v2p2/input_model_data///${yyyymmddhh} + EXTRN_MDL_SOURCE_BASEDIR_ICS: /path/to/UFS_SRW_data/v2p2/input_model_data///${yyyymmddhh} task_get_extrn_lbcs: USE_USER_STAGED_EXTRN_FILES: true - EXTRN_MDL_SOURCE_BASEDIR_LBCS: /path/to/UFS_SRW_App/v2p2/input_model_data///${yyyymmddhh} + EXTRN_MDL_SOURCE_BASEDIR_LBCS: /path/to/UFS_SRW_data/v2p2/input_model_data///${yyyymmddhh} where: * ``MACHINE`` refers to a valid machine name (see :numref:`Section %s ` for options). @@ -468,8 +468,8 @@ The ``ufs-srweather-app/parm/wflow`` directory contains several ``YAML`` files t - SRW-AQM pre-processing tasks * - coldstart.yaml - Tasks required to run a cold-start forecast - * - da_data_preproc.yaml - - Preprocessing tasks for RRFS `DA `. + * - default_workflow.yaml + - Sets the default workflow (prep.yaml, coldstart.yaml, post.yaml) * - plot.yaml - Plotting tasks * - post.yaml @@ -766,10 +766,10 @@ Users who have already staged the observation data needed for METplus (i.e., the .. code-block:: console platform: - CCPA_OBS_DIR: /path/to/UFS_SRW_App/v2p2/obs_data/ccpa/proc - NOHRSC_OBS_DIR: /path/to/UFS_SRW_App/v2p2/obs_data/nohrsc/proc - MRMS_OBS_DIR: /path/to/UFS_SRW_App/v2p2/obs_data/mrms/proc - NDAS_OBS_DIR: /path/to/UFS_SRW_App/v2p2/obs_data/ndas/proc + CCPA_OBS_DIR: /path/to/UFS_SRW_data/v2p2/obs_data/ccpa/proc + NOHRSC_OBS_DIR: /path/to/UFS_SRW_data/v2p2/obs_data/nohrsc/proc + MRMS_OBS_DIR: /path/to/UFS_SRW_data/v2p2/obs_data/mrms/proc + NDAS_OBS_DIR: /path/to/UFS_SRW_data/v2p2/obs_data/ndas/proc After adding the VX tasks to the ``rocoto:`` section and the data paths to the ``platform:`` section, users can proceed to generate the experiment, which will perform VX tasks in addition to the default workflow tasks. diff --git a/docs/UsersGuide/source/conf.py b/docs/UsersGuide/source/conf.py index 3b6d9d2926..a581d0e410 100644 --- a/docs/UsersGuide/source/conf.py +++ b/docs/UsersGuide/source/conf.py @@ -20,7 +20,7 @@ # -- Project information ----------------------------------------------------- -project = 'UFS Short-Range Weather App Users Guide' +project = 'UFS Short-Range Weather App User\'s Guide' copyright = '2020, ' author = ' ' diff --git a/docs/UsersGuide/source/index.rst b/docs/UsersGuide/source/index.rst index 52937c81ae..6c092d9a28 100644 --- a/docs/UsersGuide/source/index.rst +++ b/docs/UsersGuide/source/index.rst @@ -3,8 +3,8 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -UFS Short-Range Weather App Users Guide -======================================= +UFS Short-Range Weather App User's Guide (|version|) +===================================================== .. toctree:: :numbered: diff --git a/docs/UsersGuide/source/tables/Tests.csv b/docs/UsersGuide/source/tables/Tests.csv index 33b0016e41..5f57bea933 100644 --- a/docs/UsersGuide/source/tables/Tests.csv +++ b/docs/UsersGuide/source/tables/Tests.csv @@ -24,7 +24,7 @@ yes,yes,grid_RRFS_CONUS_25km_ics_NAM_lbcs_NAM_suite_GFS_v16,RRFS_CONUS_25km,FV3_ ,yes,grid_RRFS_CONUS_13km_ics_FV3GFS_lbcs_FV3GFS_suite_GFS_v16_plot,RRFS_CONUS_13km,FV3_GFS_v16,FV3GFS,FV3GFS,2019070100,6,27,18, ,yes,grid_RRFS_CONUS_13km_ics_FV3GFS_lbcs_FV3GFS_suite_HRRR,RRFS_CONUS_13km,FV3_HRRR,FV3GFS,FV3GFS,2019070100,6,27,20, ,yes,grid_RRFS_CONUS_13km_ics_FV3GFS_lbcs_FV3GFS_suite_RRFS_v1beta,RRFS_CONUS_13km,FV3_RRFS_v1beta,FV3GFS,FV3GFS,2019070100,6,27,20, -,yes,grid_RRFS_CONUS_25km_ics_FV3GFS_lbcs_FV3GFS_suite_GFS_2017_gfdlmp,RRFS_CONUS_25km,FV3_GFS_2017_gfdlmp,FV3GFS,FV3GFS,2019070112 2019070200,6,39,24, +,yes,grid_RRFS_CONUS_25km_ics_FV3GFS_lbcs_FV3GFS_suite_RAP,RRFS_CONUS_25km,FV3_RAP,FV3GFS,FV3GFS,2019070112 2019070200,6,39,24, ,yes,grid_RRFS_CONUS_25km_ics_FV3GFS_lbcs_FV3GFS_suite_GFS_v16,RRFS_CONUS_25km,FV3_GFS_v16,FV3GFS,FV3GFS,2019070100,6,5,23, ,yes,grid_RRFS_CONUS_25km_ics_FV3GFS_lbcs_FV3GFS_suite_HRRR,RRFS_CONUS_25km,FV3_HRRR,FV3GFS,FV3GFS,2019070100,6,15,30, ,yes,grid_RRFS_CONUS_25km_ics_FV3GFS_lbcs_FV3GFS_suite_RRFS_v1beta,RRFS_CONUS_25km,FV3_RRFS_v1beta,FV3GFS,FV3GFS,2019070100,6,12,34,