Skip to content

Commit cdfb01b

Browse files
Apply suggestions from code review
Co-authored-by: JennaPaikowsky <[email protected]>
1 parent 7779304 commit cdfb01b

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

doc/source/user_guide/tutorials/animate/animate_time.rst

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -21,20 +21,20 @@ Animate data over time
2121
.. |Overall| replace:: :class:`overall<ansys.dpf.core.common.locations>`
2222
.. |open_movie| replace:: :class:`pyvista.Plotter.open_movie`
2323

24-
This tutorial shows how to create 3D animations of data in time.
24+
This tutorial demonstrates how to create 3D animations of data in time.
2525

2626
:jupyter-download-script:`Download tutorial as Python script<animate_time>`
2727

2828
:jupyter-download-notebook:`Download tutorial as notebook<animate_time>`
2929

30-
To animate data across time you need to get the data stored in a |FieldsContainer| labeled in time.
30+
To animate data across time, you must store the data in a |FieldsContainer| labeled in time.
3131

3232

3333
Get the result files
3434
--------------------
3535

36-
First, import a result file such as one available with the |Examples| module.
37-
For more information about how to import your own result file in DPF check
36+
First, import a results file. For this tutorial, you can use the one available in the |Examples| module.
37+
For more information about how to import your own result file in DPF, see
3838
the :ref:`ref_tutorials_import_data` tutorial section.
3939

4040
.. jupyter-execute::
@@ -53,9 +53,9 @@ the :ref:`ref_tutorials_import_data` tutorial section.
5353
Define a time scoping
5454
---------------------
5555

56-
To animate across time we first need to define the time steps of interest.
57-
Here we get all the time steps available in the |TimeFreqSupport|, but you can also filter them.
58-
For more information on how to define a scoping check the ``Narrow down data`` tutorial in the
56+
To animate across time, you must define the time steps you are interested in.
57+
This tutorial retrieves all the time steps available in |TimeFreqSupport|, but you can also filter them.
58+
For more information on how to define a scoping, see the ``Narrow down data`` tutorial in the
5959
:ref:`ref_tutorials_import_data` tutorials section.
6060

6161
.. jupyter-execute::
@@ -66,11 +66,11 @@ For more information on how to define a scoping check the ``Narrow down data`` t
6666
Extract the results
6767
-------------------
6868

69-
Extract the results to animate. Here we get the displacement and stress results.
69+
Extract the results to animate. In this tutorial, you extract the displacement and stress results.
7070

7171
.. note::
7272

73-
Only locations |Elemental|, |Nodal| or |Faces| are supported for animations.
73+
Only the |Elemental|, |Nodal|, or |Faces| locations are supported for animations.
7474
|Overall| and |ElementalNodal| locations are not currently supported.
7575

7676

@@ -95,18 +95,18 @@ Animate the results with the |animate| method.
9595
You can animate them on a deformed mesh (animate the color map and the mesh)
9696
or on a static mesh (animate the color map only).
9797

98-
The default behavior of the |animate| method consists in:
98+
The default behavior of the |animate| method is to:
9999

100-
- Showing the norm of the data components;
101-
- Showing data at the top layer for shells;
102-
- Showing the deformed mesh when animating displacements;
103-
- Showing the static mesh for other types of results;
104-
- Using a constant and uniform scale factor of 1.0 when deforming the mesh.
100+
- Display the norm of the data components;
101+
- Display data at the top layer for shells;
102+
- Display the deformed mesh when animating displacements;
103+
- Display the static mesh for other types of results;
104+
- Use a constant and uniform scale factor of 1.0 when deforming the mesh.
105105

106106
You can animate any result on a deformed geometry by providing displacement results in the `deform_by` parameter.
107107

108108
The geometry can be deformed by a |Result| object, an |Operator| (It must evaluate to a |FieldsContainer|
109-
of same length as the one being animated) or a |FieldsContainer| (also of same length as the one being animated).
109+
of same length as the one being animated), or a |FieldsContainer| (also of same length as the one being animated).
110110

111111
.. note::
112112

0 commit comments

Comments
 (0)