Skip to content

Commit cf3f844

Browse files
updates the examples package references
1 parent 706b595 commit cf3f844

6 files changed

+13
-7
lines changed

doc/source/user_guide/tutorials/plot/plotting_a_graph.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Plotting data on a graph
99
.. |MeshedRegion| replace:: :class:`MeshedRegion <ansys.dpf.core.meshed_region.MeshedRegion>`
1010
.. |Model| replace:: :class:`Model <ansys.dpf.core.model.Model>`
1111
.. |mapping| replace:: :class:`mapping <ansys.dpf.core.operators.mapping.on_coordinates.on_coordinates>`
12+
.. |Examples| replace:: :mod:`Examples<ansys.dpf.core.examples>`
1213

1314
This part shows how to get a result plotted on a graph.
1415

@@ -29,7 +30,7 @@ be defined check the :ref:`ref_plotting_data_on_specific_placements` tutorial.
2930
Define the data
3031
^^^^^^^^^^^^^^^
3132

32-
We will download a simple simulation result file available in our `Examples` package:
33+
We will download a simple simulation result file available in our |Examples| package:
3334

3435
.. jupyter-execute::
3536

doc/source/user_guide/tutorials/plot/plotting_data_on_deformed_mesh.rst

+3-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ Plotting data on deformed mesh
88
.. |MeshedRegion| replace:: :class:`MeshedRegion <ansys.dpf.core.meshed_region.MeshedRegion>`
99
.. |Field| replace:: :class:`Field<ansys.dpf.core.field.Field>`
1010
.. |FieldsContainer| replace:: :class:`FieldsContainer<ansys.dpf.core.fields_container.FieldsContainer>`
11-
.. |MeshesContainer| replace:: :class:`MeshesContainer <ansys.dpf.core.meshes_container.MeshesContainer>`,
11+
.. |MeshesContainer| replace:: :class:`MeshesContainer <ansys.dpf.core.meshes_container.MeshesContainer>`
12+
.. |Examples| replace:: :mod:`Examples<ansys.dpf.core.examples>`
1213

1314
This tutorial shows how to plot data on the deformed mesh. For more detailed information on plotting data
1415
check the :ref:`ref_plotting_data_on_the_mesh` tutorial.
@@ -17,7 +18,7 @@ Define the data
1718
---------------
1819

1920
In this tutorial we will download a simulation result file available
20-
in our ``Examples`` package:
21+
in our |Examples| package:
2122

2223
.. jupyter-execute::
2324

doc/source/user_guide/tutorials/plot/plotting_data_on_geometry_elements.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Plot data on geometry elements
1414
.. |Points| replace:: :class:`Points <ansys.dpf.core.geometry.Points>`
1515
.. |Plane| replace:: :class:`Plane <ansys.dpf.core.geometry.Plane>`
1616
.. |mapping| replace:: :class:`mapping <ansys.dpf.core.operators.mapping.on_coordinates.on_coordinates>`
17+
.. |Examples| replace:: :mod:`Examples<ansys.dpf.core.examples>`
1718

1819
This tutorials shows how to get a result mapped over different geometric objects:
1920

@@ -24,7 +25,7 @@ This tutorials shows how to get a result mapped over different geometric objects
2425
Define the data
2526
---------------
2627

27-
We will download a simple simulation result file available in our `Examples` package:
28+
We will download a simple simulation result file available in our |Examples| package:
2829

2930
.. jupyter-execute::
3031

doc/source/user_guide/tutorials/plot/plotting_data_on_specific_path.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,14 @@ Plotting data on a specific path
1414
.. |Points| replace:: :class:`Points <ansys.dpf.core.geometry.Points>`
1515
.. |Plane| replace:: :class:`Plane <ansys.dpf.core.geometry.Plane>`
1616
.. |mapping| replace:: :class:`mapping <ansys.dpf.core.operators.mapping.on_coordinates.on_coordinates>`
17+
.. |Examples| replace:: :mod:`Examples<ansys.dpf.core.examples>`
1718

1819
This tutorial shows how to get a result mapped over a specific path and how to plot it.
1920

2021
Define the data
2122
---------------
2223

23-
We will download a simple simulation result file available in our `Examples` package:
24+
We will download a simple simulation result file available in our |Examples| package:
2425

2526
.. jupyter-execute::
2627

doc/source/user_guide/tutorials/plot/plotting_data_on_the_mesh.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,15 @@ Plotting data on the mesh
1515
.. |show_figure| replace:: :func:`show_figure()<ansys.dpf.core.plotter.DpfPlotter.show_figure>`
1616
.. |Field| replace:: :class:`Field<ansys.dpf.core.field.Field>`
1717
.. |FieldsContainer| replace:: :class:`FieldsContainer<ansys.dpf.core.fields_container.FieldsContainer>`
18+
.. |Examples| replace:: :mod:`Examples<ansys.dpf.core.examples>`
1819

1920
This tutorial shows how to plot data on its supporting mesh by different approaches.
2021

2122
Define the data
2223
---------------
2324

2425
In this tutorial we will download a simulation result file available
25-
in our ``Examples`` package:
26+
in our |Examples| package:
2627

2728
.. jupyter-execute::
2829

doc/source/user_guide/tutorials/plot/plotting_meshes.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Plotting meshes
1313
.. |DpfPlotter| replace:: :class:`DpfPlotter<ansys.dpf.core.plotter.DpfPlotter>`
1414
.. |add_mesh| replace:: :func:`add_mesh()<ansys.dpf.core.plotter.DpfPlotter.add_mesh>`
1515
.. |show_figure| replace:: :func:`show_figure()<ansys.dpf.core.plotter.DpfPlotter.show_figure>`
16+
.. |Examples| replace:: :mod:`Examples<ansys.dpf.core.examples>`
1617

1718
DPF-Core has a variety of plotting methods for generating 3D plots of
1819
Ansys models directly from Python. These methods use VTK and leverage
@@ -29,7 +30,7 @@ The mesh object in DPF is a |MeshedRegion|. You can plot a |MeshedRegion| or a
2930
|MeshesContainer|, that is a collection of |MeshedRegion|.
3031

3132
In this tutorial we will download a pontoon simulation result file available in
32-
our `Examples` package:
33+
our |Examples| package:
3334

3435
.. jupyter-execute::
3536

0 commit comments

Comments
 (0)