Sherlock Trace Model Export

This example demonstrates how to connect to the Sherlock gRPC service, import a project, generate export parameters for copper layers, and export a trace model.

Description Sherlock’s gRPC API enables automation of various workflows, including trace model exports. This script demonstrates how to: - Connect to the Sherlock service. - Import a tutorial project ZIP archive. - Generate copper layer parameters for trace model export. - Export a trace model with multiple copper layers.

import os

from ansys.api.sherlock.v0 import SherlockAnalysisService_pb2, SherlockModelService_pb2
from ansys.api.sherlock.v0.SherlockModelService_pb2 import GeometryType
from examples.examples_globals import get_sherlock_tutorial_path, get_temp_dir

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

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\03-exporting\export_trace_model.py", line 63, 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 a sample project ZIP archive provided with the Sherlock installation.

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.")

Export Trace Model

Export a trace model.

try:
    copper_1_layer = sherlock.model.createExportTraceCopperLayerParams(
        project_name="Test",
        cca_name="Auto Relay",
        output_file_path=os.path.join(get_temp_dir(), "outputfile_path.stp"),
        copper_layer="AutoRelayBot.gbr",
        overwrite=True,
        display_after=False,
        clear_FEA_database=False,
        use_FEA_model_ID=False,
        coord_units="mm",
        mesh_type=SherlockModelService_pb2.MeshType.NONE,
        is_modeling_region_enabled=False,
        trace_output_type=SherlockModelService_pb2.TraceOutputType.ALL_REGIONS,
        element_order=SherlockAnalysisService_pb2.ElementOrder.Linear,
        max_mesh_size=1.0,
        max_mesh_size_units="mm",
        max_holes_per_trace=3,
        is_drill_hole_modeling_enabled=False,
        drill_hole_min_diameter=1.0,
        drill_hole_min_diameter_units="mm",
        drill_hole_max_edge_length=1.0,
        drill_hole_max_edge_length_units="mm",
        geometry_type=GeometryType.Step,
    )
    copper_2_layer = sherlock.model.createExportTraceCopperLayerParams(
        project_name="Test",
        cca_name="Auto Relay",
        output_file_path=os.path.join(get_temp_dir(), "outputfile_path2.stp"),
        copper_layer="AutoRelayTop.gbr",
        overwrite=True,
        display_after=False,
        clear_FEA_database=False,
        use_FEA_model_ID=False,
        coord_units="mm",
        mesh_type=SherlockModelService_pb2.MeshType.NONE,
        is_modeling_region_enabled=False,
        trace_output_type=SherlockModelService_pb2.TraceOutputType.ALL_REGIONS,
        element_order=SherlockAnalysisService_pb2.ElementOrder.Linear,
        max_mesh_size=1.0,
        max_mesh_size_units="mm",
        max_holes_per_trace=3,
        is_drill_hole_modeling_enabled=False,
        drill_hole_min_diameter=1.0,
        drill_hole_min_diameter_units="mm",
        drill_hole_max_edge_length=1.0,
        drill_hole_max_edge_length_units="mm",
        geometry_type=GeometryType.Step,
    )
    sherlock.model.exportTraceModel([copper_1_layer, copper_2_layer])
    print("Trace models exported successfully.")
except SherlockModelServiceError as e:
    print("Error exporting trace model.")