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.

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

Remove diag table schema #1543

Merged
merged 1 commit into from
Jul 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 5 additions & 3 deletions diag_manager/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
The purpose of this document is to document the differences between the old diag manager and the new (modern) diag manager.
The purpose of this document is to document the differences between the old diag manager and the new (modern) diag manager.

## Contents
- [1. Diag Table Format](README.md#1-diag-table-format)
Expand All @@ -10,7 +10,9 @@ The purpose of this document is to document the differences between the old diag
- [7. History files data output "changes"](README.md#7-history-files-data-output-changes)

### 1. Diag Table Format
The modern diag manager uses a YAML format instead of the legacy ascii table. A description of the YAML diag table can be found [here](diag_yaml_format.md).
The modern diag manager uses a YAML format instead of the legacy ascii table. A description of the YAML diag table can
be found [here](diag_yaml_format.md). A formal specification, in the form of a JSON schema, can be found in the
[gfdl_msd_schemas](https://github.com/NOAA-GFDL/gfdl_msd_schemas) repository on Github.

### 2. Scalar Axis
The old diag manager was adding a `scalar_axis` dimension of size 1 for scalar variables
Expand Down Expand Up @@ -70,7 +72,7 @@ This time_bounds variable is refernced as a variable attribute of time:
### 4. Subregional Files

#### A. `is_subregional` global attribute:
Subregional files will have a global NetCDF attribute `is_subregional = True` set for non-global history files. This attribute will be used in PP tools.
Subregional files will have a global NetCDF attribute `is_subregional = True` set for non-global history files. This attribute will be used in PP tools.

#### B. Subregional dimension names:
In some cases, the old diag manager was adding `sub0X` to the dimension names where X is a number greater than 1. This was causing problems in PP tools that were expecting the dimension to have `sub01` in the name. The new diag manager will not have this problem.
Expand Down
6 changes: 6 additions & 0 deletions diag_manager/diag_yaml_format.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ The purpose of this document is to explain the diag_table yaml format.
- [2.5 Global Meta Data Section](diag_yaml_format.md#25-global-meta-data-section)
- [2.6 Sub_region Section](diag_yaml_format.md#26-sub_region-section)
- [3. More examples](diag_yaml_format.md#3-more-examples)
- [4. Schema](diag_yaml_format.md#4-schema)

### 1. Converting from legacy ascii diag_table format

Expand Down Expand Up @@ -340,3 +341,8 @@ diag_files:
unlimdim: records
write_file: false
```

### 4. Schema
A formal specification of the file format, in the form of a JSON schema, can be
found in the [gfdl_msd_schemas](https://github.com/NOAA-GFDL/gfdl_msd_schemas)
repository on Github.
141 changes: 0 additions & 141 deletions diag_manager/schema.diag

This file was deleted.

Loading