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 animation tutorials to the main tutorials branch #1915

Conversation

luisaFelixSalles
Copy link
Collaborator

@luisaFelixSalles luisaFelixSalles commented Nov 20, 2024

Add new animation tutorials to the tutorials section

List of tutorials:

  • Animate data over time

Preview on how it renders

Animation section main page

image

Animate data over time

_D__ANSYSdev_pydpf-core_doc_build_html_user_guide_tutorials_animate_animate_time html (1)

Copy link

codecov bot commented Nov 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (doc/new-tutorials-section@991b95a). Learn more about missing BASE report.

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           

@PProfizi PProfizi changed the base branch from master to doc/new-tutorials-section November 20, 2024 17:15
@luisaFelixSalles luisaFelixSalles self-assigned this Nov 21, 2024
@luisaFelixSalles luisaFelixSalles added the tutorials Related to PyDPF-Core tutorials label Nov 21, 2024
@luisaFelixSalles luisaFelixSalles mentioned this pull request Nov 20, 2024
36 tasks
Co-authored-by: Luisa Felix Salles <[email protected]>
@PProfizi
Copy link
Contributor

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!

Copy link
Contributor

@JennaPaikowsky JennaPaikowsky left a 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

doc/source/user_guide/tutorials/animate/animate_time.rst Outdated Show resolved Hide resolved
doc/source/user_guide/tutorials/animate/animate_time.rst Outdated Show resolved Hide resolved

: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.
Copy link
Contributor

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.

Copy link
Contributor

@PProfizi PProfizi Nov 28, 2024

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

Copy link
Contributor

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.

doc/source/user_guide/tutorials/animate/animate_time.rst Outdated Show resolved Hide resolved
doc/source/user_guide/tutorials/animate/animate_time.rst Outdated Show resolved Hide resolved
doc/source/user_guide/tutorials/animate/animate_time.rst Outdated Show resolved Hide resolved
doc/source/user_guide/tutorials/animate/animate_time.rst Outdated Show resolved Hide resolved
doc/source/user_guide/tutorials/animate/animate_time.rst Outdated Show resolved Hide resolved
doc/source/user_guide/tutorials/animate/animate_time.rst Outdated Show resolved Hide resolved
doc/source/user_guide/tutorials/animate/animate_time.rst Outdated Show resolved Hide resolved
PProfizi and others added 2 commits November 28, 2024 11:19
@luisaFelixSalles luisaFelixSalles merged commit e9cfde6 into doc/new-tutorials-section Dec 3, 2024
45 checks passed
@luisaFelixSalles luisaFelixSalles deleted the tutorials/animate/first-animation-tutorials branch December 3, 2024 10:00
luisaFelixSalles added a commit that referenced this pull request Dec 19, 2024
* 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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tutorials Related to PyDPF-Core tutorials
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants