Skip to content

Add documentation explaining the is_ocean key #1133

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

Merged
thomas-robinson merged 1 commit into from
Feb 22, 2023
Merged

Add documentation explaining the is_ocean key #1133

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: 10 additions & 0 deletions diag_manager/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ The purpose of this documents is to explain the diag_table yaml format.
- [2.1 Global Section](README.md#21-global-section)
- [2.2 File Section](README.md#22-file-section)
- [2.2.1 Flexible output timings](README.md#221-flexible-output-timings)
- [2.2.2 Coupled Model Diag Files](README.md#222-coupled-model-diag-files)
- [2.3 Variable Section](README.md#23-variable-section)
- [2.4 Variable Metadata Section](README.md#24-variable-metadata-section)
- [2.5 Global Meta Data Section](README.md#25-global-meta-data-section)
Expand Down Expand Up @@ -181,6 +182,15 @@ flexible_timing_0002_01_01_23.nc - using data from hour 23 to hour 24

```

### 2.2.2 Coupled Model Diag Files
In the *legacy ascii diag_table*, when running a coupled model (ATM + OCN) in a seperate PE list:
- The ATM PEs ignored the files in the diag_table that contain "OCEAN" in the filename
- The OCN PEs ignored the files in the diag_table that did not contain "OCEAN" in the filename

In the *yaml diag_table*:
- The ATM PEs will ignore the files in the diag_table.yaml that contain the key/value pair `is_ocean: true`
- The OCN PEs will ignore the files in the diag_table.yaml that do not contain the key/value pair `is_ocean: true`

### 2.3 Variable Section
The variables in each file are listed under the varlist section as a dashed array.

Expand Down