Add note to the examples how to get the input files from a WB project

examples/001_failure_operator_example.py

@@ -38,6 +38,13 @@
 allows you to assess different type of materials and failure modes at once.
 The scoping enables you to evaluate the minimum and maximum failures per element
 or select a list of materials or plies.
+
+.. note::
+
+    When using a Workbench project,
+    use the :func:`.get_composite_files_from_workbench_result_folder`
+    method to obtain the input files.
+
 """
 # %%
 # Set up analysis

examples/002_sampling_point_example.py

@@ -36,6 +36,12 @@
 This example uses the :class:`Composite Model <.CompositeModel>` to scope a
 Sampling Point to a certain element and to visualize the laminate.
 
+.. note::
+
+    When using a Workbench project,
+    use the :func:`.get_composite_files_from_workbench_result_folder`
+    method to obtain the input files.
+
 """
 
 # %%

examples/004_get_material_properties_example.py

@@ -30,7 +30,15 @@
 implement a custom failure criterion. The failure criterion is computed for
 all layers and integration points. Finally, the elemental maximum is computed and shown.
 
-Note: Only constant material properties are currently supported.
+.. note::
+
+    Only constant material properties are currently supported.
+
+.. note::
+    When using a Workbench project,
+    use the :func:`.get_composite_files_from_workbench_result_folder`
+    method to obtain the input files.
+
 """
 
 # %%

examples/005_get_layup_properties_example.py

@@ -32,6 +32,13 @@
 
 To get the full layer information of an element, including results,
 consider using the :class:`SamplingPoint <.SamplingPoint>` class.
+
+.. note::
+
+    When using a Workbench project,
+    use the :func:`.composite_files_from_workbench_harmonic_analysis`
+    method to obtain the input files.
+
 """
 # %%
 # Set up analysis

examples/006_filter_composite_data_example.py

@@ -37,6 +37,13 @@
 The examples show filtering data by layer, spot, and node, as well as material
 or analysis ply ID. To learn more about how layered result data is organized,
 see :ref:`select_indices`.
+
+.. note::
+
+    When using a Workbench project,
+    use the :func:`.composite_files_from_workbench_harmonic_analysis`
+    method to obtain the input files.
+
 """
 
 # %%

examples/007_interlaminar_normal_stress_example.py

@@ -46,6 +46,12 @@
     :ref:`sphx_glr_examples_gallery_examples_006_filter_composite_data_example.py`
     shows how helper functions can be used to obtain composite result data.
 
+.. note::
+
+    When using a Workbench project,
+    use the :func:`.composite_files_from_workbench_harmonic_analysis`
+    method to obtain the input files.
+
 """
 
 # %%

examples/008_assembly_example.py

@@ -31,6 +31,12 @@
 :class:`Composite Model <.CompositeModel>` class is used to access
 the data of the different parts.
 
+.. note::
+
+    When using a Workbench project,
+    use the :func:`.composite_files_from_workbench_harmonic_analysis`
+    method to obtain the input files.
+
 """
 # %%
 # Set up analysis

examples/010_harmonic_example.py

@@ -26,16 +26,16 @@
 Postprocess a harmonic analysis
 -------------------------------
 
+This example shows how to evaluate failure criteria for a harmonic simulation.
+It shows how to create a phase sweep to compute the maximum IRF in the frequency-phase
+space and shows how to identify the critical failure mode and the critical layer.
+
 .. note::
 
     When using a Workbench project,
     use the :func:`.composite_files_from_workbench_harmonic_analysis`
     method to obtain the input files.
 
-This example shows how to evaluate failure criteria for a harmonic simulation.
-It shows how to create a phase sweep to compute the maximum IRF in the frequency-phase
-space and shows how to identify the critical failure mode and the critical layer.
-
 """
 
 

examples/011_rst_workflow.py

@@ -45,6 +45,13 @@
 The postprocessing of MAPDL models is supported in 2024 R2 (DPF Server version 8.0)
 and later. A few advanced features are not supported with the RST only workflow.
 For more information, see :ref:`limitations`.
+
+.. note::
+
+    When using a Workbench project,
+    use the :func:`.composite_files_from_workbench_harmonic_analysis`
+    method to obtain the input files.
+
 """
 # %%
 # Set up analysis

examples/012_fatigue_example.py

@@ -40,6 +40,13 @@
 of the user to verify that it works as expected. For more information, see the
 `fatpack package <https://pypi.org/project/fatpack/>`_,
 
+.. note::
+
+    When using a Workbench project,
+    use the :func:`.composite_files_from_workbench_harmonic_analysis`
+    method to obtain the input files.
+
+
 """
 
 

examples/014_cyclic_symmetry_example.py

@@ -33,6 +33,13 @@
 a custom failure criterion.
 
 The postprocessing of expanded sectors is not yet supported.
+
+.. note::
+
+    When using a Workbench project,
+    use the :func:`.composite_files_from_workbench_harmonic_analysis`
+    method to obtain the input files.
+
 """
 
 # %%