DOC: update development documentation 4479c9a

ansys · Dec 15, 2023 · 2e24363 · 2e24363
1 parent be8e6f5
commit 2e24363
Show file tree

Hide file tree

Showing 72 changed files with 871 additions and 123 deletions.
diff --git a/version/dev/.buildinfo b/version/dev/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: d2333c9901dfc0875e27a1133559770a
+config: d54a575d70797148628ef7849d0919a2
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.../_images/examples/gallery_examples/images/sphx_glr_001_failure_operator_example_001.vtksz b/.../_images/examples/gallery_examples/images/sphx_glr_001_failure_operator_example_001.vtksz
diff --git a/.../_images/examples/gallery_examples/images/sphx_glr_001_failure_operator_example_002.vtksz b/.../_images/examples/gallery_examples/images/sphx_glr_001_failure_operator_example_002.vtksz
diff --git a/.../_images/examples/gallery_examples/images/sphx_glr_001_failure_operator_example_003.vtksz b/.../_images/examples/gallery_examples/images/sphx_glr_001_failure_operator_example_003.vtksz
diff --git a/...n/dev/_images/examples/gallery_examples/images/sphx_glr_003_short_fiber_example_001.vtksz b/...n/dev/_images/examples/gallery_examples/images/sphx_glr_003_short_fiber_example_001.vtksz
diff --git a/...n/dev/_images/examples/gallery_examples/images/sphx_glr_003_short_fiber_example_002.vtksz b/...n/dev/_images/examples/gallery_examples/images/sphx_glr_003_short_fiber_example_002.vtksz
diff --git a/...n/dev/_images/examples/gallery_examples/images/sphx_glr_003_short_fiber_example_003.vtksz b/...n/dev/_images/examples/gallery_examples/images/sphx_glr_003_short_fiber_example_003.vtksz
diff --git a/...s/examples/gallery_examples/images/sphx_glr_004_get_material_properties_example_001.vtksz b/...s/examples/gallery_examples/images/sphx_glr_004_get_material_properties_example_001.vtksz
diff --git a/...ges/examples/gallery_examples/images/sphx_glr_006_filter_composite_data_example_001.vtksz b/...ges/examples/gallery_examples/images/sphx_glr_006_filter_composite_data_example_001.vtksz
diff --git a/...ges/examples/gallery_examples/images/sphx_glr_006_filter_composite_data_example_002.vtksz b/...ges/examples/gallery_examples/images/sphx_glr_006_filter_composite_data_example_002.vtksz
diff --git a/...ges/examples/gallery_examples/images/sphx_glr_006_filter_composite_data_example_003.vtksz b/...ges/examples/gallery_examples/images/sphx_glr_006_filter_composite_data_example_003.vtksz
diff --git a/...xamples/gallery_examples/images/sphx_glr_007_interlaminar_normal_stress_example_001.vtksz b/...xamples/gallery_examples/images/sphx_glr_007_interlaminar_normal_stress_example_001.vtksz
diff --git a/...xamples/gallery_examples/images/sphx_glr_007_interlaminar_normal_stress_example_002.vtksz b/...xamples/gallery_examples/images/sphx_glr_007_interlaminar_normal_stress_example_002.vtksz
diff --git a/version/dev/_images/examples/gallery_examples/images/sphx_glr_008_assembly_example_001.vtksz b/version/dev/_images/examples/gallery_examples/images/sphx_glr_008_assembly_example_001.vtksz
diff --git a/version/dev/_images/examples/gallery_examples/images/sphx_glr_008_assembly_example_002.vtksz b/version/dev/_images/examples/gallery_examples/images/sphx_glr_008_assembly_example_002.vtksz
diff --git a/...es/examples/gallery_examples/images/sphx_glr_009_short_fiber_orientation_tensor_001.vtksz b/...es/examples/gallery_examples/images/sphx_glr_009_short_fiber_orientation_tensor_001.vtksz
diff --git a/...es/examples/gallery_examples/images/sphx_glr_009_short_fiber_orientation_tensor_002.vtksz b/...es/examples/gallery_examples/images/sphx_glr_009_short_fiber_orientation_tensor_002.vtksz
diff --git a/...es/examples/gallery_examples/images/sphx_glr_009_short_fiber_orientation_tensor_003.vtksz b/...es/examples/gallery_examples/images/sphx_glr_009_short_fiber_orientation_tensor_003.vtksz
diff --git a/...es/examples/gallery_examples/images/sphx_glr_009_short_fiber_orientation_tensor_004.vtksz b/...es/examples/gallery_examples/images/sphx_glr_009_short_fiber_orientation_tensor_004.vtksz
diff --git a/...es/examples/gallery_examples/images/sphx_glr_009_short_fiber_orientation_tensor_005.vtksz b/...es/examples/gallery_examples/images/sphx_glr_009_short_fiber_orientation_tensor_005.vtksz
diff --git a/version/dev/_images/examples/gallery_examples/images/sphx_glr_010_harmonic_example_001.vtksz b/version/dev/_images/examples/gallery_examples/images/sphx_glr_010_harmonic_example_001.vtksz
diff --git a/version/dev/_images/examples/gallery_examples/images/sphx_glr_011_rst_workflow_001.vtksz b/version/dev/_images/examples/gallery_examples/images/sphx_glr_011_rst_workflow_001.vtksz
diff --git a/...es/examples/gallery_examples/images/sphx_glr_099_dpf_composite_failure_workflow_001.vtksz b/...es/examples/gallery_examples/images/sphx_glr_099_dpf_composite_failure_workflow_001.vtksz
diff --git a/version/dev/_images/sphx_glr_001_failure_operator_example_001.png b/version/dev/_images/sphx_glr_001_failure_operator_example_001.png
diff --git a/version/dev/_images/sphx_glr_001_failure_operator_example_002.png b/version/dev/_images/sphx_glr_001_failure_operator_example_002.png
diff --git a/version/dev/_images/sphx_glr_001_failure_operator_example_003.png b/version/dev/_images/sphx_glr_001_failure_operator_example_003.png
diff --git a/version/dev/_images/sphx_glr_003_short_fiber_example_001.png b/version/dev/_images/sphx_glr_003_short_fiber_example_001.png
diff --git a/version/dev/_images/sphx_glr_003_short_fiber_example_002.png b/version/dev/_images/sphx_glr_003_short_fiber_example_002.png
diff --git a/version/dev/_images/sphx_glr_003_short_fiber_example_003.png b/version/dev/_images/sphx_glr_003_short_fiber_example_003.png
diff --git a/version/dev/_images/sphx_glr_004_get_material_properties_example_001.png b/version/dev/_images/sphx_glr_004_get_material_properties_example_001.png
diff --git a/version/dev/_images/sphx_glr_006_filter_composite_data_example_001.png b/version/dev/_images/sphx_glr_006_filter_composite_data_example_001.png
diff --git a/version/dev/_images/sphx_glr_006_filter_composite_data_example_002.png b/version/dev/_images/sphx_glr_006_filter_composite_data_example_002.png
diff --git a/version/dev/_images/sphx_glr_006_filter_composite_data_example_003.png b/version/dev/_images/sphx_glr_006_filter_composite_data_example_003.png
diff --git a/version/dev/_images/sphx_glr_007_interlaminar_normal_stress_example_001.png b/version/dev/_images/sphx_glr_007_interlaminar_normal_stress_example_001.png
diff --git a/version/dev/_images/sphx_glr_007_interlaminar_normal_stress_example_002.png b/version/dev/_images/sphx_glr_007_interlaminar_normal_stress_example_002.png
diff --git a/version/dev/_images/sphx_glr_008_assembly_example_001.png b/version/dev/_images/sphx_glr_008_assembly_example_001.png
diff --git a/version/dev/_images/sphx_glr_008_assembly_example_002.png b/version/dev/_images/sphx_glr_008_assembly_example_002.png
diff --git a/version/dev/_images/sphx_glr_009_short_fiber_orientation_tensor_001.png b/version/dev/_images/sphx_glr_009_short_fiber_orientation_tensor_001.png
diff --git a/version/dev/_images/sphx_glr_009_short_fiber_orientation_tensor_002.png b/version/dev/_images/sphx_glr_009_short_fiber_orientation_tensor_002.png
diff --git a/version/dev/_images/sphx_glr_009_short_fiber_orientation_tensor_003.png b/version/dev/_images/sphx_glr_009_short_fiber_orientation_tensor_003.png
diff --git a/version/dev/_images/sphx_glr_009_short_fiber_orientation_tensor_004.png b/version/dev/_images/sphx_glr_009_short_fiber_orientation_tensor_004.png
diff --git a/version/dev/_images/sphx_glr_009_short_fiber_orientation_tensor_005.png b/version/dev/_images/sphx_glr_009_short_fiber_orientation_tensor_005.png
diff --git a/version/dev/_images/sphx_glr_010_harmonic_example_001.png b/version/dev/_images/sphx_glr_010_harmonic_example_001.png
diff --git a/version/dev/_images/sphx_glr_011_rst_workflow_001.png b/version/dev/_images/sphx_glr_011_rst_workflow_001.png
diff --git a/version/dev/_images/sphx_glr_099_dpf_composite_failure_workflow_001.png b/version/dev/_images/sphx_glr_099_dpf_composite_failure_workflow_001.png
diff --git a/...ion/dev/_sources/examples/gallery_examples/001_failure_operator_example.rst.txt b/...ion/dev/_sources/examples/gallery_examples/001_failure_operator_example.rst.txt
@@ -153,7 +153,31 @@ Evaluate failures for the entire model
 
 
 
-.. offlineviewer:: examples/gallery_examples/images/sphx_glr_001_failure_operator_example_001.vtksz
+
+
+
+
+.. tab-set::
+
+
+
+   .. tab-item:: Static Scene
+
+
+
+
+     .. image-sg:: /examples/gallery_examples/images/sphx_glr_001_failure_operator_example_001.png
+        :alt: 001 failure operator example
+        :srcset: /examples/gallery_examples/images/sphx_glr_001_failure_operator_example_001.png
+        :class: sphx-glr-single-img
+
+
+
+   .. tab-item:: Interactive Scene
+
+
+
+       .. offlineviewer:: /home/runner/work/pydpf-composites/pydpf-composites/doc/source/examples/gallery_examples/images/sphx_glr_001_failure_operator_example_001.vtksz
 
 
 
@@ -178,7 +202,31 @@ Scope failure evaluation to a certain element scope.
 
 
 
-.. offlineviewer:: examples/gallery_examples/images/sphx_glr_001_failure_operator_example_002.vtksz
+
+
+
+
+.. tab-set::
+
+
+
+   .. tab-item:: Static Scene
+
+
+
+
+     .. image-sg:: /examples/gallery_examples/images/sphx_glr_001_failure_operator_example_002.png
+        :alt: 001 failure operator example
+        :srcset: /examples/gallery_examples/images/sphx_glr_001_failure_operator_example_002.png
+        :class: sphx-glr-single-img
+
+
+
+   .. tab-item:: Interactive Scene
+
+
+
+       .. offlineviewer:: /home/runner/work/pydpf-composites/pydpf-composites/doc/source/examples/gallery_examples/images/sphx_glr_001_failure_operator_example_002.vtksz
 
 
 
