Add Make your own intake datastore recipe

[anton-seaice]

Adding a recipe to make your own intake-esm datastore (n.b. the intake catalog is a collection of datastores, there is one datastore for one experiment)

Shall we delete the "Make your own cookbook" recipe ? (There was previous inconclusive discussion #376)

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[anton-seaice]

I request Dougie's review but it really needs review from a non-intake expect too :)

FYI @marc-white

[adele-morrison]

Shall we delete the "Make your own cookbook" recipe ?

My vote is let's not delete yet. I would guess 80% or so of COSIMA are still using the cookbook, and many of the Recipes still use it. How about we leave it up for another 6-12 months and then reassess?

[anton-seaice]

As Navid says - you can always find it in the history. But having it in the main branch means it goes in the "readthedocs" too. Maybe just add a note at the top of the make your own cookbook recipe to refer to the new recipe?

[edoddridge]

I'm not sure I understand your reasoning @adele-morrison. The tutorial is about how to make your own database for the cookbook, not about using the already existent ones.

If someone is going to the trouble of indexing an experiment for the first time, I think it would be better to nudge them towards intake. It seems kind of mean to help them learn an already outdated skill.

[navidcy]

if intake is ready to be used, then let's delete all cookbook stuff!
I think leaving it makes people using it and not moving on to new things. Also it creates clutter...

I do have that habit myself (eg to avoid moving to new tools). For example, I'm still using gadi_jupyter because it's there and never learned to use ARE...

but I also see @adele-morrison's point

so as a mid-way ground I'd say we keep it BUT:

• we add a disclaimer at the top of the Tutorial with red letters saying that cookbook is going to be deprecated soon; if you are new in COSIMA then don't start from here, use intake instead!
  (Basically I want to avoid new users to be learning the cookbook.)

• I'd like to have the cosima_cookbook package giving people a "scary" deprecation warning every time they do:

  import cosima_cookbook

  I opened this Deprecation warning cosima-cookbook#342
  Could we do that? This way the deprecation period starts today and 6 months down the line people don't ask for another 6 months of grace period where cookbook is kept alive while on the ICU and clinically dead....

[navidcy]

I'm not sure I understand your reasoning @adele-morrison. The tutorial is about how to make your own database for the cookbook, not about using the already existent ones.

If someone is going to the trouble of indexing an experiment for the first time, I think it would be better to nudge them towards intake. It seems kind of mean to help them learn an already outdated skill.

I agree. And the people who do need to find it they'll ask around or dig into Github and find it.

I think mostly it's the fear of letting go? I think that if we feel that intake is ready to be used (not sure about that as experienced users like @julia-neme seemed to run into a lot of issues!) then we should brave the fear and let go.

I'm saying this but I'm also happy with the intermediate solution I suggested above.

[adele-morrison]

I think we should at least have 100% of the Recipes converted to Intake first before deleting it. If there are still recipes that we can't guarantee work with Intake, then people will still need it. But yes, let's warn new users not to use it.

[anton-seaice]

I think I will merge this unless anyone else wants to jump in and review :)

[navidcy]

Merge!

[marc-white]

Sorry I didn't get to review this, it landed right while I was being blasted with COVID :(

[navidcy]

No need to apologize! The community got your back!