Add animation tutorials to the main tutorials branch #1915
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## doc/new-tutorials-section #1915 +/- ##
============================================================
Coverage ? 88.06%
============================================================
Files ? 83
Lines ? 9993
Branches ? 0
============================================================
Hits ? 8800
Misses ? 1193
Partials ? 0 |
Co-authored-by: Paul Profizi <[email protected]>
Co-authored-by: Luisa Felix Salles <[email protected]>
|
Hi @JennaPaikowsky! Requesting your review on this PR for a tutorial on animations. We are implementing guidelines on how to write such tutorials, so your opinion would be greatly appreciated! Thanks! |
…-animation-tutorials
JennaPaikowsky
left a comment
JennaPaikowsky
left a comment
There was a problem hiding this comment.
A few recommended changes
|
|
||
| :jupyter-download-notebook:`Download tutorial as notebook<animate_time>` | ||
|
|
||
| To animate data across time you need to get the data stored in a |FieldsContainer| labeled in time. |
There was a problem hiding this comment.
For "labeled in time", I am not sure what you mean here. The fields container must be labeled as "time"? If yes then:
To animate data across time, you must store the data in a |FieldsContainer| named time.
There was a problem hiding this comment.
hi @JennaPaikowsky,
A FieldsContainer uses labels to identify the fields it stores. For example, if a FieldsContainer stores three fields and has two labels time and test, then each field is identified by a unique combination of values for these two labels. Here, the first field could be for {"time": 0; "test":0}, the second field could be for {"time":1; "test":0}, and the third field could be for {"time":1, "test":1}.
In this case, we would tend to say the FieldsContainer is labeled in time to say it has a time label.
Which is why in this tutorial on animations in time, we say the FieldsContainer must have a "time" label.
Is that a better formulation? must have a "time" label
There was a problem hiding this comment.
Hi @PProfizi, yes "must have a time label" is much clearer.
Co-authored-by: JennaPaikowsky <[email protected]>
Co-authored-by: Luisa Felix Salles <[email protected]>
luisaFelixSalles
deleted the
tutorials/animate/first-animation-tutorials
branch
* add animate_data.rst tutorial * completes the animate_data.rst tutorial * Apply suggestions from code review Co-authored-by: Paul Profizi <[email protected]> * codes for just one case and erase badges * change tutorial name * last updates * Update animate_time.rst * Fixing moving camera * Apply suggestions from code review Co-authored-by: Luisa Felix Salles <[email protected]> * Update doc/source/user_guide/tutorials/animate/animate_time.rst * Apply suggestions from code review Co-authored-by: JennaPaikowsky <[email protected]> * Apply suggestions from code review Co-authored-by: Luisa Felix Salles <[email protected]> * Apply suggestions from code review * Update doc/source/user_guide/tutorials/animate/animate_time.rst * updates --------- Co-authored-by: Paul Profizi <[email protected]> Co-authored-by: PProfizi <[email protected]> Co-authored-by: JennaPaikowsky <[email protected]>
Add new animation tutorials to the tutorials section
List of tutorials:
Preview on how it renders
Animation section main page
Animate data over time