Add Circuit Card Assembly

This example demonstrates how to connect to the Sherlock gRPC service, import a project, and add a CCA (Circuit Card Assembly) to a project.

Description

Sherlock’s gRPC API allows users to automate workflows such as adding CCAs to a project and importing ODB++ archives. This script demonstrates how to: - Connect to the Sherlock service. - Import a project. - Add CCAs to the project.

The added CCAs allow for proper circuit analysis and component tracking within the project.

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 SherlockAddCCAError, SherlockImportProjectZipArchiveError

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\add_cca.py", line 61, 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(), "Auto Relay Project.zip"),
    )
    print("Tutorial project imported successfully.")
except SherlockImportProjectZipArchiveError as e:
    print("Error importing project.")

Add CCA to Project

Add a CCA to a project.

try:
    sherlock.project.add_cca(
        project="Test",
        cca_properties=[
            {
                "cca_name": "Card 2",
                "description": "Second CCA",
                "default_solder_type": "SAC305",
                "default_stencil_thickness": 10,
                "default_stencil_thickness_units": "mm",
                "default_part_temp_rise": 20,
                "default_part_temp_rise_units": "C",
                "guess_part_properties_enabled": False,
            }
        ],
    )
    print("Card 2 added successfully.")
except SherlockAddCCAError as e:
    print("Error adding CCA.")