.. 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_aedb.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_aedb.py>`
        to download the full example code.

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

.. _sphx_glr_examples_gallery_examples_03-exporting_export_aedb.py:


.. _ref_sherlock_export_aedb:

===========
Export AEDB
===========

This example demonstrates how to connect to the Sherlock gRPC service, import a project,
and export an AEDB file for a CCA.

Description
-----------
Sherlock's gRPC API allows users to automate workflows such as exporting an AEDB file for a CCA.
This script demonstrates how to:

- Connect to the Sherlock service.
- Import a project.
- Export an AEDB file.

The exported AEDB file can be used for further analysis or integration with other software tools.

.. GENERATED FROM PYTHON SOURCE LINES 40-49

.. 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 SherlockExportAEDBError, SherlockImportProjectZipArchiveError


.. GENERATED FROM PYTHON SOURCE LINES 51-54

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

.. GENERATED FROM PYTHON SOURCE LINES 54-57

.. code-block:: Python


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


.. GENERATED FROM PYTHON SOURCE LINES 58-61

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

.. GENERATED FROM PYTHON SOURCE LINES 61-68

.. code-block:: Python


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


.. GENERATED FROM PYTHON SOURCE LINES 69-72

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

.. GENERATED FROM PYTHON SOURCE LINES 72-83

.. code-block:: Python


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


.. GENERATED FROM PYTHON SOURCE LINES 84-87

Export AEDB File
=================
Export the AEDB file for the "Card" of the "Test" project to the specified path.

.. GENERATED FROM PYTHON SOURCE LINES 87-98

.. code-block:: Python


    try:
        aedb_export_path = os.path.join(get_temp_dir(), "test.aedb")
        sherlock.model.export_aedb(
            project_name="Test",
            cca_name="Auto Relay",
            export_file=aedb_export_path,
        )
        print(f"AEDB file exported successfully to: {aedb_export_path}")
    except SherlockExportAEDBError as e:
        print(f"Error exporting AEDB: {e}")


.. _sphx_glr_download_examples_gallery_examples_03-exporting_export_aedb.py:

.. only:: html

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

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

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

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

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

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

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