.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "examples\gallery_examples\01-project-configuration\update_thermal_maps.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_01-project-configuration_update_thermal_maps.py>`
        to download the full example code.

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

.. _sphx_glr_examples_gallery_examples_01-project-configuration_update_thermal_maps.py:


.. _ref_update_thermal_maps:

===================
Update Thermal Maps
===================

This example demonstrates how to connect to the Sherlock gRPC service, import a project,
and update thermal maps.

Description
-----------
Sherlock's gRPC API allows users to automate workflows such as updating thermal maps for printed
circuit boards (PCBs).
This script demonstrates how to:
- Connect to the Sherlock service.
- Import a project.
- Update thermal maps.

The updated thermal maps ensure the accuracy of thermal profiles and board configurations.

.. GENERATED FROM PYTHON SOURCE LINES 40-58

.. code-block:: Python



    import os

    from examples.examples_globals import get_sherlock_tutorial_path

    from ansys.sherlock.core import launcher
    from ansys.sherlock.core.errors import SherlockImportProjectZipArchiveError
    from ansys.sherlock.core.types.project_types import (
        BoardBounds,
        ImageBounds,
        ImageFile,
        LegendBounds,
        LegendOrientation,
        ThermalBoardSide,
        ThermalMapsFileType,
    )


.. GENERATED FROM PYTHON SOURCE LINES 60-63

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

.. GENERATED FROM PYTHON SOURCE LINES 63-66

.. code-block:: Python


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


.. GENERATED FROM PYTHON SOURCE LINES 67-70

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

.. GENERATED FROM PYTHON SOURCE LINES 70-77

.. code-block:: Python


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


.. GENERATED FROM PYTHON SOURCE LINES 78-81

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

.. GENERATED FROM PYTHON SOURCE LINES 81-92

.. 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 93-96

Update Thermal Maps
===================
Update the thermal maps for the "Tutorial Project".

.. GENERATED FROM PYTHON SOURCE LINES 96-152

.. code-block:: Python


    try:
        thermal_map_properties = ImageFile(
            board_bounds=BoardBounds([(1.0, 2.0), (5.0, 1.0), (5.0, 5.0), (1.0, 5.0)]),
            coordinate_units="mm",
            image_bounds=ImageBounds(-95, -57, 114, 290),
            legend_bounds=LegendBounds(1.0, 2.0, 4.0, 2.0),
            legend_orientation=LegendOrientation.VERTICAL,
            min_temperature=17.0,
            min_temperature_units="C",
            max_temperature=90.0,
            max_temperature_units="C",
        )

        add_thermal_map_files = [
            {
                "thermal_map_file": os.path.join(
                    get_sherlock_tutorial_path(), "ThermalMaps", "Thermal Image.jpg"
                ),
                "thermal_map_file_properties": [
                    {
                        "file_name": "Thermal Image.jpg",
                        "file_type": ThermalMapsFileType.IMAGE,
                        "file_comment": "Update thermal map",
                        "thermal_board_side": ThermalBoardSide.BOTH,
                        "file_data": thermal_map_properties,
                        "thermal_profiles": ["Environmental/1 - Temp Cycle - Min"],
                        "cca_names": ["Main Board"],
                    },
                ],
            }
        ]
        sherlock.project.add_thermal_maps(
            project="Test",
            add_thermal_map_files=add_thermal_map_files,
        )

        thermal_map_files = [
            {
                "file_name": "Thermal Image.jpg",
                "file_type": ThermalMapsFileType.IMAGE,
                "file_comment": "Update thermal map",
                "thermal_board_side": ThermalBoardSide.TOP,
                "file_data": thermal_map_properties,
                "thermal_profiles": ["Environmental/1 - Temp Cycle - Max"],
                "cca_names": ["Main Board"],
            },
        ]
        sherlock.project.update_thermal_maps(
            project="Test",
            thermal_map_files=thermal_map_files,
        )

        print("Thermal maps updated successfully.")
    except Exception as e:
        print(f"Error adding or updating thermal maps")


.. _sphx_glr_download_examples_gallery_examples_01-project-configuration_update_thermal_maps.py:

.. only:: html

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

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

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

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

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

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

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