projectpythia / intake-cookbook Goto Github PK

Hi @jnmorley here are some first pass notes from your Cookbook. Great work putting this together. Let's polish it into something you can be really proud of.

First your nightly build badge and contributor's images are broken. Is part of this because you aren't in the Cookbook organization?

The link to take you to the source repository still directs you to the cookbooks-template repository instead (which made finding this repo a little harder than necessary).

"Intro to Cartopy" link is broken.

It's good that you linked to the Mesowest’s HRRR data page. I think it would be worth adding a line or two (both in the intake notebook and in the structure where you first mention Mesowest) about this data: Is it satellite, station, or model? If it's a station where is it located? If it's a model what is it's specialty or team like? Is it crowd-sourced data? Something along those lines.

You're opening data from a catalog.yaml file that is hidden in the Cookbook view. It would be nice to have either a page that just displays the yaml in the Cookbook or a link to the raw GitHub link so that readers can scroll through this and see the structure of the file. Some readers may be new to YAML so a line on what it is could be useful here too.

The hrrrzarr descrition says, "See readme source for more information." Can you demonstrate opening the README after that?

"Unfortunately, the data is not quite ready to use after reading it in with intake." All that is obvious to me is that the coordinates are currently projections on x and y. What and why needs to be changed? Are you going to change the names to follow standards or is there some analysis that needs to be done? (And the time piece, which you covered). And why is metpy used for this? Can Xarray not assign the coordinates on its own?

"Intro to Intake" link not there in second notebook.

Great work @jnmorley I hope these points are useful and not too nitpicky. Let me know if you'd like more or less feedback at once going forward.

Recently the nightly link check started failing with

403 Client Error: Forbidden for url: https://www.noaa.gov/

This looks to me like the same issue we encountered in Foundations with certain websites rejecting the sphinx link-checker, see here:
ProjectPythia/pythia-foundations#260
sphinx-doc/sphinx#10343
ProjectPythia/pythia-foundations#262

Two possible workarounds:

• skip the link check for this site only, by adding "https://www.noaa.gov" to the linkcheck_ignore: line in the config file
• Run a valid link check for this site by "spoofing" a user agent with linkcheck_request_headers: as we did in Foundations ProjectPythia/pythia-foundations#262

The nightly builds for this cookbook have been failing for the last couple of weeks, e.g. https://github.com/ProjectPythia/intake-cookbook/actions/runs/3717648320/jobs/6305214610

What has changed upstream that triggered the failure?

Hi James, merging this into the gallery will fail before the config file has been updated with at least one tag for domain or package. Please edit the title and all of that information and then we can see it up there!

ProjectPythia/cookbook-gallery#75

This Cookbook has some great content, but it's currently hard to find since it doesn't appear on the Gallery

Should we add it to the Gallery before AGU to bulk up our visible content?

(In my view, "publishing" on the gallery in no way implies that the content is finished and set in stone -- just that it runs and has something potentially useful for readers)

What do you think @jnmorley @jukent?