Skip to content

docs: list the UFS-Coastal files nos-utils generates - #77

Merged
MansurJisan-NCO merged 3 commits into
mainfrom
docs/ufs-files
Oct 20, 2026
Merged

MansurJisan-NCO merged 3 commits into
mainfrom
docs/ufs-files

Conversation

@MansurJisan-NCO

Copy link
Copy Markdown
Collaborator

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.nc
    • datm_esmf_mesh.nc
    • model_configure, datm_in and datm.streams
    • ufs.configure (PET bounds and runSeq coupling interval)
    • fd_ufs.yaml and noahmptable.tbl
    • nest.ww3
  • docs/ufs_coastal.rst: a new page with the same table and more detail:

    • the template tokens;
    • the shared start-time anchor that keeps the CMEPS clock in step;
    • WW3 runtime files are static fix files and are not generated.

    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

  • Maintenance (refactor, cleanup, CI, comments)

Change characteristics

  • Changes outputs (values, COMOUT files or names, archives)? NO
  • Breaking change to existing functionality? NO
  • Requires a nos-utils submodule bump (nos-workflow) or a paired nos-workflow change (nos-utils)? NO
  • Requires new or regenerated fix files on the machine? NO
  • Requires a re-prep or a new hotstart before the next cycle? NO
  • Machines affected: none (docs only)

How has this been tested?

  • Sphinx build with a Read the Docs-style install (pip install .[docs]): no new warnings, and the new page's cross-references resolve.
  • Every statement was checked against ufs_config.py, esmf_mesh.py, blender.py, datm_writer.py, wave_boundary.py and orchestrator.py by an independent review.

Checklist

  • Dependent PRs merged and published (nos-utils before any submodule bump)
  • pytest suite passes
  • Existing operational behavior preserved, or the change is called out above
  • No edits to a shared FIXofs while it is cycling
  • Self-review done; yaml comments and docstrings updated where behavior changed
  • No markdown files added to the repo (this template is the only exception)

@MansurJisan-NCO
MansurJisan-NCO merged commit 4ed896a into main Oct 20, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant