NCAR / NCAR/CESM-Tutorial

References to CESM2 should be updated to CESM3

Open
#412 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Jupyter Notebook
Stars
29
Forks
36
PR merge metrics
No merged PRs in 30d

Description

Doing a git grep of CESM2 or cesm2 there are a ton of references that should be updated.

Some of those are explained by this caveat

"CESM3 documentation is still under development. Therefore, throughout this tutorial we will occasionally refer to CESM2 documentation and examples. While some details may differ between CESM2 and CESM3, the overall approach to finding, understanding, and modifying namelist variables remains the same."

But, it seems like any examples that are using the new code base should reference CESM3 rather than CESM2. So there's probably some changes that can be made. And of course after CESM3 documentation is out all the references can be updated.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by running git grep for CESM2 and cesm2 across the tutorial. Review each match in context, keeping references covered by the stated documentation caveat while updating examples that use the new code base. Done means applicable CESM2 references are changed to CESM3 without removing the caveat where it remains accurate.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.