Skip to content

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

@nusbaume

Description

@nusbaume

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    code clean-upMade code simpler, better, and/or easier to read.documentationImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions