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.

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

[develop]: PI13 Documentation Update #127

Merged
merged 53 commits into from
Aug 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
53 commits
Select commit Hold shift + click to select a range
acce91b
update intro w/code additions since v1.2.0
gspetro-NOAA Jun 14, 2024
332fe05
Merge branch 'develop' of https://github.com/ufs-community/land-DA_wo…
gspetro-NOAA Jun 14, 2024
56b4483
update tech overview dir structure
gspetro-NOAA Jul 2, 2024
c12eb3b
add info on manual vs auto submission
gspetro-NOAA Jul 2, 2024
f2639fd
several misc changes
gspetro-NOAA Jul 5, 2024
4db3bc4
add plotting info
gspetro-NOAA Jul 8, 2024
bf343fa
update plotting info
gspetro-NOAA Jul 8, 2024
9ea7ce7
add plot images, add extlinks, misc other
gspetro-NOAA Jul 9, 2024
e45555a
add Rocoto chapter, misc edits
gspetro-NOAA Jul 10, 2024
02f3246
rm workflow section in DA chapter
gspetro-NOAA Jul 11, 2024
5c8a82d
add misc
gspetro-NOAA Jul 11, 2024
323e795
minor conf.py updates
gspetro-NOAA Jul 11, 2024
a48cfea
add ConfigWorkflow chapter
gspetro-NOAA Jul 11, 2024
071cad1
explain task parameters & configuration
gspetro-NOAA Jul 12, 2024
ddccaf9
update testing ch
gspetro-NOAA Jul 16, 2024
76f3968
update glossary
gspetro-NOAA Jul 16, 2024
786d6fd
add configworkflow chapter
gspetro-NOAA Jul 16, 2024
69ee11b
update file paths & misc in Model ch
gspetro-NOAA Jul 16, 2024
12ccb8b
misc minor update in Model ch
gspetro-NOAA Jul 16, 2024
778ecd5
Update DA ch
gspetro-NOAA Jul 17, 2024
21ae278
Update letkf_land.yaml info
gspetro-NOAA Jul 17, 2024
03692d2
fix broken intersphinx link
gspetro-NOAA Jul 17, 2024
3df81b1
update jedi doc version
gspetro-NOAA Jul 17, 2024
ed9465a
DA ch updates
gspetro-NOAA Jul 17, 2024
065c15e
misc minor edits
gspetro-NOAA Jul 17, 2024
6dcb318
Merge branch 'ufs-community:develop' into text/us-215
gspetro-NOAA Jul 18, 2024
e783edf
update wflow dir structure diagram
gspetro-NOAA Jul 19, 2024
1363c92
Merge branch 'text/us-215' of github.com:gspetro-NOAA/land-DA_workflo…
gspetro-NOAA Jul 19, 2024
fcdbc36
update wflow dir structure diagram
gspetro-NOAA Jul 19, 2024
9e2e891
add new chapters to introduction
gspetro-NOAA Jul 24, 2024
0fa3832
misc minor Intro edits
gspetro-NOAA Jul 24, 2024
422fbe7
misc tech overview edits
gspetro-NOAA Jul 25, 2024
38e4273
misc tech overview updates
gspetro-NOAA Jul 25, 2024
a959756
rm uw from hierarchical repo structure?
gspetro-NOAA Jul 25, 2024
818bbb6
update table 1.1
gspetro-NOAA Jul 25, 2024
8f7b1e5
update L1 Build/Run ch
gspetro-NOAA Jul 25, 2024
bc19c48
L1 Build/Run ch minor/misc updates
gspetro-NOAA Jul 25, 2024
fa4342b
update container chapter
gspetro-NOAA Jul 25, 2024
0544826
misc minor edits
gspetro-NOAA Jul 25, 2024
f885141
ConfigWorkflow updates
gspetro-NOAA Jul 29, 2024
b3f19c0
minor updates to reference chs
gspetro-NOAA Jul 29, 2024
0ebe51b
minor misc fixes
gspetro-NOAA Jul 29, 2024
fa0b8b0
minor misc updates
gspetro-NOAA Jul 30, 2024
f56d91c
update docs w/changes from PR #129
gspetro-NOAA Aug 5, 2024
a9b0bac
update docs w/changes from PR #129
gspetro-NOAA Aug 5, 2024
5671e7b
update docs w/changes from PR #129
gspetro-NOAA Aug 5, 2024
ac1804e
rm mention of 2019 case
gspetro-NOAA Aug 5, 2024
6c5d384
remove ERA5 model input file section
gspetro-NOAA Aug 8, 2024
f689823
rm vector2tile info
gspetro-NOAA Aug 8, 2024
818be75
add info on grid description files to DA chapter/IODA section
gspetro-NOAA Aug 8, 2024
e98cb6e
rm run without rocoto section
gspetro-NOAA Aug 8, 2024
a492e38
update wording re: landdaroot
gspetro-NOAA Aug 8, 2024
418761d
Merge branch 'ufs-community:develop' into text/us-215
gspetro-NOAA Aug 8, 2024
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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# UFS Offline Land Data Assimilation System

