Improve Examples (minor changes) (#564)

* Improve examples section.
---------

Co-authored-by: Dominik Gresch <[email protected]>

Author: roosre

examples/002_sampling_point_example.py

@@ -51,7 +51,6 @@
 # DPF server, and retrieving the example files.
 #
 # Load Ansys libraries.
-
 from ansys.dpf.composites.composite_model import CompositeModel
 from ansys.dpf.composites.constants import Spot
 from ansys.dpf.composites.example_helper import get_continuous_fiber_example_files
@@ -105,17 +104,17 @@
 )
 sampling_point_plot.figure.set_figheight(8)
 sampling_point_plot.figure.set_figwidth(12)
+sampling_point_plot.figure.show()
 
 # %%
 # Plot polar properties.
 sampling_point_plot = sampling_point.get_polar_plot(["E1", "G12"])
-
+sampling_point_plot.figure.show()
 # %%
 # Generate custom plots. You can customize existing plots or build
 # them from scratch using a package like Matplot or Plotly. This code
 # uses Matplotlib to generate a custom plot of results ``s13`` and ``s23``.
 #
-
 import matplotlib.pyplot as plt
 
 fig, ax1 = plt.subplots()
@@ -133,6 +132,7 @@
 plt.rcParams["hatch.linewidth"] = 0.2
 plt.rcParams["hatch.color"] = "silver"
 sampling_point.add_ply_sequence_to_plot(ax1, core_scale_factor)
+fig.show()
 
 # %%
 # This code uses Matplotlib to generate a custom plot of results ``e12`` and ``e2``.
@@ -152,11 +152,13 @@
 ax1.set_yticks([])
 ax1.legend()
 ax1.set_title("e12 and e2")
+fig.show()
 
 # %%
 # This code plots the lay-up only.
 fig2, layup_axes = plt.subplots()
 sampling_point.add_ply_sequence_to_plot(layup_axes)
+fig2.show()
 
 # %%
 # Sample another element
@@ -172,3 +174,4 @@
 )
 sampling_point_plot.figure.set_figheight(8)
 sampling_point_plot.figure.set_figwidth(12)
+sampling_point_plot.figure.show()

examples/003_short_fiber_example.py

@@ -91,13 +91,12 @@
 
 field_variables = field_variable_provider.outputs.fields_container.get_data()
 
-a11 = field_variables[0]
-a11.plot()
-
 # %%
-
-a22 = field_variables[1]
-a22.plot()
+# Note that the order of the results can differ from the one shown here.
+for index in range(len(field_variables)):
+    field_variable = field_variables[index]
+    print(f"Field variable {field_variable.name}")
+    field_variable.plot()
 
 # %%
 # Configure and evaluate

examples/README.rst

@@ -5,3 +5,13 @@
 Examples
 ========
 These examples demonstrate the behavior and usage of PyDPF - Composites.
+Some additional modules are required to run the examples which can be
+installed with the following command:
+
+.. code::
+
+    pip install ansys-dpf-composites[examples]
+
+It is recommended to run the examples in a Jupyter notebook or an IPython console.
+Copy / pasting to a standard Python interactive shell can lead to formatting issues (e.g. IndentationError).
+This issue is resolved with Python 3.13 and later.