run_strain_map_analysis

Analysis.run_strain_map_analysis(project: str, cca_name: str, strain_map_analyses: list[list[RunStrainMapAnalysisRequestAnalysisType | list[list[str]]]]) → int

Run one or more strain map analyses.

Available Since: 2023R2

Parameters:

• project (str) – Name of the Sherlock project.

• cca_name (str) – Name of the main CCA for the analysis.

• strain_map_analyses (list[list[RunStrainMapAnalysisRequestAnalysisType | list[list[str]]]]) –

  Analyses consisting of these properties:

  • analysis_type: RunStrainMapAnalysisRequestAnalysisType

    Type of analysis to run.

  • event_strain_maps: list

    Strain maps assigned to the desired life cycle events for a given PCB side. The list consists of these properties:

    • phase_name: str

      Life cycle phase name for the strain map assignment.

    • event_name: str

      Life cycle event name for the strain map assignment.

    • pcb_side: str

      PCB side for the strain map. Options are "TOP" and "BOTTOM".

    • strain_map: str

      Name of the strain map assigned to the life cycle event.

    • sub_assembly_name: str, optional

      Name of the subassembly CCA to assign the strain map to.

Returns:

Status code of the response. 0 for success.

Return type:

int

Examples

>>> from ansys.sherlock.core.launcher import launch_sherlock
>>> from ansys.sherlock.core.types.analysis_types import (
>>>     RunStrainMapAnalysisRequestAnalysisType
>>> )
>>> sherlock = launch_sherlock()
>>> analysis_request = SherlockAnalysisService_pb2.RunStrainMapAnalysisRequest
>>> sherlock.analysis.run_strain_map_analysis(
        "AssemblyTutorial",
        "Main Board",
        [[
            RunStrainMapAnalysisRequestAnalysisType.RANDOM_VIBE,
            [["Phase 1", "Random Vibe", "TOP", "MainBoardStrain - Top"],
             ["Phase 1", "Random Vibe", "BOTTOM", "MainBoardStrain - Bottom"],
             ["Phase 1", "Random Vibe", "TOP", "MemoryCard1Strain", "Memory Card 1"]],
        ]]
    )