Export Net List

This example demonstrates how to connect to the Sherlock gRPC service, import a project, and export the net list associated with the imported project.

Description Sherlock’s gRPC API enables automation of various workflows, including net list export. This script demonstrates how to: - Connect to the Sherlock service. - Import a project. - Export the net list from the project.

import os

from examples.examples_globals import get_sherlock_tutorial_path, get_temp_dir

from ansys.sherlock.core import launcher
from ansys.sherlock.core.errors import (
    SherlockExportNetListError,
    SherlockImportProjectZipArchiveError,
)
from ansys.sherlock.core.types.common_types import TableDelimiter

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

Export Net List

Export the net list from the imported project.

try:
    net_list_path = os.path.join(get_temp_dir(), "exportedNetList.csv")
    sherlock.parts.export_net_list(
        project="Test",
        cca_name="Main Board",
        output_file=net_list_path,
        col_delimiter=TableDelimiter.COMMA,
        overwrite_existing=True,
        utf8_enabled=True,
    )
    print("Net list exported successfully.")
except SherlockExportNetListError as e:
    print("Error exporting net list.")