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

Make new issues suggesting how to simplify notebooks #332

Closed
adele-morrison opened this issue Apr 16, 2024 · 2 comments
Closed

Make new issues suggesting how to simplify notebooks #332

adele-morrison opened this issue Apr 16, 2024 · 2 comments
Assignees

Comments

@adele-morrison
Copy link
Collaborator

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?

@ongqingyee
Copy link
Collaborator

Happy to simplify https://github.com/COSIMA/cosima-recipes/blob/main/DocumentedExamples/Cross-slope_section.ipynb into two examples, one for a transect and one for an along/cross slope decomposition. Can't self-assign this unfortunately.

@navidcy
Copy link
Collaborator

navidcy commented Jun 26, 2024

Can't self-assign this unfortunately.

I created an issue #386 with you suggestion.
I invited you as a collaborator in the repo. Perhaps when you accept you can assign #386 to you? Let me know if you still can't.

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

No branches or pull requests

3 participants