ESCOMP / ESCOMP/CAM-SIMA

Need to document and comment SIMA grid/map routines inherited from CAM.

Open
#488 0 comments 0 reactions 0 assignees View on GitHub
code clean-up documentation
Dominant language
No language data
Stars
9
Forks
22
Avg merge
8d 5h
Merged PRs (30d)
4

Description

### Issue Type

Documentation Update

### Issue Description

CAM-SIMA inherited a large number of Fortran modules, DDTs, and subroutines designed to handle various model grids, and their mappings to various PIO decompositions. While they seem to generally work fine, the original developers who created them have left, and recent experience has found that it is somewhat difficult to understand what everything does, and what the correct course of action is when something new needs to be added.

Thus it would be good at some point for an engineer to sit down and closely examine what all this code is doing, and to add comments and documentation so that any future work will be easier to implement, especially for new developers who are generally unfamiliar with this part of the model.

### Will this change answers?

No

### Will you be implementing this yourself?

Any Software Engineer can do this

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.