Skip to content

Improve documentation for dynamic lapse-rate generation workflows #1839

Description

@Kristen-M-Whitney

Summary

Improve the documentation for the dynamic lapse-rate generation workflow by expanding the README and script header to better describe the supported production workflows and the published Cascade–Sierra dynamic lapse-rate dataset accompanying Whitney et al. (2025).

Proposed Changes

  • Expand the README documentation for:
    • NLDAS-3 retrospective forcing generation
    • NLDAS-3 near-real-time forcing generation
    • the Whitney et al. (2025) Cascade–Sierra workflow
  • Clarify where dynamic lapse-rate magnitude constraints are applied for each workflow (during dynamic lapse-rate generation versus within the downstream LIS meteorological downscaling workflow).
  • Add documentation describing the published Cascade–Sierra dynamic lapse-rate dataset archived on Zenodo.
  • Add a reproducible example command for generating the Whitney et al. (2025) dynamic lapse-rate dataset.
  • Expand the compute_dynamic_lapse_rates.py header with an additional usage example documenting the Whitney et al. (2025) workflow and referencing the associated Zenodo dataset.
  • Improve documentation describing use of the --clip_to_reference_bbox option and generation of an equivalent reference grid using the Land Data Toolkit (LDT).

Motivation

These changes improve reproducibility by clarifying the relationship between the dynamic lapse-rate generation script, the NLDAS-3 forcing-generation workflows, and the published Cascade–Sierra dynamic lapse-rate dataset. The updated documentation also provides users with a documented workflow for reproducing the methodology presented in Whitney et al. (2025) while directing users to the archived Zenodo dataset when regeneration of the dataset is not required.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions