search

ESCOMP / CISM-wrapper

Community Ice Sheet Model wrapper for CESM
http://www.cesm.ucar.edu/models/cesm2.0/land-ice/
Other
3 stars 15 forks source link

Add documentation on multiple ice sheets #74

Closed billsacks closed 6 months ago

billsacks commented 2 years ago

This is a documentation-only PR, adding documentation on running with multiple ice sheets. (There are small changes in buildnml, but only to comments in that file.)

I have:

  1. Modified existing documentation to add notes about running with multiple ice sheets
  2. Added a new appendix on what is needed to add a new ice sheet (note: it's possible that I am missing some pieces here; I figure we can fill this in with anything missing whenever someone first attempts to follow these instructions and runs into trouble)

I have built and pushed the documentation to the official documentation site (figuring there is little harm in updating this documentation with this draft version, even if we need to push a fixed version later): see https://escomp.github.io/cism-docs/cism-in-cesm/versions/master/html/index.html and especially the new section, https://escomp.github.io/cism-docs/cism-in-cesm/versions/master/html/new-icesheet.html . Besides the entirely new section, it might be helpful to skim through the changes in this PR to get a sense of where I made changes, but then actually look at the new documentation in the built documentation (which will be easier to read than the diffs in the source rst files).

@whlipscomb @gunterl @Katetc - I have added you all as reviewers in case you want to give this a formal review before I merge it to master. I'm happy to iterate with you to get the new documentation into a state where it's clear to others. But I'll leave it up to you as to whether you actually want to review this before I merge it; feel free to remove yourself as a reviewer if you don't feel a need to.

billsacks commented 2 years ago

@Katetc @gunterl @whlipscomb I just noticed that this documentation PR is still open. Do any of you want to review it, or should I go ahead and merge it?

billsacks commented 7 months ago

@Katetc @gunterl @whlipscomb pinging again on this. Please let me know if you'd like to look this over or if I should just hit merge.

billsacks commented 6 months ago

@Katetc gave me the go-ahead to merge this. Doing so now....