Update Part Modeling Properties

This example demonstrates how to connect to the Sherlock gRPC service, import a project, and update part modeling properties.

Description

Sherlock’s gRPC API allows users to automate workflows such as updating part modeling properties for printed circuit boards (PCBs). This script demonstrates how to: - Connect to the Sherlock service. - Import a project. - Update part modeling properties.

The updated properties ensure accurate simulation results for mechanical and thermal analyses.

import os

from examples.examples_globals import SHERLOCK_CONNECT_TIMEOUT, get_sherlock_tutorial_path

from ansys.sherlock.core import launcher
from ansys.sherlock.core.errors import (
    SherlockImportProjectZipArchiveError,
    SherlockUpdatePartModelingPropsError,
)

Connect to Sherlock

Connect to the Sherlock service and ensure proper initialization.

sherlock = launcher.connect(port=9092, timeout=SHERLOCK_CONNECT_TIMEOUT, transport_mode="wnua")

Traceback (most recent call last):
  File "C:\Users\ansys\actions-runner\_work\pysherlock\pysherlock\examples\01-project-configuration\update_part_modeling_properties.py", line 64, in <module>
    sherlock = launcher.connect(port=9092, timeout=SHERLOCK_CONNECT_TIMEOUT, transport_mode="wnua")
  File "C:\Users\ansys\actions-runner\_work\pysherlock\pysherlock\.venv\Lib\site-packages\ansys\sherlock\core\launcher.py", line 324, in connect
    raise e
  File "C:\Users\ansys\actions-runner\_work\pysherlock\pysherlock\.venv\Lib\site-packages\ansys\sherlock\core\launcher.py", line 306, in connect
    _wait_for_sherlock_grpc_ready(channel, timeout)
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^
  File "C:\Users\ansys\actions-runner\_work\pysherlock\pysherlock\.venv\Lib\site-packages\ansys\sherlock\core\launcher.py", line 395, in _wait_for_sherlock_grpc_ready
    raise SherlockConnectionError(message="Error starting gRPC service")
ansys.sherlock.core.errors.SherlockConnectionError: gRPC connection error: Error starting gRPC service

Delete Project

Delete the project if it already exists.

try:
    sherlock.project.delete_project("Test")
    print("Project deleted successfully.")
except Exception:
    pass

Import Tutorial Project

Import the tutorial project zip archive from the Sherlock tutorial directory.

try:
    sherlock.project.import_project_zip_archive(
        project="Test",
        category="Demos",
        archive_file=os.path.join(get_sherlock_tutorial_path(), "Tutorial Project.zip"),
    )
    print("Tutorial project imported successfully.")
except SherlockImportProjectZipArchiveError as e:
    print("Error importing project zip archive.")

Update Part Modeling Properties

Update the part modeling properties for the “Card” of the “Test” project.

try:
    modeling_props = {
        "cca_name": "Main Board",
        "part_enabled": True,
        "part_min_size": 1,
        "part_min_size_units": "in",
        "part_elem_order": "First Order (Linear)",
        "part_max_edge_length": 1,
        "part_max_edge_length_units": "in",
        "part_max_vertical": 1,
        "part_max_vertical_units": "in",
        "part_results_filtered": True,
    }
    sherlock.analysis.update_part_modeling_props(
        project="Test",
        part_modeling_props=modeling_props,
    )
    print("Part modeling properties updated successfully.")
except SherlockUpdatePartModelingPropsError as e:
    print("Error updating part modeling properties.")