Skip to content

Add Documentation on New NetCDF Input in GeoClaw#240

Open
mandli wants to merge 8 commits into
clawpack:devfrom
mandli:add-netcdf-docs
Open

Add Documentation on New NetCDF Input in GeoClaw#240
mandli wants to merge 8 commits into
clawpack:devfrom
mandli:add-netcdf-docs

Conversation

@mandli
Copy link
Copy Markdown
Member

@mandli mandli commented Apr 16, 2026

Adds a user and developer guide to the new netCDF capabilities in GeoClaw. Also modifies some existing documentation to clarify tool use regarding netCDF. This is tied to the clawpack/geoclaw#701.

mandli added 3 commits April 16, 2026 09:24
Adds both user and developer level documentation.  Need to still fix
references to this document.
mandli and others added 5 commits April 17, 2026 19:27
Some of the less common cases are now handled better with auto-detection
of variables and better support for time offsets.
Mostly just ignores build and doctree
… storm_time_scale

- netcdf.rst: rename all TopoInterrogator/MetInterrogator/NetCDFInterrogator
  references to TopoInspector/MetInspector/NetCDFInspector, rename
  met_interrogator parameter to met_inspector, rename test file stubs
  to match (test_base_inspector.py etc.)
- netcdf_utils_module.rst: new Sphinx automodule page covering
  NetCDFInspector, TopoInspector, MetInspector, CFNormalizer, DescriptorWriter
- geoclaw.rst: add netcdf and netcdf_utils_module to the toctree so
  both the user guide and API reference are reachable from the GeoClaw index
- setrun_geoclaw.rst: document the new storm_time_scale parameter

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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