Merge branch 'main' into release/0.2

.github/labeler.yml

@@ -1,14 +1,12 @@
 documentation:
-- doc/**/*
-- README.rst
-- CONTRIBUTING.md
+- changed-files:
+  - any-glob-to-any-file: ['doc/**/*', 'README.rst', 'CONTRIBUTING.md']
 maintenance:
-- .github/**/*
-- .flake8
-- pyproject.toml
-- tox.ini
-- .gitignore
+- changed-files:
+  - any-glob-to-any-file: ['.github/**/*', '.flake8' , 'pyproject.toml', 'tox.ini', '.gitignore']
 dependencies:
-- pyproject.toml
+- changed-files:
+  - any-glob-to-any-file: ['pyproject.toml']
 testing:
-- tests/*
+- changed-files:
+  - any-glob-to-any-file: ['tests/*']

.github/workflows/ci_cd.yml

@@ -24,7 +24,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: PyAnsys code style checks
-        uses: ansys/actions/code-style@v4
+        uses: ansys/actions/code-style@v5
         with:
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
 
@@ -33,7 +33,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: PyAnsys documentation style checks
-        uses: ansys/actions/doc-style@v4
+        uses: ansys/actions/doc-style@v5
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
 
@@ -53,7 +53,7 @@ jobs:
             os: macos-latest
     steps:
       - name: Build wheelhouse and perform smoke test
-        uses: ansys/actions/build-wheelhouse@v4
+        uses: ansys/actions/build-wheelhouse@v5
         with:
           library-name: ${{ env.PACKAGE_NAME }}
           library-namespace: ${{ env.PACKAGE_NAMESPACE }}
@@ -72,7 +72,7 @@ jobs:
       - uses: actions/checkout@v4
 
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -94,7 +94,7 @@ jobs:
           pytest -v --cov=ansys.sherlock --cov-report=term --cov-report=html:.cov/html --cov-report=xml:.cov/coverage.xml
 
       - name: Upload coverage results
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         if: env.MAIN_PYTHON_VERSION == matrix.python-version
         with:
           name: coverage-results
@@ -103,15 +103,19 @@ jobs:
 
       - name: Upload coverage to Codecov
         if: env.MAIN_PYTHON_VERSION == matrix.python-version
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v4
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+        with:
+          files: .cov/coverage.xml
 
   docs:
     name: Documentation
     needs: [ docs-style ]
     runs-on: ubuntu-latest
     steps:
       - name: Run documentation building action
-        uses: ansys/actions/doc-build@v4
+        uses: ansys/actions/doc-build@v5
         with:
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
 
@@ -121,7 +125,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Build library source and wheel artifacts
-        uses: ansys/actions/build-library@v4
+        uses: ansys/actions/build-library@v5
         with:
           library-name: ${{ env.PACKAGE_NAME }}
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
@@ -133,14 +137,14 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Release to the public PyPI repository
-        uses: ansys/actions/release-pypi-public@v4
+        uses: ansys/actions/release-pypi-public@v5
         with:
           library-name: ${{ env.PACKAGE_NAME }}
           twine-username: "__token__"
           twine-token: ${{ secrets.PYPI_TOKEN }}
 
       - name: Release to GitHub
-        uses: ansys/actions/release-github@v4
+        uses: ansys/actions/release-github@v5
         with:
           library-name: ${{ env.PACKAGE_NAME }}
 
@@ -151,7 +155,7 @@ jobs:
     needs: [ package ]
     steps:
       - name: Deploy the latest documentation
-        uses: ansys/actions/doc-deploy-dev@v4
+        uses: ansys/actions/doc-deploy-dev@v5
         with:
           cname: ${{ env.DOCUMENTATION_CNAME }}
           token: ${{ secrets.GITHUB_TOKEN }}
@@ -163,7 +167,7 @@ jobs:
     needs: [ release ]
     steps:
       - name: Deploy the stable documentation
-        uses: ansys/actions/doc-deploy-stable@v4
+        uses: ansys/actions/doc-deploy-stable@v5
         with:
           cname: ${{ env.DOCUMENTATION_CNAME }}
           token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/label.yml

@@ -32,10 +32,10 @@ jobs:
 
     # Label based on modified files
     - name: Label based on changed files
-      uses: actions/labeler@v4
+      uses: actions/labeler@v5
       with:
         repo-token: ${{ secrets.GITHUB_TOKEN }}
-        sync-labels: ''
+        sync-labels: true
 
     # Label based on branch name
     - uses: actions-ecosystem/action-add-labels@v1
@@ -70,7 +70,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Suggest to add labels
-      uses: peter-evans/create-or-update-comment@v3
+      uses: peter-evans/create-or-update-comment@v4
       # Execute only when no labels have been applied to the pull request
       if: toJSON(github.event.pull_request.labels.*.name) == '{}'
       with:

PULL_REQUEST_TEMPLATE.md

@@ -4,7 +4,7 @@ Checklist:
 		- 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)
+- [] Add new classes to rst files, located at: <pysherlock>\doc\source\api
 - [] Generate documentation
 - [] Verify the HTML. It gets generated at: <pysherlock>\doc\build\html.
 		- Open index.html

doc/source/api/analysis.rst

@@ -3,25 +3,9 @@
 Analysis
 ========
 
-The ``analysis`` module contains all analysis capabilities.
-
-.. currentmodule:: ansys.sherlock.core.analysis
+.. automodule:: ansys.sherlock.core.analysis
 
 .. autosummary::
      :toctree: _autosummary
 
-     ansys.sherlock.core.analysis.Analysis.get_harmonic_vibe_input_fields
-     ansys.sherlock.core.analysis.Analysis.get_ict_analysis_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_ict_analysis_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_solder_fatigue_props
+     ansys.sherlock.core.analysis.Analysis

doc/source/api/common.rst

@@ -3,15 +3,9 @@
 Common
 ======
 
-The ``common`` module contains all common capabilities.
-
-.. currentmodule:: ansys.sherlock.core.common
+.. automodule:: ansys.sherlock.core.common
 
 .. autosummary::
      :toctree: _autosummary
 
-     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
+     ansys.sherlock.core.common.Common

doc/source/api/index.rst

@@ -20,6 +20,7 @@ Use the search feature or click links to view API documentation.
    layer_types
    parts_types
    project
+   project_types
    stackup
 
 .. autosummary::
@@ -34,4 +35,5 @@ Use the search feature or click links to view API documentation.
    ansys.sherlock.core.types.layer_types
    ansys.sherlock.core.types.parts_types
    ansys.sherlock.core.project
+   ansys.sherlock.core.types.project_types
    ansys.sherlock.core.stackup

doc/source/api/launcher.rst

@@ -4,9 +4,7 @@
 Launcher
 ========
 
-The ``launcher`` module launches the Sherlock gRPC server and a Sherlock client.
-
-.. currentmodule:: ansys.sherlock.core.launcher
+.. automodule:: ansys.sherlock.core.launcher
 
 .. autosummary::
      :toctree: _autosummary

doc/source/api/layer.rst

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

doc/source/api/lifecycle.rst

@@ -4,21 +4,9 @@
 Lifecycle
 =========
 
-The ``lifecycle`` module contains all life cycle management capabilities.
-
-.. currentmodule:: ansys.sherlock.core.lifecycle
+.. automodule:: ansys.sherlock.core.lifecycle
 
 .. autosummary::
      :toctree: _autosummary
 
-     ansys.sherlock.core.lifecycle.Lifecycle.add_harmonic_event
-     ansys.sherlock.core.lifecycle.Lifecycle.add_harmonic_vibe_profiles
-     ansys.sherlock.core.lifecycle.Lifecycle.add_random_vibe_event
-     ansys.sherlock.core.lifecycle.Lifecycle.add_random_vibe_profiles
-     ansys.sherlock.core.lifecycle.Lifecycle.add_shock_event
-     ansys.sherlock.core.lifecycle.Lifecycle.add_shock_profiles
-     ansys.sherlock.core.lifecycle.Lifecycle.add_thermal_event
-     ansys.sherlock.core.lifecycle.Lifecycle.add_thermal_profiles
-     ansys.sherlock.core.lifecycle.Lifecycle.create_life_phase
-     ansys.sherlock.core.lifecycle.Lifecycle.load_harmonic_profile
-     ansys.sherlock.core.lifecycle.Lifecycle.load_random_vibe_profile
+     ansys.sherlock.core.lifecycle.Lifecycle

doc/source/api/model.rst

@@ -3,12 +3,9 @@
 Model
 =====
 
-The ``model`` module contains all model generation capabilities.
-
-.. currentmodule:: ansys.sherlock.core.model
+.. automodule:: ansys.sherlock.core.model
 
 .. autosummary::
      :toctree: _autosummary
 
-     ansys.sherlock.core.model.Model.export_trace_reinforcement_model
-     ansys.sherlock.core.model.Model.generate_trace_model
+     ansys.sherlock.core.model.Model

doc/source/api/parts.rst

@@ -2,19 +2,8 @@
 
 Parts
 =====
-
-The ``parts`` module contains all parts management capabilities.
-
-.. currentmodule:: ansys.sherlock.core.parts
-
+.. automodule:: ansys.sherlock.core.parts
 .. autosummary::
      :toctree: _autosummary
 
-     ansys.sherlock.core.parts.Parts.enable_lead_modeling
-     ansys.sherlock.core.parts.Parts.export_parts_list
-     ansys.sherlock.core.parts.Parts.import_parts_list
-     ansys.sherlock.core.parts.Parts.update_parts_list
-     ansys.sherlock.core.parts.Parts.update_parts_locations
-     ansys.sherlock.core.parts.Parts.update_parts_locations_by_file
-     ansys.sherlock.core.parts.Parts.get_part_location
-     ansys.sherlock.core.parts.Parts.update_parts_from_AVL
+     ansys.sherlock.core.parts.Parts

doc/source/api/parts_types.rst

@@ -2,16 +2,21 @@
 
 Parts Types
 ===========
-
-Constants and classes used for the Parts API.
-
+.. automodule:: ansys.sherlock.core.types.parts_types
 .. currentmodule:: ansys.sherlock.core.types.parts_types
 
-.. autosummary::
-     :toctree: _autosummary
+Constants
+---------
+.. autoclass:: AVLDescription
+     :members:
+.. autoclass:: AVLPartNum
+     :members:
+.. autoclass:: PartsListSearchDuplicationMode
+     :members:
+.. autoclass:: PartsListSearchMatchingMode
+     :members:
 
-     PartLocation
-     PartsListSearchMatchingMode
-     PartsListSearchDuplicationMode
-     AVLPartNum
-     AVLDescription
+Classes
+-------
+.. autoclass:: PartLocation
+     :members:

doc/source/api/project.rst

@@ -3,19 +3,9 @@
 Project
 =======
 
-The ``project`` module contains all project management capabilities.
-
-.. currentmodule:: ansys.sherlock.core.project
+.. automodule:: ansys.sherlock.core.project
 
 .. 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.add_project
+     ansys.sherlock.core.project.Project