From 5671e7b8ed404592698e3df54cb3aab76acc5f53 Mon Sep 17 00:00:00 2001 From: gspetro-NOAA Date: Mon, 5 Aug 2024 13:30:04 -0400 Subject: [PATCH] update docs w/changes from PR #129 --- .../BuildingRunningTesting/BuildRunLandDA.rst | 17 ++++++++++------- doc/source/CustomizingTheWorkflow/DASystem.rst | 2 +- 2 files changed, 11 insertions(+), 8 deletions(-) diff --git a/doc/source/BuildingRunningTesting/BuildRunLandDA.rst b/doc/source/BuildingRunningTesting/BuildRunLandDA.rst index afd12b56..ee31daa5 100644 --- a/doc/source/BuildingRunningTesting/BuildRunLandDA.rst +++ b/doc/source/BuildingRunningTesting/BuildRunLandDA.rst @@ -4,10 +4,7 @@ Land DA Workflow (Hera & Orion) ************************************ -This chapter provides instructions for building and running basic Land DA cases for the Unified Forecast System (:term:`UFS`) Land DA System. Users can choose between two supported options: - - * A Jan. 3-4, 2000 00z sample case using :term:`GSWP3` data with the UFS Noah-MP land component - * A Dec. 21-22, 2019 00z sample case using :term:`ERA5` data with the UFS Land Driver +This chapter provides instructions for building and running basic Land DA cases for the Unified Forecast System (:term:`UFS`) Land DA System using a Jan. 3-4, 2000 00z sample case using :term:`GSWP3` data with the UFS Noah-MP land component. .. attention:: @@ -18,15 +15,22 @@ This chapter provides instructions for building and running basic Land DA cases Create a Working Directory ***************************** -Create a directory for the Land DA experiment (``$LANDDAROOT``): +Create a base directory for the Land DA experiment and navigate into it: .. code-block:: console mkdir /path/to/landda cd /path/to/landda + +where ``/path/to/landda`` is the path to the directory where the user plans to run Land DA experiments. In the experiment configuration file, this directory is referred to as ``$EXP_BASEDIR``. + +Optionally, users can save this directory path in an environment variable (e.g., ``$LANDDAROOT``) to avoid typing out full path names later. + +.. code-block:: console + export LANDDAROOT=`pwd` -where ``/path/to/landda`` is the path to the directory where the user plans to run Land DA experiments. In the experiment configuration file, ``$LANDDAROOT`` is referred to as ``$EXP_BASEDIR``. +In this documentation, ``$LANDDAROOT`` is used, but users are welcome to choose another name for this variable if they prefer. .. _GetCode: @@ -122,7 +126,6 @@ Users will need to configure certain elements of their experiment in ``land_anal * ``ACCOUNT:`` A valid account name. Hera, Orion, and most NOAA RDHPCS systems require a valid account name; other systems may not (in which case, any value will do). * ``EXP_BASEDIR:`` The full path to the directory where land-DA_workflow was cloned (i.e., ``$LANDDAROOT``) - * ``FORCING:`` Forcing options; ``gswp3`` or ``era5`` * ``cycledef/spec:`` Cycle specification .. note:: diff --git a/doc/source/CustomizingTheWorkflow/DASystem.rst b/doc/source/CustomizingTheWorkflow/DASystem.rst index 02c8b237..dd4d6a85 100644 --- a/doc/source/CustomizingTheWorkflow/DASystem.rst +++ b/doc/source/CustomizingTheWorkflow/DASystem.rst @@ -654,7 +654,7 @@ Prior to ingesting the GHCN IODA files via the LETKF at the DA analysis time, th Restart Files ================ -To restart the UFS land driver successfully after land model execution, all parameters, states, and fluxes used for a subsequent time iteration are stored in a restart file. This restart file is named ``ufs_land_restart.${FILEDATE}.nc`` where ``FILEDATE`` is in YYYY-MM-DD_HH-mm-SS format (e.g., ``ufs_land_restart.2019-12-21_00-00-00.nc``). The restart file contains all the model fields and their values at a specific point in time; this information can be used to restart the model immediately to run the next cycle. The Land DA System reads the states from the restart file and replaces them after the DA step with the updated analysis. :numref:`Table %s ` lists the fields in the Land DA restart file. Within the UFS land driver (submodule ``ufs-land-driver-emc-dev``), read/write of the restart file is performed in ``ufsLandNoahMPRestartModule.f90``. +To restart the Land DA System successfully after land model execution, all parameters, states, and fluxes used for a subsequent time iteration are stored in a restart file. This restart file is named ``ufs_land_restart.${FILEDATE}.tile#.nc`` where ``FILEDATE`` is in YYYY-MM-DD_HH-mm-SS format and ``#`` is 1-6 (e.g., ``ufs_land_restart.2000-01-05_00-00-00.tile1.nc``). The restart file contains all the model fields and their values at a specific point in time; this information can be used to restart the model immediately to run the next cycle. The Land DA System reads the states from the restart file and replaces them after the DA step with the updated analysis. :numref:`Table %s ` lists the fields in the Land DA restart file. .. _RestartFiles: