load_harmonic_profile

Lifecycle.load_harmonic_profile(project, phase_name, event_name, file_path, triaxial_axis, csv_file_properties=None)

Load a harmonic profile from a .csv or .dat file to a life cycle phase.

Available Since: 2021R1

Parameters:

project: str

Name of the Sherlock project

phase_name: str

Name of the life cycle phase to add the harmonic profile to.

event_name: str

Name of the harmonic event.

file_path: str

Path for .csv or .dat file with the harmonic profile.

triaxial_axis: str

Axis that this profile should be assigned to if the harmonic profile type is "Triaxial". Options are: "x", "y", and "z".

csv_file_properties: HarmonicProfileCsvFileProperties

Properties of the harmonic profile CSV file, required if the file is in CSV format.

Returns:

:

int

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 Project",
    cca_name="Card"
)

>>> sherlock.lifecycle.load_harmonic_profile(
        project="Test Project",
        phase_name="Phase 1",
        event_name="Harmonic Event",
        file_path="Test_Profile.csv",
        triaxial_axis="x",
        csv_file_properties=HarmonicVibeProfileCsvFileProperties(
            profile_name="Test Profile",
            header_row_count=0,
            numeric_format="English",
            column_delimiter=",",
            frequency_column="Frequency",
            frequency_units="HZ",
            load_column="Load",
            load_units="G"
        )
)