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.

Sign up for GitHub

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

Jump to bottom

Literated example with the animation that is currently in README? #297

Closed
navidcy opened this issue Apr 9, 2023 · 5 comments
Closed

Literated example with the animation that is currently in README? #297

navidcy opened this issue Apr 9, 2023 · 5 comments
Labels
documentation 📚 Improvements or additions to documentation
Milestone
v0.6

Comments

@navidcy
Copy link
Collaborator

navidcy commented Apr 9, 2023

Would that be a good idea?

Or the docs can include a simpler/less computationally demanding example?
@navidcy navidcy added the documentation 📚 Improvements or additions to documentation label Apr 9, 2023
@milankl
Copy link
Member

milankl commented Apr 11, 2023

I agree, we should make sure that there are different examples, probably all at relatively low resolution so that can easily be reproduced. I would definitely want that in the documentation for v0.5 but probably one of the last issues to be resolved so that last minute changes in the run_speedy interface don't have to be backpropagated to the docs

@milankl milankl added this to the v0.5 milestone Apr 11, 2023
@navidcy
Copy link
Collaborator Author

navidcy commented Apr 12, 2023

okie!

@navidcy navidcy mentioned this issue Apr 12, 2023
Closed
@milankl milankl modified the milestones: v0.5, v0.6 May 22, 2023
@milankl
Copy link
Member

milankl commented May 23, 2023

As mentioned in #300 examples will be added after #327 is merged because it'll change the user interface completely, therefore moving this to v0.6 milestone

@milankl
Copy link
Member

milankl commented Dec 18, 2023

I think for now I'm happy with the examples in the documentation and they are somewhat easily reproducible by copying over the presented code snippets. I think that's good enough for now. The examples aren't complicated enough yet to require a whole experiment.jl file so I'm closing this issue for now, but anyone feel free to reopen if this should be added!

@milankl milankl closed this as completed Dec 18, 2023
@navidcy
Copy link
Collaborator Author

navidcy commented Dec 18, 2023

Noice!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation 📚 Improvements or additions to documentation
Projects
None yet
Milestone
v0.6
Development

Successfully merging a pull request may close this issue.

Adds literated example in Docs SpeedyWeather/SpeedyWeather.jl
2 participants
@navidcy @milankl