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

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

.. _sphx_glr_examples_gallery_examples_01-project-configuration_add_harmonic_event.py:


.. _ref_add_harmonic_event:

=====================================
Add Harmonic Event to Lifecycle Phase
=====================================

This example demonstrates how to launch the Sherlock gRPC service, import a project,
create a lifecycle phase, and add a harmonic event to the phase, then properly close the connection.

Description
-----------
Sherlock's gRPC API allows users to automate workflows such as creating lifecycle phases
and adding harmonic events.
This script demonstrates how to:
- Connect to the Sherlock service.
- Import a project.
- Create a lifecycle phase.
- Add a harmonic event to the lifecycle phase.

The harmonic event can be used for thermal analysis and helps in simulating the effects
of various conditions on the board.

.. GENERATED FROM PYTHON SOURCE LINES 42-55

.. code-block:: Python



    import os

    from examples.examples_globals import get_sherlock_tutorial_path

    from ansys.sherlock.core import LOG, launcher
    from ansys.sherlock.core.errors import (
        SherlockAddHarmonicEventError,
        SherlockCreateLifePhaseError,
        SherlockImportProjectZipArchiveError,
    )


.. GENERATED FROM PYTHON SOURCE LINES 57-60

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

.. GENERATED FROM PYTHON SOURCE LINES 60-64

.. code-block:: Python


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



.. GENERATED FROM PYTHON SOURCE LINES 65-68

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

.. GENERATED FROM PYTHON SOURCE LINES 68-75

.. code-block:: Python


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


.. GENERATED FROM PYTHON SOURCE LINES 76-79

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

.. GENERATED FROM PYTHON SOURCE LINES 79-92

.. 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"),
        )
        LOG.info("Tutorial project imported successfully.")
    except SherlockImportProjectZipArchiveError as e:
        LOG.error(f"Error importing project zip archive: {e}")

    phase_name = "Life Phase Example"


.. GENERATED FROM PYTHON SOURCE LINES 93-96

Create Lifecycle Phase
======================
Create a new lifecycle phase called "Example" in the "Test" project.

.. GENERATED FROM PYTHON SOURCE LINES 96-111

.. code-block:: Python


    try:
        sherlock.lifecycle.create_life_phase(
            project="Test",
            phase_name=phase_name,
            duration=1.5,
            duration_units="sec",
            num_of_cycles=4.0,
            cycle_type="COUNT",
            description="Example phase",
        )
        LOG.info("Lifecycle phase 'Example' created successfully.")
    except SherlockCreateLifePhaseError as e:
        LOG.error(f"Error creating lifecycle phase: {e}")


.. GENERATED FROM PYTHON SOURCE LINES 112-115

Add Harmonic Event to Lifecycle Phase
=====================================
Add a harmonic event to the "Example" lifecycle phase.

.. GENERATED FROM PYTHON SOURCE LINES 115-134

.. code-block:: Python


    try:
        sherlock.lifecycle.add_harmonic_event(
            project="Test",
            phase_name=phase_name,
            event_name="Event1",
            duration=1.5,
            duration_units="sec",
            num_of_cycles=4.0,
            cycle_type="PER MIN",
            sweep_rate=5,
            orientation="23.45, 34.56",
            profile_type="Uniaxial",
            load_direction="2,4,5",
            description="Harmonic Event Example",
        )
        LOG.info("Harmonic event 'Event1' added successfully.")
    except SherlockAddHarmonicEventError as e:
        LOG.error(f"Error adding harmonic event: {str(e)}")


.. _sphx_glr_download_examples_gallery_examples_01-project-configuration_add_harmonic_event.py:

.. only:: html

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

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

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

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

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

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

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