ESCOMP / ESCOMP/CDEPS

Documentation fixes

Open
#130 3 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Fortran
Stars
32
Forks
68
Avg merge
5d 13h
Merged PRs (30d)
2

Description

A few things found when reviewing the CDEPS docs at:
https://escomp.github.io/CDEPS/html/index.html

## Section 2.1

> An input data stream is a time-series of input data files where all the fields in the stream are located *in the same data file*

but later in that section:

> The data for one stream may be all in one file or may be spread over several files.

-----

meta-data --> metadata (throughout)

## Section 2.2

readind in fields --> reading in fields

----
Capitalization:
> this input helps trap missing data or errors in cycling. to turn off trapping, set the value to 1.0e30 or something similar.

## Section 2.3

Check usage of "CIME" throughout. Usage of "CIME" should be when there is special data model functionality related to the CIME workflow, not as another name for "CDEPS"
> Each CIME data model

## Section 2.4
The "inline" API section does not describe how to actually access the field data itself after initializing and advancing. An additional code snippit and explanation would help.

## Section 2.5
Fix punctuation (also later in this section):
> The stream calendar and model calendar are identical Proceed in the standard way

## Section 4.1

> DATM its own set of supported

## General

- Only DATM has a separate section. Sections are needed for the other data models.

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.