Documentation for CESM2 release

未关闭
#12 15 条评论 0 个 reaction 已指派 2 人 在 GitHub 查看

@gunterl 已经在做这个了。

开始于 2018年5月7日。

评估

这个 Issue 还没有评估数据。

描述

documentation

This issue documents things needed for the cism-in-cesm documentation for the cesm2 release.

  • Rewrite chapter 1 (introduction) - Gunter (with help from Bill L, Bill S)

  • Chapter 2 (quick start) - Bill S

    • Rewrite overview
    • For the most part, point to CESM quick start and/or cime documentation
    • Keep modifying namelist settings, rewrite as needed
    • Keep modifying source code... talk about modifying in-source vs. SourceMods, and the two different places for SourceMods to go
    • Point out specific things useful for LIWG
      • One-way vs. two-way coupling
  • New chapter on developing and modifying CISM

    • Add a section on directory structure (taken from current chapter 4) - Bill S
    • Move the "simulating the Greenland ice sheet" section from the current chapter 4 to there - Gunter
  • Add a section on grids (rewritten from the section in the current chapter 4) - Bill S (with help from others)

    • Point to wiki page on new CISM grid. Update 2018-05-31: Maybe move that wiki page into the user's guide... in that case, maybe make grids its own chapter.
    • Note need for glacier region to be consistent in CLM: need to have virtual columns and melt_replaced_by_ice in the CISM domain
  • Chapter 3 (TG compsets) - Bill S

  • Chapter 4 (the dynamic ice sheet model) - Gunter

    • May cut the description of the dynamic ice sheet model (4.1) entirely, just pointing to the full CISM documentation
    • However, we want to keep the "coupling to CLM" section, but move this to a separate chapter (see below)
    • Also keep description of different directories, but move to quick start guide (Bill S)
    • Keep some description of time steps - Gunter
  • Chapter 5 (ice sheets in the community land model, and coupling) - Bill L with help from Bill S

    • Rework what's there, and/or point to CLM documentation
    • Include remapping between CISM and CLM - Bill L
    • Add other fields sent from CISM - Bill S / Bill L
  • Chapter 6 (FAQ) - cut this for now; can add things back in later as needed (note that they'll need documentation for the new code)

    • But see below: move some of this into a new chapter on output
  • New chapter on controlling output from cism and clm

    • Add a section on input/output (rewritten from the section in the current chapter 4) - Bill S
    • Move the old 6.7 and 6.8 here
  • Chapter 7 (acknowledgements) - Bill L

  • Chapter 8 (references) - Gunter and Bill L


Other things we want to mention somewhere:

  • Need to set restart=0 when doing a hybrid run where you have changed cisminputfile to point to a restart file from a standalone case, or a case with different physics (Laura Muntjewerf's issue August, 2018)
主要语言
Fortran
星标
4
派生
18
平均合并
3 天 17 小时
30 天内合并 PR
1

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

ESCOMP/CISM-wrapper 的其他 Issue

查看 ESCOMP/CISM-wrapper 的全部 Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。