-
Notifications
You must be signed in to change notification settings - Fork 7
feat : draft for the global attributes guidelines #36
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
Conversation
|
#24 for reference |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few minor comments/suggestions, but this looks good to me otherwise
| ➡️ [https://github.com/WCRP-CMIP/CMIP7_CVs/](https://github.com/WCRP-CMIP/CMIP7_CVs/) | ||
| [https://github.com/WCRP-CMIP/WCRP-Universe/](https://github.com/WCRP-CMIP/WCRP-Universe/) | ||
| Guidance documents: [https://wcrp-cmip.github.io/cmip7-guidance/](https://wcrp-cmip.github.io/cmip7-guidance/) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
add bullets?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why the link to this guidance repo? (user is already here...)
Should there be a link to the WCRP-Universe without explaining what this is? Might be simpler to just have the link to the CMIP7-CVs repo (otherwise, would esgvoc have to be mentioned/explained?).
docs/CMIP7/global_attributes.md
Outdated
| **For further guidance and updates:** | ||
| Visit the CMIP7 documentation portal: | ||
| 🔗 [https://wcrp-cmip.github.io/cmip7-guidance/](https://wcrp-cmip.github.io/cmip7-guidance/) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would be tempted to drop this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the document info is also given at the top? Which seems to me a better place for it.
I don't think we need the link to this guidance repo (?).
docs/CMIP7/global_attributes.md
Outdated
| | **Other Required Fields** | `frequency`, `grid_label`, `region`, `realm`, `variable_id`, `tracking_id` | | Define data frequency, grid, domain, and unique file IDs | | ||
|
|
||
| **Conditionally Required Attributes:** | ||
| Used only when datasets branch from parent simulations (e.g., `branch_time_in_parent`, `parent_activity_id`). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"only" --> "mainly" (external_variables is also conditional)
| ### Notes: | ||
| - `timeRangeDD` is omitted for fixed (time-independent) variables. | ||
| - Filenames directly encode key experiment and model metadata. | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps add sub-bullets under filenames:
- The first half of the filename, `<variable_id>_<branding_suffix>_<frequency>_<region>`, specifies the reported variable
- The second half of the filename, `<source_id>_<experiment_id>_<variant_label>[_<timeRangeDD>]`, specifies the model simulation and the time period from it that is included in the file
|
|
||
| The `nominal_resolution` describes approximate horizontal grid spacing (e.g., `"1 km"`, `"250 km"`). | ||
| It is computed using a standard algorithm (updated from CMIP6 Appendix 2) that ensures consistent comparison of model resolutions across CMIP7 datasets. | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we provide the link given in the EMD:
https://pcmdi.github.io/nominal_resolution/html/index.html
?
Or could just link to the EMD, which specifies how to do it (calculate mean_resolution_km and then use the lookup table in Sec 7.10)
docs/CMIP7/global_attributes.md
Outdated
| **For further guidance and updates:** | ||
| Visit the CMIP7 documentation portal: | ||
| 🔗 [https://wcrp-cmip.github.io/cmip7-guidance/](https://wcrp-cmip.github.io/cmip7-guidance/) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the document info is also given at the top? Which seems to me a better place for it.
I don't think we need the link to this guidance repo (?).
| ➡️ [https://github.com/WCRP-CMIP/CMIP7_CVs/](https://github.com/WCRP-CMIP/CMIP7_CVs/) | ||
| [https://github.com/WCRP-CMIP/WCRP-Universe/](https://github.com/WCRP-CMIP/WCRP-Universe/) | ||
| Guidance documents: [https://wcrp-cmip.github.io/cmip7-guidance/](https://wcrp-cmip.github.io/cmip7-guidance/) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why the link to this guidance repo? (user is already here...)
Should there be a link to the WCRP-Universe without explaining what this is? Might be simpler to just have the link to the CMIP7-CVs repo (otherwise, would esgvoc have to be mentioned/explained?).
|
@ltroussellier, this looks reasonably close --I'd like to either merge this in or put in a place holder pointing at the zenodo document (#55) until we can get this in. Have you got the time to look at the comments above today? |
|
I'm just starting to get back into the swing of things after the holidays. As for this merge request, everything looks good indeed. |
|
i will make the suggested changes as is. I have tried to it quickly but need some care with git interface (im not enough expert to do it quickly) |
Co-authored-by: Matthew Mizielinski <[email protected]>
|
did it work ? 😅 |
|
@ltroussellier, I've made one tweak to ensure formatting works and I'm going to merge this, but it would be good to address James' comments in a follow-up PR in the near future. |
It is just a draft
i need to review it carefully (syntax of everything), especially the DRS etc ..
Does it sound like a good starting point for the guidelines ?