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

The 2022 CF meeting - Hackathon proposals #152

Closed
davidhassell opened this issue Apr 13, 2022 · 15 comments
Closed

The 2022 CF meeting - Hackathon proposals #152

davidhassell opened this issue Apr 13, 2022 · 15 comments

Comments

@davidhassell
Copy link
Collaborator

Dear CF Community,

We are excited to solicit "Hackathon" proposals for the upcoming 2022 CF Conventions Workshop scheduled for 13-15 September, 2022 in Santander, Spain. We envision devoting some portion of each day to focused attention on high priority issues for CF. Hackathon sessions may be organized around new (without an associated GitHub issue) or existing topics. Suggestions will nominate a discussion leader, preferably someone attending the workshop in person, who will solicit in-person and on-line participation from a critical mass of individuals interested in making progress on the topic. Self-nominations are welcome!

We hope that the outcome of each hackathon will be:

  • Progress on some new, neglected, or stymied issue of importance
  • Exposure on how to write, edit, and review CF proposals
  • More future contributors to CF
  • To dispel any sense that the CF proposal-adoption cycle must be slow
  • Stronger community spirit as we emerge from COVID isolation

Proposals can be short and informal. One or two paragraphs will suffice. Please attach your proposal to this announcement prior by May 4, 2022 so the Workshop Organizing Committee can rank the proposals at its next meeting.

Sincerely,
The CF Workshop Organizing Committee.

@erget
Copy link
Member

erget commented Apr 13, 2022

I've got some ideas! Mostly these are follow-ups on previous discussions.

Kanban board for proposals

We've discussed visualising the change adoption workflow using Kanban and this would likely be useful, particularly for new contributors. I'd be interested in prototyping this and making it obvious from the CF landing page so that it actually gets found and used. Some people have mentioned a desire to use a bot for this - I don't see a particular need here but am open to suggestions. I've wrapped this up in #360 - is anybody interested in working on this?

Link cleanup

There's probably no topic that inspires such excitement as cleaning up broken links. Currently we have a few of them; we should cleanup what we can, passivate the ones that are kept for historical reasons, and improve the link checking process so that it actually adds value (currently I ignore this, although I was involved in setting it up). Maybe switch to using asciidoc linkcheck? Nobody knows what the future holds, but we all agree that it's exciting.

Cleanup line breaks

CF doesn't have a style guide for use in AsciiDoc (yet!) but we've noted at previous meetings that the way the lines are structured in the AsciiDoc files makes it hard to do a git blame and get meaningful results. Putting each sentence on a single line would help get us there and would be a quick hack, but would need to be implemented quickly so that we don't create cumbersome merge conflicts with all the other work in progress. That way for a given sentence we could say who changed what, when, and why.
Ancillary to the initial AsciiDoc tidying we might have a go at an initial style guide to try working with in the following year. Who's game?

@sadielbartholomew
Copy link
Member

Hi all, here are a few of my own ideas, which can be taken forward or left depending on interest! I should add that I really like all of @erget's ideas as covered above, so really just want to provide some further options to diversify the possibilities.

For both of these, should either be chosen to go ahead with, I am happy to lead, but would be equally happy if someone else wanted to lead with them (volunteers can just shout here or in some other suitable location at any point).

Automation of standard names countdown process

To make a start towards resolution of cf-convention/vocabularies#106, which ultimately aims to create:

a tool to automate the management (time-tracking, repeated announcement, pausing etc.) of time periods initiated by lack of further comment on a given issue to propose a new standard name

and in particular see my new comment in that issue, cf-convention/vocabularies#106, where I suggest a tool (protobot) and highlight applications that already exist that were created using it which solve problems which are quite similar and which we can hopefully use as a means to get something (at least close to) working within the timescale of a Hackathon.

Diagrams to summarise rules/processes for changes

See cf-convention/cf-convention.github.io#217 where I have outlined the idea in its own issue, because it might be thought of as a good thing to do whether or not we end up tackling it in the Hackathon. Ultimately concerns the presentation of information on the website, but the diagrams could be useful for potential incorporation into other resources, e.g. presentations and future training.

@czender
Copy link

czender commented May 5, 2022

Here is my idea for a followup of a breakout originally held at the CF 2021 Workshop:

NetCDF version 4.9.0 contains significantly more featureful support for compression, both lossless and lossy. Lossless compression filters present no outstanding issues for CF because they do not alter data, and have been widely used for years in large-scale projects such as CMIP. Lossy compression, however, does alter data and is increasingly viewed as an optimal choice to reduce storage requirements while preserving a desired level of information content. What roles can and should CF play in establishing metadata standards to encode the history and preserve the provenance of data transformation by lossy compression? Please join this hackathon/workgroup to discuss and draft metadata standards to facilitate the use and transparency of lossy compression in CF-compliant datasets.

@japamment
Copy link
Member

Proposal from Gwen Moncoiffé (NOC/BODC) (@gwemon), Alexandra Kokkinaki (NOC/BODC) (@alko-k) and Alison Pamment (NCAS/CEDA).

