DOC: update development documentation d500449

ansys · Oct 3, 2024 · f3464c5 · f3464c5
commit f3464c5
Show file tree

Hide file tree

Showing 2,995 changed files with 886,415 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +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: c7564cd78fd7cd346b1b9dcb0b23b78d
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.nojekyll b/.nojekyll
diff --git a/CNAME b/CNAME
@@ -0,0 +1 @@
+sherlock.docs.pyansys.com
diff --git a/_images/sherlock-services.png b/_images/sherlock-services.png
diff --git a/_images/userGuide-example-workflow-chart.png b/_images/userGuide-example-workflow-chart.png
diff --git a/...mary/ansys.sherlock.core.analysis.Analysis.get_random_vibe_input_fields.rst.txt b/...mary/ansys.sherlock.core.analysis.Analysis.get_random_vibe_input_fields.rst.txt
@@ -0,0 +1,6 @@
+get\_random\_vibe\_input\_fields
+================================
+
+.. currentmodule:: ansys.sherlock.core.analysis
+
+.. automethod:: Analysis.get_random_vibe_input_fields
diff --git a/...ces/api/_autosummary/ansys.sherlock.core.analysis.Analysis.run_analysis.rst.txt b/...ces/api/_autosummary/ansys.sherlock.core.analysis.Analysis.run_analysis.rst.txt
@@ -0,0 +1,6 @@
+run\_analysis
+=============
+
+.. currentmodule:: ansys.sherlock.core.analysis
+
+.. automethod:: Analysis.run_analysis
diff --git a/...tosummary/ansys.sherlock.core.analysis.Analysis.run_strain_map_analysis.rst.txt b/...tosummary/ansys.sherlock.core.analysis.Analysis.run_strain_map_analysis.rst.txt
@@ -0,0 +1,6 @@
+run\_strain\_map\_analysis
+==========================
+
+.. currentmodule:: ansys.sherlock.core.analysis
+
+.. automethod:: Analysis.run_strain_map_analysis
diff --git a/...osummary/ansys.sherlock.core.analysis.Analysis.update_random_vibe_props.rst.txt b/...osummary/ansys.sherlock.core.analysis.Analysis.update_random_vibe_props.rst.txt
@@ -0,0 +1,6 @@
+update\_random\_vibe\_props
+===========================
+
+.. currentmodule:: ansys.sherlock.core.analysis
+
+.. automethod:: Analysis.update_random_vibe_props
diff --git a/_sources/api/_autosummary/ansys.sherlock.core.analysis.rst.txt b/_sources/api/_autosummary/ansys.sherlock.core.analysis.rst.txt
@@ -0,0 +1,29 @@
+ansys.sherlock.core.analysis
+============================
+
+.. automodule:: ansys.sherlock.core.analysis
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      Analysis
+
+
+
+
+
+
+
+
+
diff --git a/_sources/api/_autosummary/ansys.sherlock.core.common.Common.check.rst.txt b/_sources/api/_autosummary/ansys.sherlock.core.common.Common.check.rst.txt
@@ -0,0 +1,6 @@
+check
+=====
+
+.. currentmodule:: ansys.sherlock.core.common
+
+.. automethod:: Common.check
diff --git a/_sources/api/_autosummary/ansys.sherlock.core.common.Common.exit.rst.txt b/_sources/api/_autosummary/ansys.sherlock.core.common.Common.exit.rst.txt
@@ -0,0 +1,6 @@
+exit
+====
+
+.. currentmodule:: ansys.sherlock.core.common
+
+.. automethod:: Common.exit
diff --git a/...utosummary/ansys.sherlock.core.common.Common.is_sherlock_client_loading.rst.txt b/...utosummary/ansys.sherlock.core.common.Common.is_sherlock_client_loading.rst.txt
@@ -0,0 +1,6 @@
+is\_sherlock\_client\_loading
+=============================
+
+.. currentmodule:: ansys.sherlock.core.common
+
+.. automethod:: Common.is_sherlock_client_loading
diff --git a/_sources/api/_autosummary/ansys.sherlock.core.common.Common.list_units.rst.txt b/_sources/api/_autosummary/ansys.sherlock.core.common.Common.list_units.rst.txt
@@ -0,0 +1,6 @@
+list\_units
+===========
+
+.. currentmodule:: ansys.sherlock.core.common
+
+.. automethod:: Common.list_units
diff --git a/_sources/api/_autosummary/ansys.sherlock.core.common.rst.txt b/_sources/api/_autosummary/ansys.sherlock.core.common.rst.txt
@@ -0,0 +1,29 @@
+ansys.sherlock.core.common
+==========================
+
+.. automodule:: ansys.sherlock.core.common
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      Common
+
+
+
+
+
+
+
+
+
diff --git a/_sources/api/_autosummary/ansys.sherlock.core.launcher.launch_sherlock.rst.txt b/_sources/api/_autosummary/ansys.sherlock.core.launcher.launch_sherlock.rst.txt
@@ -0,0 +1,6 @@
+launch\_sherlock
+================
+
+.. currentmodule:: ansys.sherlock.core.launcher
+
+.. autofunction:: launch_sherlock
diff --git a/_sources/api/_autosummary/ansys.sherlock.core.launcher.rst.txt b/_sources/api/_autosummary/ansys.sherlock.core.launcher.rst.txt
@@ -0,0 +1,30 @@
+ansys.sherlock.core.launcher
+============================
+
+.. automodule:: ansys.sherlock.core.launcher
+
+
+
+
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      connect_grpc_channel
+      launch_sherlock
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/...autosummary/ansys.sherlock.core.layer.Layer.update_mount_points_by_file.rst.txt b/...autosummary/ansys.sherlock.core.layer.Layer.update_mount_points_by_file.rst.txt
@@ -0,0 +1,6 @@
+update\_mount\_points\_by\_file
+===============================
+
+.. currentmodule:: ansys.sherlock.core.layer
+
+.. automethod:: Layer.update_mount_points_by_file
diff --git a/_sources/api/_autosummary/ansys.sherlock.core.layer.rst.txt b/_sources/api/_autosummary/ansys.sherlock.core.layer.rst.txt
@@ -0,0 +1,29 @@
+ansys.sherlock.core.layer
+=========================
+
+.. automodule:: ansys.sherlock.core.layer
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      Layer
+
+
+
+
+
+
+
+
+
diff --git a/..._autosummary/ansys.sherlock.core.lifecycle.Lifecycle.add_harmonic_event.rst.txt b/..._autosummary/ansys.sherlock.core.lifecycle.Lifecycle.add_harmonic_event.rst.txt
@@ -0,0 +1,6 @@
+add\_harmonic\_event
+====================
+
+.. currentmodule:: ansys.sherlock.core.lifecycle
+
+.. automethod:: Lifecycle.add_harmonic_event
diff --git a/...mary/ansys.sherlock.core.lifecycle.Lifecycle.add_harmonic_vibe_profiles.rst.txt b/...mary/ansys.sherlock.core.lifecycle.Lifecycle.add_harmonic_vibe_profiles.rst.txt
@@ -0,0 +1,6 @@
+add\_harmonic\_vibe\_profiles
+=============================
+
+.. currentmodule:: ansys.sherlock.core.lifecycle
+
+.. automethod:: Lifecycle.add_harmonic_vibe_profiles
diff --git a/...tosummary/ansys.sherlock.core.lifecycle.Lifecycle.add_random_vibe_event.rst.txt b/...tosummary/ansys.sherlock.core.lifecycle.Lifecycle.add_random_vibe_event.rst.txt
@@ -0,0 +1,6 @@
+add\_random\_vibe\_event
+========================
+
+.. currentmodule:: ansys.sherlock.core.lifecycle
+
+.. automethod:: Lifecycle.add_random_vibe_event
diff --git a/...ummary/ansys.sherlock.core.lifecycle.Lifecycle.add_random_vibe_profiles.rst.txt b/...ummary/ansys.sherlock.core.lifecycle.Lifecycle.add_random_vibe_profiles.rst.txt
@@ -0,0 +1,6 @@
+add\_random\_vibe\_profiles
+===========================
+
+.. currentmodule:: ansys.sherlock.core.lifecycle
+
+.. automethod:: Lifecycle.add_random_vibe_profiles
diff --git a/...pi/_autosummary/ansys.sherlock.core.lifecycle.Lifecycle.add_shock_event.rst.txt b/...pi/_autosummary/ansys.sherlock.core.lifecycle.Lifecycle.add_shock_event.rst.txt
@@ -0,0 +1,6 @@
+add\_shock\_event
+=================
+
+.. currentmodule:: ansys.sherlock.core.lifecycle
+
+.. automethod:: Lifecycle.add_shock_event
diff --git a/..._autosummary/ansys.sherlock.core.lifecycle.Lifecycle.add_shock_profiles.rst.txt b/..._autosummary/ansys.sherlock.core.lifecycle.Lifecycle.add_shock_profiles.rst.txt
@@ -0,0 +1,6 @@
+add\_shock\_profiles
+====================
+
+.. currentmodule:: ansys.sherlock.core.lifecycle
+
+.. automethod:: Lifecycle.add_shock_profiles
diff --git a/.../_autosummary/ansys.sherlock.core.lifecycle.Lifecycle.add_thermal_event.rst.txt b/.../_autosummary/ansys.sherlock.core.lifecycle.Lifecycle.add_thermal_event.rst.txt
@@ -0,0 +1,6 @@
+add\_thermal\_event
+===================
+
+.. currentmodule:: ansys.sherlock.core.lifecycle
+
+.. automethod:: Lifecycle.add_thermal_event
diff --git a/...utosummary/ansys.sherlock.core.lifecycle.Lifecycle.add_thermal_profiles.rst.txt b/...utosummary/ansys.sherlock.core.lifecycle.Lifecycle.add_thermal_profiles.rst.txt
@@ -0,0 +1,6 @@
+add\_thermal\_profiles
+======================
+
+.. currentmodule:: ansys.sherlock.core.lifecycle
+
+.. automethod:: Lifecycle.add_thermal_profiles
diff --git a/.../_autosummary/ansys.sherlock.core.lifecycle.Lifecycle.create_life_phase.rst.txt b/.../_autosummary/ansys.sherlock.core.lifecycle.Lifecycle.create_life_phase.rst.txt
@@ -0,0 +1,6 @@
+create\_life\_phase
+===================
+
+.. currentmodule:: ansys.sherlock.core.lifecycle
+
+.. automethod:: Lifecycle.create_life_phase
diff --git a/_sources/api/_autosummary/ansys.sherlock.core.lifecycle.rst.txt b/_sources/api/_autosummary/ansys.sherlock.core.lifecycle.rst.txt
@@ -0,0 +1,29 @@
+ansys.sherlock.core.lifecycle
+=============================
+
+.. automodule:: ansys.sherlock.core.lifecycle
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      Lifecycle
+
+
+
+
+
+
+
+
+
diff --git a/...ummary/ansys.sherlock.core.model.Model.export_trace_reinforcement_model.rst.txt b/...ummary/ansys.sherlock.core.model.Model.export_trace_reinforcement_model.rst.txt
@@ -0,0 +1,6 @@
+export\_trace\_reinforcement\_model
+===================================
+
+.. currentmodule:: ansys.sherlock.core.model
+
+.. automethod:: Model.export_trace_reinforcement_model
diff --git a/...s/api/_autosummary/ansys.sherlock.core.model.Model.generate_trace_model.rst.txt b/...s/api/_autosummary/ansys.sherlock.core.model.Model.generate_trace_model.rst.txt
@@ -0,0 +1,6 @@
+generate\_trace\_model
+======================
+
+.. currentmodule:: ansys.sherlock.core.model
+
+.. automethod:: Model.generate_trace_model
diff --git a/_sources/api/_autosummary/ansys.sherlock.core.model.rst.txt b/_sources/api/_autosummary/ansys.sherlock.core.model.rst.txt
@@ -0,0 +1,29 @@
+ansys.sherlock.core.model
+=========================
+
+.. automodule:: ansys.sherlock.core.model
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      Model
+
+
+
+
+
+
+
+
+
diff --git a/...s/api/_autosummary/ansys.sherlock.core.parts.Parts.enable_lead_modeling.rst.txt b/...s/api/_autosummary/ansys.sherlock.core.parts.Parts.enable_lead_modeling.rst.txt
@@ -0,0 +1,6 @@
+enable\_lead\_modeling
+======================
+
+.. currentmodule:: ansys.sherlock.core.parts
+
+.. automethod:: Parts.enable_lead_modeling
diff --git a/...rces/api/_autosummary/ansys.sherlock.core.parts.Parts.export_parts_list.rst.txt b/...rces/api/_autosummary/ansys.sherlock.core.parts.Parts.export_parts_list.rst.txt
@@ -0,0 +1,6 @@
+export\_parts\_list
+===================
+
+.. currentmodule:: ansys.sherlock.core.parts
+
+.. automethod:: Parts.export_parts_list
diff --git a/...rces/api/_autosummary/ansys.sherlock.core.parts.Parts.import_parts_list.rst.txt b/...rces/api/_autosummary/ansys.sherlock.core.parts.Parts.import_parts_list.rst.txt
@@ -0,0 +1,6 @@
+import\_parts\_list
+===================
+
+.. currentmodule:: ansys.sherlock.core.parts
+
+.. automethod:: Parts.import_parts_list
diff --git a/...rces/api/_autosummary/ansys.sherlock.core.parts.Parts.update_parts_list.rst.txt b/...rces/api/_autosummary/ansys.sherlock.core.parts.Parts.update_parts_list.rst.txt
@@ -0,0 +1,6 @@
+update\_parts\_list
+===================
+
+.. currentmodule:: ansys.sherlock.core.parts
+
+.. automethod:: Parts.update_parts_list
diff --git a/...api/_autosummary/ansys.sherlock.core.parts.Parts.update_parts_locations.rst.txt b/...api/_autosummary/ansys.sherlock.core.parts.Parts.update_parts_locations.rst.txt
@@ -0,0 +1,6 @@
+update\_parts\_locations
+========================
+
+.. currentmodule:: ansys.sherlock.core.parts
+
+.. automethod:: Parts.update_parts_locations