Repository navigation
docs: list the UFS-Coastal files nos-utils generates - #77
Merged
Merged
Conversation
…ngth, coupling interval, nest.ww3 gating)
7 tasks done
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Documents the UFS-Coastal inputs that nos-utils generates for the DATM-coupled configurations. The docs mentioned UFS support only in passing; they now list each file and the module that writes it.
README.md: a new "UFS-Coastal files" section with a table of what each file holds and which module writes it:
datm_forcing.ncdatm_esmf_mesh.ncmodel_configure,datm_inanddatm.streamsufs.configure(PET bounds andrunSeqcoupling interval)fd_ufs.yamlandnoahmptable.tblnest.ww3docs/ufs_coastal.rst: a new page with the same table and more detail:
It is added to the toctree after the usage page.
docs/index.rst: the UFS feature bullet lists the files and links to the new page.
Type of change
Change characteristics
How has this been tested?
pip install .[docs]): no new warnings, and the new page's cross-references resolve.ufs_config.py,esmf_mesh.py,blender.py,datm_writer.py,wave_boundary.pyandorchestrator.pyby an independent review.Checklist