Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add metadata design doc to table of contents #20

Merged
merged 1 commit into from
Jun 13, 2023
Merged

Add metadata design doc to table of contents #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions components/omega/doc/design/Metadata.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ files or streams and their contents.

Metadata can be in all supported OMEGA data types (I4, I8, R4, R8,
Boolean/logical, strings). Initially only scalar metadata
is required, but extending to vectors/arrays may be desireable.
is required, but extending to vectors/arrays may be desirable.

### 2.2 Requirement: Global and variable metadata

Expand All @@ -41,7 +41,7 @@ To comply with conventions and E3SM practices, there will be a minimum
set of required metadata and interfaces must enforce this minimum set.
This minimum will be defined later, but for variables, this would
typically include a name (short), units, long name/description,
standard CF name (if exists), _FillValue, valid min/max and dimensions.
standard CF name (if exists), `_FillValue`, valid min/max and dimensions.

### 2.5 Requirement: Dimensions

Expand All @@ -50,7 +50,7 @@ In an unstructured model like OMEGA, the dimension describes the
global extent of the index space for each dimension that is then paired
with mesh fields for the full description of OMEGA coordinate locations.
For time dimensions, we require support for both a fixed length time
dimension (eg to support multiple time levels in a restart) as well
dimension (e.g. to support multiple time levels in a restart) as well
as an unlimited dimension to support time series.

### 2.6 Requirement: Available fields
Expand All @@ -65,8 +65,8 @@ list of variable names to be included.

Because lists of contents in the model config file can get long,
it would be useful to define and maintain a metadata group that
is simply a shorthand to a set of common fields (eg meshFields or
prognosticVars). Note that these would only be for the purpose
is simply a shorthand to a set of common fields (e.g. `meshFields` or
`prognosticVars`). Note that these would only be for the purpose
of shortening lists in the config file or managing lists internally.
The full list of fields would still appear in output file metadata.

Expand Down
1 change: 1 addition & 0 deletions components/omega/doc/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ design/DataTypes
design/Halo
design/Logging
design/MachEnv
design/Metadata
design/TimeMgr
design/Reductions

Expand Down