We propose a hackathon session on mapping CF standard names to the Interoperability Framework developed by the Research Data Alliance I-ADOPT (InteroperAble Descriptions of Observable Property Terminologies) Working Group https://doi.org/10.15497/RDA00071. The work of I-ADOPT was described at the CF 2021 meeting and the “Advancing CF Conventions for NetCDF” session of the 2021 AGU Fall meeting and the framework is now ready to be implemented in the NERC Vocabulary Server. Mapping standard names to the Interoperability Framework will enable the discovery of equivalent terms in other vocabularies like, e.g., the BODC Parameter Usage Vocabulary, and broaden the discovery of comparable datasets. The hackathon would be used to show some examples of mappings already created and work together on some further examples.

@ngalbraith
Copy link

I see that the I-ADOPT proposal is listed on the CF meeting registration page. Can someone provide a link to more info on this project? Google isn't helping for some reason; the I-ADOPT area on github isn't helping much either.

@rmendels
Copy link

rmendels commented Aug 14, 2022 via email

@davidhassell
Copy link
Collaborator Author

The workshop agenda has been updated with the I-ADOPT link. Thanks.

@davidhassell
Copy link
Collaborator Author

The meeting agenda has now been updated with I-ADOPT link https://zenodo.org/record/6520132 - thanks for pointing this out.

@jypeter
Copy link

jypeter commented Aug 26, 2022

I'm not sure I'll be able to attend a hackaton remotely, but I have some suggestions that some people can possibly discuss. Maybe in Housecleaning?

There are 32 mentions of software on the https://cfconventions.org/ site, like:

  • enables software tools to display data and perform operations on specified subsets of the data with minimal user intervention and write software that allows a machine to parse that metadata and to automatically associate each data value with its location in time and space (in 1.1 Goals)
  • helps software developers to design CF-compliant data-processing applications (in Appendix 1)

But there is no mention of actual software that can be used to usefully work with CF.

There is one mention of Python (in the last reference of the References at the very end of the page), and a few references of udunits and Proj, but there are not exactly for end users

I have just found the Software that “Understands” CF Data page. This is accessible from the CF convention home page, but is not referenced in the NetCDF Climate and Forecast (CF) Metadata Conventions page itself

Maybe an appendix listing/advertising the software packages that can handle/understand at least part of CF and that can be easily used by end users would be too long, but there should be an easy way to find the Software that “Understands” CF Data page from the convention document

Also, the potentially very useful software page seems to be out of date and missing packages. I'm a long time user of the awesome PCMDI's cdms2 (initially developed by Bob Drach, the "D" in "GDT convention"), other people use (py)Ferret, maybe there are some R packages that can help

Note that there is some work to try replace the python cdms2 package with an xCDAT extension of xarray (ping @tomvothecoder @durack1)

Also, Housecleaning should include a reference to the original "GDT convention" and a link to the document. I was not able to find the document on Google, and I have sent a mail to Karl Taylor and Jonathan Gregory asking if they had it somewhere

@JonathanGregory
Copy link
Contributor

Dear @jypeter et al.

Thanks for raising this point. If we made explicit mentions of or links to CF webpages in the CF standards document, it would require more maintenance to keep the document and the website consistent. Also, it's harder and slower to update the document than the website. However, I appreciate that people who have the standards document as a PDF or as a URL may not be aware of the website. Therefore I would suggest instead that we insert a statement something like this near the start of the CF document:

Please see the CF website at cfconventions.org for previous versions of the conventions, the standard name table, forums for questions and proposals about the conventions, a list of software for working with CF, and other resources.

Would that meet the need?

Cheers

Jonathan

@jypeter
Copy link

jypeter commented Aug 26, 2022

Well, as long as there is an easy-to-find reference in the "CF document" to a place where people can find CF aware software (and the other resources you mention), this would work for me! Maybe several references, because you never know what string people are going to look for in a document

Also, having a link to the CF website near the top of the CF document would solve what I noticed earlier today: there is no convenient way to navigate from the document (back) to the website, unless you go to the URL field in your browser and remove Data/cf-conventions/cf-conventions-1.9/cf-conventions.html from https://cfconventions.org/Data/cf-conventions/cf-conventions-1.9/cf-conventions.html

Actually, there is a kind of logo on the home page, and I was trying to find it at the top of the document, in order to click on it and go back to the home page. Maybe having a logo with a link in the document would help

@ethanrd
Copy link
Member

ethanrd commented Sep 1, 2022

I like the idea of adding to the Housekeeping hackathon list an item to work on updating the CF software web page (as suggested by @jypeter above). I've created an issue (cf-convention/cf-convention.github.io#241) to start gathering ideas for the CF software web page.

@taylor13
Copy link

taylor13 commented Sep 1, 2022

Just a reminder that another web "navigational" issue that still needs addressing was raised in cf-convention/cf-convention.github.io#191 . Should this be added to some "list of things to do" along with items above?

@JonathanGregory
Copy link
Contributor

Dear Karl

Following your comment about cf-convention/cf-convention.github.io#191, I have added to that issue. What do you think of what I wrote? I agree, we should resolve it.

Best wishes

Jonathan

@JonathanGregory
Copy link
Contributor

I believe that all of the above proposals have been considered and implemented or are the subject of other issues, so I am closing this now. If that's wrong, please open new issues as appropriate addressing individual proposals. Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests