search

OceanGlidersCommunity / OG-format-user-manual

OceanGliders format and vocabularies
15 stars 13 forks source link

clarify details related to ancillary_variables #239

Open jenseva opened 5 months ago

jenseva commented 5 months ago

moderator: @OceanGlidersCommunity/format-maintainers

Is your feature request related to a problem? Please describe.

:ancillary_variables: Are you planning to allow flexibility in ancillary var name? This is not clear in the manual. Right now the qc var names look rigid.

In my files I can often use the same qc var for two variables. For example, gps_latitude and gps_longitude vars have the same qc and flags so only one var is needed (gps_qc). I assume this is acceptable to OG-1.0, but not 100% clear.

Is this related to a specific platform models

I expect this is common practice for many types of gliders.

Describe the solution you'd like

Clarify in the documentation that flexibility in ancillary variable name is allowed and that one qc var can be used for multiple variables.

I can make a PR for this if there is agreement.

castelao commented 5 months ago

Good point. I agree that ancillary_variables should be flexible. Somehow in the documentation it would be worth saying that it is strongly recommended to use when relevant.

emmerbodc commented 5 months ago

I'm keen to keep the _QC fixed as it is using the OG1 vocabulary for

jenseva commented 5 months ago

Yes, the _qc remains the same, but it would be good to have flexibility in the text before that.

Where for instance: gps_latitude and gps_longitude vars have the same flag variable named gps_qc. The mapping to the qc vars is always clearly listed in the ancillary_variables attribute which is used by both humans and machines easily.

Without this ability the OG files will be larger, requiring replication of qc variables. The impact of this is doubles when using primary and secondary flag variables. I recommend this approach because it is both user-friendly and space-friendly.

vturpin commented 5 months ago

Is this only applicable for locations ?

jenseva commented 5 months ago

This would apply to any situation where one qc variable represents the qc for multiple PARAM variables.

A statement along the lines of, "In cases where one qc variable applies to multiple variables, the portion of qc variable name preceding _qc can be determined by the provider. For an example of this scenario, see the gps variables in the Spray sp028 example file."

vturpin commented 5 months ago

I see the point. This flexibility seems fine to me.