Update Laminate Layer Properties

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

Description

Sherlock’s gRPC API allows users to automate workflows such as updating laminate layer properties for printed circuit boards (PCBs). This script demonstrates how to:

• Connect to the Sherlock service.

• Import a project.

• Update laminate layer properties.

The updated properties can be used for further design validation and optimization.

import os

from examples.examples_globals import get_sherlock_tutorial_path

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

Connect to Sherlock

Connect to the Sherlock service and ensure proper initialization.

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

Traceback (most recent call last):
  File "C:\Users\ansys\actions-runner\_work\pysherlock\pysherlock\examples\01-project-configuration\update_laminate_layer.py", line 65, in <module>
    sherlock = launcher.connect(port=9092, timeout=10, 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(), "Auto Relay Project.zip"),
    )
    print("Tutorial project imported successfully.")
except SherlockImportProjectZipArchiveError as e:
    print("Error importing project zip archive.")

Update Laminate Layer Properties

Update the laminate layer properties for the “Main Board” of the “Test” project.

try:
    sherlock.stackup.update_laminate_layer(
        project="Test",
        cca_name="Auto Relay",
        layer="2",
        manufacturer="Generic",
        grade="Cyanate Ester",
        material="Generic CE Quartz",
        thickness=0.015,
        thickness_unit="in",
        construction_style="106",
        glass_construction=[("106", 71.0, 0.015, "in")],
        fiber_material="QUARTZ",
        conductor_material="GOLD",
        conductor_percent="10.0",
    )

    print("Laminate layer properties updated successfully.")
except SherlockUpdateLaminateLayerError as e:
    print("Error updating laminate layer properties.")