search

EC-Earth / cmor-metadata-fixer

CMOR metadata fixer for cmorised output of any model
Apache License 2.0
0 stars 1 forks source link

Add better comment to history #4

Open klauswyser opened 10 hours ago

klauswyser commented 10 hours ago

The current version of the cmorMDfixer adds "The cmorMDfixer version v1.0 script has been applied." to the history. Can't we have add more meaningful entry instead? My suggestion would be to

  1. add a timestamp (similar to what ece2cmor3 is doing)
  2. possibility to add a user defined short text.

The default text could be "metadata have been updated with cmorMDfixer", but users should have the possibility to add their own message, e.g. "update activity_id and experiment_id" or similar to make clear what exactly has been changed. The message could be added as an optional 4th argument when launching cmorMDfixer, alternatively read from an env variable.

@treerink, what do you think?

treerink commented 9 hours ago

@klauswyser @point 2, yes I think adding such a comment is meaningful metadata. It will be an extra added non-cmor attribute but I think that's ok. I think adding such an attribute is preferred above using the cmor comment-attribute for this. Because that coud complicate the use of the cmorMDfixer because the comment-attribute might already contain info and then adding could be error prone when accidentally overwriting instead of adding.

Concerning "The cmorMDfixer version v1.0 script has been applied." this is eeven not true yet because I waited with a release of v1.0 after some testing like you are doing now.

I think the git hash is written to an attribute as well, I will check. If so, is that sufficient?

klauswyser commented 9 hours ago

The "The cmorMDfixer version v1.0 script has been applied." message is added to the history attribute, not to the comment attribute. I think we should keep it like this and add "timestamp: short message" to the history attribute, not add a new attribute.

The cmorMDfixer version is added as a new attribute latest_applied_cmorMDfixer_version anyway, no need to mention it in the history.

treerink commented 9 hours ago

Ok checking my understanding of your suggestion: You suggest to enable a user to give a short description of what has been done, and you want this description to be concatenated in the history-attribute?

klauswyser commented 9 hours ago

Yes.

Ok checking my understanding of your suggestion: You suggest to enable a user to give a short description of what has been done, and you want this description to be concatenated in the history-attribute together with a timestamp.

The short desription should be optional, a user can ignore it and then just get a timestamp and "cmorMDfixer has been applied" instead. But it would be good to have the possibility for adding more information, for example when running the cmorMDfixer several times (e.g. first fix something, later fix something else)