Documentation fixes

[rsdunlapiv]

trafficstars

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.

[mvertens]

@rsdunlapiv - thanks for finding these issues. @uturuncoglu @rsdunlapiv - can @ufuk and myself be assigned to handle the documentation? Is that reasonable?

[rsdunlapiv]

@mvertens I just wanted to capture these while I was looking over the docs for the upcoming presentation, nothing critical. We can use this issue to collect the doc updates that are needed and then take another pass at addressing them.

[mvertens]

That sounds great. Thanks!

On Mon, Nov 1, 2021 at 1:38 PM Rocky Dunlap @.***> wrote:

@mvertens https://github.com/mvertens I just wanted to capture these while I was looking over the docs for the upcoming presentation, nothing critical. We can use this issue to collect the doc updates that are needed and then take another pass at addressing them.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/ESCOMP/CDEPS/issues/130#issuecomment-956530531, or unsubscribe https://github.com/notifications/unsubscribe-auth/AB4XCE54P5C3IA2OPRMZPOLUJ3UCVANCNFSM5HEX4UFQ . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.

-- Dr. Mariana Vertenstein CESM Software Engineering Group Head National Center for Atmospheric Research Boulder, Colorado Office 303-497-1349 Email: @.***