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

Clarify the intention of standard names #366

Closed
JonathanGregory opened this issue May 12, 2022 · 12 comments · Fixed by #368
Closed

Clarify the intention of standard names #366

JonathanGregory opened this issue May 12, 2022 · 12 comments · Fixed by #368
Labels
change agreed Issue accepted for inclusion in the next version and closed defect Conventions text meaning not as intended, misleading, unclear, has typos, format or language errors

Comments

@JonathanGregory
Copy link
Contributor

JonathanGregory commented May 12, 2022

In cf-convention/vocabularies#132 @jonathanlilly has pointed out that the current text of section 3.3 might appear to mean that a given standard_name can appear only once in any file. The text follows the description of long_name, whose usage is stated to be "completely ad-hoc." It continues

For some applications it would be desirable to have a more definitive description of the quantity, which would allow users of data from different sources (some of which might be models and others observational) to determine whether quantities were in fact comparable. For this reason an optional mechanism for uniquely associating each variable with a standard name is provided.

Also it's written with "would" as though standard names are hypothetical, because this text was written at the start of CF when they were a new idea. I propose that we replace the above text with the following, in which I have put new words in bold:

For many applications it is desirable to have a more definitive description of the quantity, which allows users of data from different sources (some of which might be models and others observational) to determine whether quantities are in fact comparable. For this reason each variable may optionally be given a "standard name", whose meaning is defined by this convention.

Comments are welcome. I believe that this does not change the intended meaning of the convention, but only clarifies the text. Therefore it can be treated as a remedy for a defect, so this proposal will be accepted in three weeks (on 2nd June) if there are no objections.

Jonathan

@JonathanGregory JonathanGregory added the defect Conventions text meaning not as intended, misleading, unclear, has typos, format or language errors label May 12, 2022
@davidhassell
Copy link
Contributor

Dear Jonathan, Looks good - no objection from me. Do you want to write a Pull Request?
Thanks,
David

@JonathanGregory
Copy link
Contributor Author

JonathanGregory commented May 12, 2022 via email

@larsbarring
Copy link
Contributor

With reference to the use case provided in convention/discuss#155 --- two variables both having standard_name = "time", where one is a time average of the other and thus has cell_method = "time: mean" --- might it be useful to include a reference to this CF mechanism? Something like:

For many applications it is desirable to have a more definitive description of the quantity, which allows users of data from different sources (some of which might be models and others observational) to determine whether quantities are in fact comparable. For this reason each variable may optionally be given a "standard name", whose meaning is defined by this convention, possibly with further details given in the cell methods.

@JonathanGregory
Copy link
Contributor Author

Dear @larsbarring

Yes, I take the point, which is also partly what I replied to @jonathanlilly. I'd prefer to say something more general than just referring to cell_methods. Would this be OK:

For many applications it is desirable to have a more definitive description of the quantity, which allows users of data from different sources (some of which might be models and others observational) to determine whether quantities are in fact comparable. For this reason each variable may optionally be given a "standard name", whose meaning is defined by this convention. There may be several variables in a dataset with any given standard name, and these may be distinguished by other metadata, such as coordinates (Section 4) and cell_methods (Section 7.3).

Jonathan

@larsbarring
Copy link
Contributor

Yes, this is much better! Thanks /Lars

@jonathanlilly
Copy link

jonathanlilly commented May 13, 2022 via email

@larsbarring
Copy link
Contributor

Long_name and comments are not managed or mandated by the CF Conventions, neither regarding their content or being present at all. A data producer or user may of course use them to that effect (for my own personal use I often think of a long_name as way to provide a succinct and generic plot title or similar.) In principle the CF Conventions are not linked to the netCDF file format, but in practice this is often case. And in netCDF files the variable name is the key unique identifier that distinguish one variable from another.

@jonathanlilly
Copy link

jonathanlilly commented May 13, 2022 via email

@JonathanGregory
Copy link
Contributor Author

Three weeks have elapsed, so this change is agreed. I have prepared #368 to implement it. Please could someone check it and merge? Thanks.

@davidhassell
Copy link
Contributor

Thanks, Jonathan, looks good to me. I'll merge it tomorrow, assuming no further comment on your text.

@davidhassell davidhassell added this to the 1.10 milestone Jun 8, 2022
@davidhassell davidhassell added the change agreed Issue accepted for inclusion in the next version and closed label Aug 25, 2022
@davidhassell davidhassell removed this from the 1.10 milestone Aug 30, 2022
@jonathanlilly
Copy link

jonathanlilly commented Oct 11, 2022 via email

@davidhassell
Copy link
Contributor

Hi Jonathan (Lilly) - sorry for the confusio! I think we're all OK here - I was replying to the other Jonathan, who did indeed write a PR that has been merged, so it all worked out in the end.

Thanks,
David

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
change agreed Issue accepted for inclusion in the next version and closed defect Conventions text meaning not as intended, misleading, unclear, has typos, format or language errors
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants