Merge branch 'main' into release/0.2

Author: ansjmoody

AUTHORS.md

@@ -7,6 +7,7 @@
 ## Contributors
 
 * [Alexander Kaszynski](https://github.com/akaszynski)
+* [Ethan Ermovick](https://github.com/ansys-eermovic)
 * [Jeff Moody](https://github.com/ansys-jmoody)
 * [Paul Walters](https://github.com/ansys-pwalters)
 * [Roberto Pastor](https://github.com/RobPasMue)

PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,13 @@
+Checklist:
+- [] Run unit tests and make sure they all pass
+- [] Check and fix style errors
+		- pre-commit command line check
+		- Problems tab in PyCharm
+- [] Bench test new/modified APIs by using and modifying the code in the example for the API method
+- [] Add new methods to rst file for updated API script(<pysherlock>\doc\source\api)
+- [] Generate documentation
+- [] Verify the HTML. It gets generated at: <pysherlock>\doc\build\html.
+		- Open index.html
+		- Click on "API Reference" at the top.
+		- Verify HTML for API changes.
+- [] Check that test code coverage is at least 80% when Sherlock is running and can be connected to using gRPC

doc/source/api/analysis.rst

@@ -11,10 +11,15 @@ The ``analysis`` module contains all analysis capabilities.
      :toctree: _autosummary
 
      ansys.sherlock.core.analysis.Analysis.get_harmonic_vibe_input_fields
+     ansys.sherlock.core.analysis.Analysis.get_mechanical_shock_input_fields
      ansys.sherlock.core.analysis.Analysis.get_random_vibe_input_fields
+     ansys.sherlock.core.analysis.Analysis.get_solder_fatigue_input_fields
      ansys.sherlock.core.analysis.Analysis.run_analysis
      ansys.sherlock.core.analysis.Analysis.run_strain_map_analysis
      ansys.sherlock.core.analysis.Analysis.update_harmonic_vibe_props
+     ansys.sherlock.core.analysis.Analysis.update_mechanical_shock_props
      ansys.sherlock.core.analysis.Analysis.update_natural_frequency_props
+     ansys.sherlock.core.analysis.Analysis.update_part_modeling_props
      ansys.sherlock.core.analysis.Analysis.update_pcb_modeling_props
-     ansys.sherlock.core.analysis.Analysis.update_random_vibe_props
+     ansys.sherlock.core.analysis.Analysis.update_random_vibe_props
+     ansys.sherlock.core.analysis.Analysis.update_solder_fatigue_props

doc/source/api/common.rst

@@ -13,4 +13,5 @@ The ``common`` module contains all common capabilities.
      ansys.sherlock.core.common.Common.check
      ansys.sherlock.core.common.Common.exit
      ansys.sherlock.core.common.Common.is_sherlock_client_loading
+     ansys.sherlock.core.common.Common.list_solder_materials
      ansys.sherlock.core.common.Common.list_units

doc/source/api/index.rst

@@ -17,6 +17,8 @@ Use the search feature or click links to view API documentation.
    lifecycle
    model
    parts
+   layer_types
+   parts_types
    project
    stackup
 
@@ -29,5 +31,7 @@ Use the search feature or click links to view API documentation.
    ansys.sherlock.core.lifecycle
    ansys.sherlock.core.model
    ansys.sherlock.core.parts
+   ansys.sherlock.core.types.layer_types
+   ansys.sherlock.core.types.parts_types
    ansys.sherlock.core.project
    ansys.sherlock.core.stackup

doc/source/api/launcher.rst

@@ -12,3 +12,5 @@ The ``launcher`` module launches the Sherlock gRPC server and a Sherlock client.
      :toctree: _autosummary
 
      ansys.sherlock.core.launcher.launch_sherlock
+     ansys.sherlock.core.launcher.connect_grpc_channel
+

doc/source/api/layer.rst

@@ -12,3 +12,4 @@ The ``layer`` module contains all layer management capabilities.
      :toctree: _autosummary
 
      ansys.sherlock.core.layer.Layer.update_mount_points_by_file
+     ansys.sherlock.core.layer.Layer.add_potting_region

doc/source/api/layer_types.rst

@@ -0,0 +1,17 @@
+.. _ref_layer_types:
+
+Layer Types
+===========
+
+Classes used for the Layer API.
+
+.. currentmodule:: ansys.sherlock.core.types.layer_types
+
+.. autosummary::
+     :toctree: _autosummary
+
+     PolygonalShape
+     RectangularShape
+     SlotShape
+     CircularShape
+     PCBShape

doc/source/api/parts_types.rst

@@ -0,0 +1,13 @@
+.. _ref_parts_types:
+
+Parts Types
+===========
+
+Constants and classes used for the Parts API.
+
+.. currentmodule:: ansys.sherlock.core.types.parts_types
+
+.. autosummary::
+     :toctree: _autosummary
+
+     PartLocation

doc/source/api/project.rst

@@ -10,10 +10,12 @@ The ``project`` module contains all project management capabilities.
 .. autosummary::
      :toctree: _autosummary
 
+     ansys.sherlock.core.project.Project.add_cca
      ansys.sherlock.core.project.Project.add_strain_maps
      ansys.sherlock.core.project.Project.delete_project
      ansys.sherlock.core.project.Project.generate_project_report
      ansys.sherlock.core.project.Project.import_odb_archive
      ansys.sherlock.core.project.Project.import_ipc2581_archive
      ansys.sherlock.core.project.Project.list_ccas
-     ansys.sherlock.core.project.Project.list_strain_maps
+     ansys.sherlock.core.project.Project.list_strain_maps
+     ansys.sherlock.core.project.Project.add_project