The Unified Forecast System (UFS) is a community-based, coupled, comprehensive Earth modeling system. It is designed to be the source system for NOAA's operational numerical weather prediction applications while enabling research, development, and contribution opportunities for the broader Weather Enterprise. For more information about the UFS, visit the UFS Portal at https://ufscommunity.org/.
The Unified Forecast System (UFS) is a community-based, coupled, comprehensive Earth modeling system. It is designed to be the source system for NOAA's operational numerical weather prediction applications while enabling research, development, and contribution opportunities for the broader Weather Enterprise. For more information about the UFS, visit the UFS Portal at https://ufs.epic.noaa.gov/.

The UFS includes [multiple applications](https://ufscommunity.org/science/aboutapps/) that support different forecast durations and spatial domains. This repository hosts the source code for the UFS Land Data Assimilation (DA) System. Land DA is an offline version of the Noah Multi-Physics (Noah-MP) land surface model (LSM) used in the UFS Weather Model (WM). Its data assimilation framework uses the Joint Effort for Data assimilation Integration (JEDI) software stack, which includes the Object-Oriented Prediction System (OOPS) for the data assimilation algorithm, the Interface for Observation Data Access (IODA) for observation formatting and processing, and the Unified Forward Operator (UFO) for comparing model forecasts and observations.

Expand Down
42 changes: 21 additions & 21 deletions doc/source/BackgroundInfo/Introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,21 @@ Introduction
****************

This User's Guide provides guidance for running the Unified Forecast System
(:term:`UFS`) offline Land Data Assimilation (DA) System. Land DA is an offline version of the Noah Multi-Physics (Noah-MP) land surface model (LSM) used in the `UFS Weather Model <https://github.com/ufs-community/ufs-weather-model>`__ (WM). Its data assimilation framework uses
the Joint Effort for Data assimilation Integration (:term:`JEDI`) software. The offline UFS Land DA System currently only works with snow data.
(:term:`UFS`) offline Land Data Assimilation (DA) System. Land DA is an offline version of the Noah Multi-Physics (Noah-MP) land surface model (LSM) used in the `UFS Weather Model <https://github.com/ufs-community/ufs-weather-model>`_ (WM). Its data assimilation framework uses
the Joint Effort for Data assimilation Integration (:term:`JEDI`) software. Currently, the offline UFS Land DA System only works with snow data.
Thus, this User's Guide focuses primarily on the snow DA process.

Since the last release, developers have added a variety of features:
Since the |latestr| release, the following capabilities have been added to the Land DA System:

* Integration of the UFS Noah-MP land component into the Land DA System for use as an alternative to the Common Community Physics Package (:term:`CCPP`) Noah-MP LSM land driver
* Model forcing options for use with the UFS land component:

* Provided a new analysis option in the cubed-sphere native grid using :term:`GSWP3` forcing
* Established global land grid-point consistency with the head of the UFS WM baseline test cases (New global land grid point is changed from 18360 to 18322.)
* Added a new sample configuration file (``settings_DA_cycle_gswp3``)
* Included a new ECMWF :term:`ERA5` reanalysis forcing option in the existing vector-to-tile conversion analysis process

* CTest suite upgrades --- the ERA5 CTests now test the operability of seven major components of Land DA: vector2tile, create_ens, letkfoi_snowda, apply_jediincr, tile2vector, land_driver, and UFS datm_land.
* Upgrade of JEDI :term:`DA <data assimilation>` framework to use JEDI Skylab v4.0 (`PR #28 <https://github.com/ufs-community/land-DA_workflow/pull/28>`__)
* Updates to sample datasets for the release (see the `Land DA data bucket <https://registry.opendata.aws/noaa-ufs-land-da/>`__)
* Singularity/Apptainer container (``ubuntu20.04-intel-landda-release-public-v1.2.0``) updates to support the changes described above
* Documentation updates to reflect the changes above
* Added cycled run capability (:land-wflow-repo:`PR #101 <pull/101/>`)
* Provide automated run option using cron (:land-wflow-repo:`PR #110 <pull/110>`)
* Added analysis plotting task (:land-wflow-repo:`PR #107 <pull/107>`)
* Upgraded to JEDI Skylab v7.0 (:land-wflow-repo:`PR #92 <pull/92/>`)
* Upgraded to spack-stack v1.6.0 (:land-wflow-repo:`PR #102 <pull/102>`)
* Extended container support (:land-wflow-repo:`PR #85 <pull/85>`)
* Updated directory structure for NCO compliance (:land-wflow-repo:`PR #75 <pull/75>`)
* Removed land driver from CTest (:land-wflow-repo:`PR #123 <pull/123>`)
gspetro-NOAA marked this conversation as resolved.
Show resolved Hide resolved
* Removed land-driver and vector2tile (:land-wflow-repo:`PR #129 <pull/129>`)

The Land DA System citation is as follows and should be used when presenting results based on research conducted with the Land DA System:

Expand All @@ -37,8 +33,8 @@ This User's Guide is organized into four sections: (1) *Background Information*;

Background Information
========================
* This chapter (Introduction) provides background information on the Unified Forecast System (:term:`UFS`) and the NoahMP model.
* :numref:`Chapter %s <TechOverview>` (Technical Overview) outlines prerequisites, user support levels, and directory structure.
* This chapter (Introduction) provides user support information and background information on the Unified Forecast System (:term:`UFS`) and the Noah-MP model.
* :numref:`Chapter %s <TechOverview>` (Technical Overview) outlines prerequisites, supported systems, and directory structure.

Building, Running, and Testing the Land DA System
===================================================
Expand All @@ -50,12 +46,15 @@ Building, Running, and Testing the Land DA System
Customizing the Workflow
=========================

* :numref:`Chapter %s: Model <Model>` provides information on input data and configuration parameters in the Noah-MP LSM and its Vector-to-Tile Converter.
* :numref:`Chapter %s: Available Workflow Configuration Parameters <ConfigWorkflow>` explains all of the user-configurable options currently available in the workflow configuration file (``land_analysis*.yaml``).
* :numref:`Chapter %s: Model <Model>` provides information on input data and configuration parameters in the Noah-MP LSM.
* :numref:`Chapter %s: DA Framework <DASystem>` provides information on the DA system, required data, and configuration parameters.

Reference
===========

* :numref:`Chapter %s: Rocoto <RocotoInfo>` provides background information on the Rocoto workflow manager as used in Land DA.
* :numref:`Chapter %s: FAQ <FAQ>` addresses frequently asked questions.
* :numref:`Chapter %s: Glossary <Glossary>` lists important terms.

User Support and Documentation
Expand Down Expand Up @@ -85,10 +84,11 @@ If users (especially new users) believe they have identified a bug in the system
Feature Requests and Enhancements
==================================

Users who want to request a feature enhancement or the addition of a new feature have two options:
Users who want to request a feature enhancement or the addition of a new feature have a few options:

#. File a `GitHub Issue <https://github.com/ufs-community/land-DA_workflow/issues/new>`__ and add (or request that a code manager add) the ``EPIC Support Requested`` label.
#. Post a request for a feature or enhancement in the `Enhancements <https://github.com/ufs-community/land-DA_workflow/discussions/categories/enhancements>`__ category of GitHub Discussions. These feature requests will be forwarded to the Earth Prediction Innovation Center (`EPIC <https://epic.noaa.gov/>`__) management team for prioritization and eventual addition to the Land DA System.
#. Email the request to support.epic@noaa.gov.


.. _Background:
Expand Down Expand Up @@ -131,7 +131,7 @@ The Noah-MP LSM has evolved through community efforts to pursue and refine a mod

Noah-MP has been implemented in the UFS via the :term:`CCPP` physics package and
is currently being tested for operational use in GFSv17 and RRFS v2. Additionally, the UFS Weather Model now contains a Noah-MP land component. Noah-MP has
also been used operationally in the NOAA National Water Model (NWM) since 2016. Details about the model's physical parameterizations can be found in :cite:t:`NiuEtAl2011` (2011).
also been used operationally in the NOAA National Water Model (NWM) since 2016. Details about the model's physical parameterizations can be found in :cite:t:`NiuEtAl2011` (2011), and a full description of the model is available in the `Community Noah-MP Land Surface Modeling System Technical Description Version 5.0 <https://opensky.ucar.edu/islandora/object/technotes:599>`_.

Disclaimer
*************
Expand Down
Loading
Loading