cosima-recipes icon indicating copy to clipboard operation
cosima-recipes copied to clipboard

Add tutorial for making animations

Open navidcy opened this issue 1 year ago • 5 comments

on behalf of @mauricehuguenin

closes #62

navidcy avatar Jul 19 '24 12:07 navidcy

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@mauricehuguenin I opened the PR. Thanks for this!

I had a look... It's quite complicated? Could we simplify it? It doesn't have to be the best, Hollywood-grade type of movie. People can fine-details their figures.... But at the moment there is a lot of code that is not really animation-relevant and a person that wants to learn about how to do animation might struggle... I personally struggled a bit to read through.

(I can give you more specific comments next week..)

But also it's not really working. Did I break it?

navidcy avatar Jul 19 '24 12:07 navidcy

Sure, I can simplify it quiet a bit. Thanks Navid! I'll do that when I am back from annual leave (5th of August) and will update you when I have a newer and shorter version to share.

mauricehuguenin avatar Jul 19 '24 12:07 mauricehuguenin

Ideally: load a field (few snapshots are enough) and just plot using Cartopy on some projection... Then make animation.

No need to include fancy bathymetry and also no need to include a lot of fine-tuning. Most important is to have documentation-explanation of what you are trying to do so that you hold the hand of the people who will be reading your tutorial in order to learn to make their own.

Also avoid using user-define directories. Let the users do that... The example can just create a directory in its own directory. I changed that but perhaps I broke something along the way...?

navidcy avatar Jul 19 '24 13:07 navidcy

I converted the PR to Draft. When you think is ready click on the "Ready for review" button!

navidcy avatar Jul 19 '24 21:07 navidcy

I'm wondering if we need a new tutorial. Can we just expand the Maps tutorial to include an animation?

navidcy avatar Aug 31 '24 07:08 navidcy

I think a separate one would be better. I was thinking this morning about pros and cons of combining recipes or having a huge number. There is definitely a tradeoff. If we combine too many things into a single recipe than it takes forever to run and it gets hard to make any changes. It can also be hard to find what's in them if the description doesn't obviously cover everything. But too many recipes is maybe not great either, because it's hard to maintain a huge number (e.g. we currently have recipes that don't even run). In general I'm not sure what's best. I am definitely finding some of the longer, more complicated recipes hard to make changes to now.

This animation one could be super simple, e.g. just daily SST for a simple small domain for 1 month total duration.

adele-morrison avatar Aug 31 '24 07:08 adele-morrison

We are better with a larger number of well-described, short tutorials. Then, we need to finalise a testing framework to make sure that they all work all the time. Sound OK?

AndyHoggANU avatar Aug 31 '24 09:08 AndyHoggANU

Deal! Sounds good.

navidcy avatar Aug 31 '24 21:08 navidcy

I'm closing this in favour of #452. (Sorry @mauricehuguenin)

navidcy avatar Sep 01 '24 10:09 navidcy