Overhaul the GeoClaw meteorological forcing documentation#242
Open
mandli wants to merge 2 commits into
Open
Conversation
Bring the surge/met-forcing docs up to date with the meteorological-forcing refactor (new object model, explicit family/subtype selection, gridded NetCDF forcing, temporal ramps): - met_forcing.rst (new): overview of met forcing, the two forcing families, the Python object model, and a "what's new / migrating" section advertising the new capabilities and noting the Fortran module rename affects only custom Fortran. - storm_module.rst: expand from a single automodule into the full met-forcing Python API reference (surge.storm/track/parametric/gridded/tools plus SurgeData); keep the :ref:`storm_module` label so existing links resolve. - quick_surge.rst: replace the work-in-progress stub with a complete quick start built around the Ike example (run, configure surge_data, build the storm file, plot, switch to gridded forcing, adapt to a new storm); remove the dead link. - setrun_geoclaw.rst: document storm_family/storm_subtype and reframe storm_specification_type as the still-supported legacy selector; add t_ramp_on/t_ramp_off and rotation_override. - surgedata.rst: fix the broken :ref: target and typos, add cross-links and a pointer to the NetCDF gridded workflow. - geoclaw.rst: wire met_forcing and the previously-orphaned storm_module into the toctree. Builds clean with no Sphinx warnings; autodoc resolves against the installed clawpack.geoclaw and the previously-broken surge :ref: targets now resolve. Assisted-by: claude claude-opus-4-8
The topography preprocessing attribute grid table in setrun_geoclaw.rst rendered a docutils "Malformed table" system message (cell borders not aligned). Convert it to a list-table, which is immune to the manual column-alignment failure mode, and add the previously-missing y_shift row (so all eight preprocessing attributes are documented). Assisted-by: claude claude-opus-4-8
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
1 participant
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.
Bring the surge/met-forcing docs up to date with the meteorological-forcing refactor (new object model, explicit family/subtype selection, gridded NetCDF forcing, temporal ramps):
storm_modulelabel so existing links resolve.Builds clean with no Sphinx warnings; autodoc resolves against the installed clawpack.geoclaw and the previously-broken surge :ref: targets now resolve.
Assisted-by: claude claude-opus-4-8