cosima-recipes
cosima-recipes copied to clipboard
Make new issues suggesting how to simplify notebooks
A task for the hackathon (that doesn't even require coding!):
- Make new issues suggesting ideas for how each of the Tutorials and Documented Examples could be made more simple.
Start off by thinking about what the aim of a particular notebook is, i.e. what plot or diagnostic is it trying to demonstrate? Are there extraneous bits of code / analysis that aren't central to this aim? Could that extra code be deleted/replaced, or moved to a separate notebook that is more usefully labelled?
As an example, the https://github.com/COSIMA/cosima-recipes/blob/main/DocumentedExamples/Cross-slope_section.ipynb notebook aims to show how to plot a random transect. But it goes through a lot of extra effort to decompose the velocity into along-slope and across-slope transport and plot that. Probably it would be better to separate the decomposition of along/across slope flow into its own notebook and keep the Cross-slope_section notebook just showing how to plot a transect?