.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "examples\gallery_examples\03-exporting\export_all_mount_points.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_examples_gallery_examples_03-exporting_export_all_mount_points.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_examples_gallery_examples_03-exporting_export_all_mount_points.py:


.. _ref_sherlock_export_mount_points:

=======================
Export All Mount Points
=======================

This example demonstrates how to connect to the Sherlock gRPC service, import a project,
and export all mount points for a CCA.

Description
-----------
Sherlock's gRPC API allows users to automate various workflows, including exporting all
mount points for a PCB.
This script demonstrates how to:
- Connect to the Sherlock service.
- Import a tutorial project.
- Export all mount points to a CSV file.

The exported mount points can be used for further analysis or design purposes.

.. GENERATED FROM PYTHON SOURCE LINES 40-52

.. code-block:: Python



    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 (
        SherlockExportAllMountPoints,
        SherlockImportProjectZipArchiveError,
    )


.. GENERATED FROM PYTHON SOURCE LINES 54-57

Connect to Sherlock
===================
Connect to the Sherlock service and ensure proper initialization.

.. GENERATED FROM PYTHON SOURCE LINES 57-60

.. code-block:: Python


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


.. GENERATED FROM PYTHON SOURCE LINES 61-64

Delete Project
==============
Delete the project if it already exists.

.. GENERATED FROM PYTHON SOURCE LINES 64-71

.. code-block:: Python


    try:
        sherlock.project.delete_project("Test")
        print("Project deleted successfully.")
    except Exception:
        pass


.. GENERATED FROM PYTHON SOURCE LINES 72-75

Import Tutorial Project
=======================
Import the tutorial project zip archive from the Sherlock tutorial directory.

.. GENERATED FROM PYTHON SOURCE LINES 75-86

.. code-block:: Python


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


.. GENERATED FROM PYTHON SOURCE LINES 87-90

Export All Mount Points
=======================
Export all mount points for the "Main Board" to a CSV file.

.. GENERATED FROM PYTHON SOURCE LINES 90-102

.. code-block:: Python


    try:
        mount_points_export_path = os.path.join(get_temp_dir(), "MountPointsExport.csv")
        sherlock.layer.export_all_mount_points(
            project="Test",
            cca_name="Main Board",
            export_file=mount_points_export_path,
            units="DEFAULT",
        )
        print(f"All mount points exported successfully to: {mount_points_export_path}")
    except SherlockExportAllMountPoints as e:
        print(f"Error exporting all mount points: {e}")


.. _sphx_glr_download_examples_gallery_examples_03-exporting_export_all_mount_points.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: export_all_mount_points.ipynb <export_all_mount_points.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: export_all_mount_points.py <export_all_mount_points.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: export_all_mount_points.zip <export_all_mount_points.zip>`