PCMDI / cmip6-cmor-tables

JSON Tables for CMOR3 to create CMIP6 dataset
BSD 3-Clause "New" or "Revised" License
31 stars 46 forks source link

HTML table view of variable definitions in MIP tables #372

Open matthew-mizielinski opened 2 years ago

matthew-mizielinski commented 2 years ago

For another project we needed an easy, searchable view of the variable definitions within the MIP tables to go alongside a table of our "mappings" (how we produce a particular variable from our "raw" model output). @mo-jareddrayton in my team put together an html table using those used in the CMIP6_CVs for the experiment_id as a template.

I've added this to a fork of this repository that I've used for another project called ARISE* and you can see an example here (note that I'm trying to move this into the MetOffice organisation at which point this link is likely to become valid).

While the table is a little clunky (1 row for each of the 2,000+ variables) it is very quick to find all the relevant details for a particular variable through the search interface. The same information is available via the data request HTML interface, but this is quicker to navigate and could be augmented with additional fields.

It would probably take about 10 minutes to copy the code into this repo, generate the tables and deploy github pages if you think this is a useful addition.

*I'm not looking to merge these "ARISE" tables back to this repository, so I'll break the link at some point.

taylor13 commented 2 years ago

I have done something similar: downloaded the MIP tables from the data request site in excel format; then combined them into a single table. The result has many more additional columns (of not quite so useful information). Anyway combining the multiple spreadsheets into a single spreadsheet took some time, so I think what @mo-jareddrayton has done will be quite a nice overview interface to the variables.

By the way I don't quite understand what you meant by "used in the CMIP6_CVs for the experiment_id as a template." What does experiment_id have to do with it?

matthew-mizielinski commented 2 years ago

By the way I don't quite understand what you meant by "used in the CMIP6_CVs for the experiment_id as a template." What does experiment_id have to do with it?

Hi @taylor13, what I was trying to say is that we took the CMIP6 experiment id HTML page, and used the structure (all the javascript stuff that makes it searchable) as a template for creating another page with different columns & information.

taylor13 commented 2 years ago

Oh, got it. Well done. Cheers, Karl

From: Matthew Mizielinski @.> Reply-To: PCMDI/cmip6-cmor-tables @.> Date: Monday, July 4, 2022 at 3:27 AM To: PCMDI/cmip6-cmor-tables @.> Cc: "Taylor, Karl E." @.>, Mention @.***> Subject: Re: [PCMDI/cmip6-cmor-tables] HTML table view of variable definitions in MIP tables (Issue #372)

By the way I don't quite understand what you meant by "used in the CMIP6_CVs for the experiment_id as a template." What does experiment_id have to do with it?

Hi @taylor13https://urldefense.us/v3/__https:/github.com/taylor13__;!!G2kpM7uM-TzIFchu!mSk6vDiOX9ML1i3cuHCDZAsTW6pPmaxqposiqd0ZMe4sdjO_l1f-pGOzHCuvFoQI8bY$, what I was trying to say is that we took the CMIP6 experiment id HTML pagehttps://urldefense.us/v3/__https:/wcrp-cmip.github.io/CMIP6_CVs/docs/CMIP6_experiment_id.html__;!!G2kpM7uM-TzIFchu!mSk6vDiOX9ML1i3cuHCDZAsTW6pPmaxqposiqd0ZMe4sdjO_l1f-pGOzHCuvq5BQMkw$, and used the structure (all the javascript stuff that makes it searchable) as a template for creating another page with different columns & information.

— Reply to this email directly, view it on GitHubhttps://urldefense.us/v3/__https:/github.com/PCMDI/cmip6-cmor-tables/issues/372*issuecomment-1173581061__;Iw!!G2kpM7uM-TzIFchu!mSk6vDiOX9ML1i3cuHCDZAsTW6pPmaxqposiqd0ZMe4sdjO_l1f-pGOzHCuvzqRDv3s$, or unsubscribehttps://urldefense.us/v3/__https:/github.com/notifications/unsubscribe-auth/ABGDDH2M6NQWZMLX2NNRB6LVSKVATANCNFSM52NE4CHA__;!!G2kpM7uM-TzIFchu!mSk6vDiOX9ML1i3cuHCDZAsTW6pPmaxqposiqd0ZMe4sdjO_l1f-pGOzHCuvsHUzitE$. You are receiving this because you were mentioned.Message ID: @.***>

matthew-mizielinski commented 1 year ago

@durack1 if you have a moment could you give me rights to push to this repo I've got a branch ready to add the searchable table here

durack1 commented 1 year ago

@mauzey1 just FYI, @matthew-mizielinski was planning on adding some html to this repo - it would be great if you can review to ensure that we're not messing anything up, and also see if a future update (not planned) could also update the HTML if an update occurs (I hope not)

durack1 commented 1 year ago

@matthew-mizielinski just an FYI, we hadn't planned to turn on github pages on this repo - I wonder whether CMIP6_CVs (which does have github pages active) would be a better place to drop HTML (into the /docs subdir?)

mauzey1 commented 1 year ago

@durack1 @matthew-mizielinski I can enable pages for this repo once we have the branch with the HTML.

durack1 commented 1 year ago

@mauzey1 I might hold off with that. @matthew-mizielinski would it be better for all new activity to occur under the mip-cmor-tables repo, including the "origin" tables?

matthew-mizielinski commented 1 year ago

@durack1, @mauzey1

Fair point on whether to put anything new in this repository -- I could hold off and just target the new tables instead. I've used these pages elsewhere (e.g. here) where I've needed to make a set of scientist readable tables and have had some other questions on this recently that poked me into doing something :-)

I could put them alongside the CVs, as long as we're happy with having dependencies in the HTML pages on information outside of that repo.

I would be tempted to serve them from here/the CVs and the new project, but with a heading linking to the new variables once the pages are set up.

durack1 commented 1 year ago

@matthew-mizielinski let's add this to the agenda for discussion tomorrow - 8 am (PST) good for you? We can also add https://github.com/WCRP-CMIP/CMIP6_CVs/issues/1062