@@ -202,7 +250,31 @@ Scope failure evaluation by plies.
 
 
 
-.. offlineviewer:: examples/gallery_examples/images/sphx_glr_001_failure_operator_example_003.vtksz
+
+
+
+
+.. tab-set::
+
+
+
+   .. tab-item:: Static Scene
+
+
+
+
+     .. image-sg:: /examples/gallery_examples/images/sphx_glr_001_failure_operator_example_003.png
+        :alt: 001 failure operator example
+        :srcset: /examples/gallery_examples/images/sphx_glr_001_failure_operator_example_003.png
+        :class: sphx-glr-single-img
+
+
+
+   .. tab-item:: Interactive Scene
+
+
+
+       .. offlineviewer:: /home/runner/work/pydpf-composites/pydpf-composites/doc/source/examples/gallery_examples/images/sphx_glr_001_failure_operator_example_003.vtksz
 
 
 
@@ -212,7 +284,7 @@ Scope failure evaluation by plies.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** ( 0 minutes  32.949 seconds)
+   **Total running time of the script:** ( 0 minutes  32.411 seconds)
 
 
 .. _sphx_glr_download_examples_gallery_examples_001_failure_operator_example.py:

diff --git a/version/dev/_sources/examples/gallery_examples/002_sampling_point_example.rst.txt b/version/dev/_sources/examples/gallery_examples/002_sampling_point_example.rst.txt
@@ -343,7 +343,7 @@ You can change the element ID of the sampling point to generate another plot.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** ( 0 minutes  16.627 seconds)
+   **Total running time of the script:** ( 0 minutes  16.890 seconds)
 
 
 .. _sphx_glr_download_examples_gallery_examples_002_sampling_point_example.py:

