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

Add tutorial for making animations #427

Closed
wants to merge 5 commits into from

Conversation

navidcy
Copy link
Collaborator

@navidcy navidcy commented Jul 19, 2024

on behalf of @mauricehuguenin

closes #62

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@navidcy
Copy link
Collaborator Author

navidcy commented Jul 19, 2024

@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?

@mauricehuguenin
Copy link

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.

@navidcy
Copy link
Collaborator Author

navidcy commented Jul 19, 2024

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 navidcy marked this pull request as draft July 19, 2024 21:49
@navidcy
Copy link
Collaborator Author

navidcy commented Jul 19, 2024

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

@navidcy
Copy link
Collaborator Author

navidcy commented Aug 31, 2024

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

@adele-morrison
Copy link
Collaborator

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.

@AndyHoggANU
Copy link
Contributor

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?

@navidcy
Copy link
Collaborator Author

navidcy commented Aug 31, 2024

Deal! Sounds good.

@navidcy
Copy link
Collaborator Author

navidcy commented Sep 1, 2024

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

@navidcy navidcy closed this Sep 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Tutorial: Making animations
4 participants