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)

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(f"Error importing project zip archive: {e}")

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(f"Net list exported successfully to: {net_list_path}")
except SherlockExportNetListError as e:
    print(f"Error exporting net list: {e}")