diff --git a/version/dev/_sources/examples/gallery_examples/003_short_fiber_example.rst.txt b/version/dev/_sources/examples/gallery_examples/003_short_fiber_example.rst.txt
@@ -151,7 +151,31 @@ Note that the plots reveal the presence of a weld line in the middle of the spec
 
 
 
-.. offlineviewer:: examples/gallery_examples/images/sphx_glr_003_short_fiber_example_001.vtksz
+
+
+
+
+.. tab-set::
+
+
+
+   .. tab-item:: Static Scene
+
+
+
+
+     .. image-sg:: /examples/gallery_examples/images/sphx_glr_003_short_fiber_example_001.png
+        :alt: 003 short fiber example
+        :srcset: /examples/gallery_examples/images/sphx_glr_003_short_fiber_example_001.png
+        :class: sphx-glr-single-img
+
+
+
+   .. tab-item:: Interactive Scene
+
+
+
+       .. offlineviewer:: /home/runner/work/pydpf-composites/pydpf-composites/doc/source/examples/gallery_examples/images/sphx_glr_003_short_fiber_example_001.vtksz
 
 
 
@@ -169,7 +193,31 @@ Note that the plots reveal the presence of a weld line in the middle of the spec
 
 
 
-.. offlineviewer:: examples/gallery_examples/images/sphx_glr_003_short_fiber_example_002.vtksz
+
+
+
+
+.. tab-set::
+
+
+
+   .. tab-item:: Static Scene
+
+
+
+
+     .. image-sg:: /examples/gallery_examples/images/sphx_glr_003_short_fiber_example_002.png
+        :alt: 003 short fiber example
+        :srcset: /examples/gallery_examples/images/sphx_glr_003_short_fiber_example_002.png
+        :class: sphx-glr-single-img
+
+
+
+   .. tab-item:: Interactive Scene
+
+
+
+       .. offlineviewer:: /home/runner/work/pydpf-composites/pydpf-composites/doc/source/examples/gallery_examples/images/sphx_glr_003_short_fiber_example_002.vtksz
 
 
 
@@ -224,7 +272,31 @@ Compute and plot the maximum failure value per element.
 
 
 
-.. offlineviewer:: examples/gallery_examples/images/sphx_glr_003_short_fiber_example_003.vtksz
+
+
+
+
+.. tab-set::
+
+
+
+   .. tab-item:: Static Scene
+
+
+
+
+     .. image-sg:: /examples/gallery_examples/images/sphx_glr_003_short_fiber_example_003.png
+        :alt: 003 short fiber example
+        :srcset: /examples/gallery_examples/images/sphx_glr_003_short_fiber_example_003.png
+        :class: sphx-glr-single-img
+
+
+
+   .. tab-item:: Interactive Scene
+
+
+
+       .. offlineviewer:: /home/runner/work/pydpf-composites/pydpf-composites/doc/source/examples/gallery_examples/images/sphx_glr_003_short_fiber_example_003.vtksz
 
 
 
@@ -234,7 +306,7 @@ Compute and plot the maximum failure value per element.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** ( 0 minutes  5.044 seconds)
+   **Total running time of the script:** ( 0 minutes  4.989 seconds)
 
 
 .. _sphx_glr_download_examples_gallery_examples_003_short_fiber_example.py:

diff --git a/.../_sources/examples/gallery_examples/004_get_material_properties_example.rst.txt b/.../_sources/examples/gallery_examples/004_get_material_properties_example.rst.txt
@@ -171,7 +171,31 @@ Implement a custom failure criterion: basic max strain
 
 
 
-.. offlineviewer:: examples/gallery_examples/images/sphx_glr_004_get_material_properties_example_001.vtksz
+
+
+
+
+.. tab-set::
+
+
+
+   .. tab-item:: Static Scene
+
+
+
+
+     .. image-sg:: /examples/gallery_examples/images/sphx_glr_004_get_material_properties_example_001.png
+        :alt: 004 get material properties example
+        :srcset: /examples/gallery_examples/images/sphx_glr_004_get_material_properties_example_001.png
+        :class: sphx-glr-single-img
+
+
+
+   .. tab-item:: Interactive Scene
+
+
+
+       .. offlineviewer:: /home/runner/work/pydpf-composites/pydpf-composites/doc/source/examples/gallery_examples/images/sphx_glr_004_get_material_properties_example_001.vtksz
 
 
 
