-
Notifications
You must be signed in to change notification settings - Fork 25
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 animation tutorials to the main tutorials branch #1915
base: doc/new-tutorials-section
Are you sure you want to change the base?
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.10% 88.03% -0.08%
=============================================================
Files 83 83
Lines 9973 9973
=============================================================
- Hits 8787 8780 -7
- Misses 1186 1193 +7 |
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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]>
Add new animation tutorials to the tutorials section
List of tutorials:
Preview on how it renders
Animation section main page
Animate data over time