run_analysis#

Analysis.run_analysis(project, cca_name, analyses)#

Run one or more Sherlock analyses.

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

  • cca_name (str) – Name of the CCA.

  • analyses (list of elements) –

    • elements: list

      Tuples (type, event)

      • analysis_typeRunAnalysisRequestAnalysisType

        Type of analysis to run.

      • eventlist

        Tuples (phase_name, event_name)

        • phase_namestr

          Name of the life cycle phase.

        • event_namestr

          Name of the life cycle event.

Returns:

Status code of the response. 0 for success.

Return type:

int

Examples

>>> from ansys.sherlock.core.launcher import launch_sherlock
>>> sherlock = launch_sherlock()
>>> sherlock.project.import_odb_archive(
    "ODB++ Tutorial.tgz",
    True,
    True,
    True,
    True,
    project="Test",
    cca_name="Card",
)
>>> sherlock.analysis.run_analysis(
    "Test",
    "Card",
    [
        (RunAnalysisRequestAnalysisType.NATURAL_FREQ,
        [
            ("Phase 1", ["Harmonic Event"])
        ]
        )
    ]
)