@@ -181,7 +205,7 @@ Implement a custom failure criterion: basic max strain
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** ( 0 minutes  9.825 seconds)
+   **Total running time of the script:** ( 0 minutes  8.812 seconds)
 
 
 .. _sphx_glr_download_examples_gallery_examples_004_get_material_properties_example.py:

diff --git a/...dev/_sources/examples/gallery_examples/005_get_layup_properties_example.rst.txt b/...dev/_sources/examples/gallery_examples/005_get_layup_properties_example.rst.txt
@@ -162,7 +162,7 @@ Plot basic layer properties (layer thicknesses, angles, and analysis ply names).
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** ( 0 minutes  5.155 seconds)
+   **Total running time of the script:** ( 0 minutes  4.845 seconds)
 
 
 .. _sphx_glr_download_examples_gallery_examples_005_get_layup_properties_example.py:

diff --git a/...ev/_sources/examples/gallery_examples/006_filter_composite_data_example.rst.txt b/...ev/_sources/examples/gallery_examples/006_filter_composite_data_example.rst.txt
@@ -180,7 +180,31 @@ For the top layer, plot stress values in the material direction for the first no
 
 
 
-.. offlineviewer:: examples/gallery_examples/images/sphx_glr_006_filter_composite_data_example_001.vtksz
+
+
+
+
+.. tab-set::
+
+
+
+   .. tab-item:: Static Scene
+
+
+
+
+     .. image-sg:: /examples/gallery_examples/images/sphx_glr_006_filter_composite_data_example_001.png
+        :alt: 006 filter composite data example
+        :srcset: /examples/gallery_examples/images/sphx_glr_006_filter_composite_data_example_001.png
+        :class: sphx-glr-single-img
+
+
+
+   .. tab-item:: Interactive Scene
+
+
+
+       .. offlineviewer:: /home/runner/work/pydpf-composites/pydpf-composites/doc/source/examples/gallery_examples/images/sphx_glr_006_filter_composite_data_example_001.vtksz
 
 
 
@@ -250,7 +274,31 @@ in the material direction in this ply.
 
 
 
-.. offlineviewer:: examples/gallery_examples/images/sphx_glr_006_filter_composite_data_example_002.vtksz
+
+
+
+
+.. tab-set::
+
+
+
+   .. tab-item:: Static Scene
+
+
+
+
+     .. image-sg:: /examples/gallery_examples/images/sphx_glr_006_filter_composite_data_example_002.png
+        :alt: 006 filter composite data example
+        :srcset: /examples/gallery_examples/images/sphx_glr_006_filter_composite_data_example_002.png
+        :class: sphx-glr-single-img
+
+
+
+   .. tab-item:: Interactive Scene
+
+
+
+       .. offlineviewer:: /home/runner/work/pydpf-composites/pydpf-composites/doc/source/examples/gallery_examples/images/sphx_glr_006_filter_composite_data_example_002.vtksz
 
 
 
@@ -293,7 +341,31 @@ ID from an analysis ply.
 
 
 
-.. offlineviewer:: examples/gallery_examples/images/sphx_glr_006_filter_composite_data_example_003.vtksz
+
+
+
+
+.. tab-set::
+
+
+
+   .. tab-item:: Static Scene
+
+
+
+
+     .. image-sg:: /examples/gallery_examples/images/sphx_glr_006_filter_composite_data_example_003.png
+        :alt: 006 filter composite data example
+        :srcset: /examples/gallery_examples/images/sphx_glr_006_filter_composite_data_example_003.png
+        :class: sphx-glr-single-img
+
+
+
+   .. tab-item:: Interactive Scene
+
+
+
+       .. offlineviewer:: /home/runner/work/pydpf-composites/pydpf-composites/doc/source/examples/gallery_examples/images/sphx_glr_006_filter_composite_data_example_003.vtksz
 
 
 
@@ -303,7 +375,7 @@ ID from an analysis ply.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** ( 0 minutes  6.290 seconds)
+   **Total running time of the script:** ( 0 minutes  6.395 seconds)
 
 
 .. _sphx_glr_download_examples_gallery_examples_006_filter_composite_data_example.py: