add_strain_maps#

Project.add_strain_maps(project, strain_maps)#

Add CSV files with strain maps to the CCAs.

Parameters:
  • project (str) – Name of the Sherlock project to add strain maps to.

  • strain_maps (List of (strain_map_file, file_comment, header_row_count, reference_id_column, strain_column, strain_units, ccas) required) –

    strain_map_filestr

    Full path to the strain map file to add to the project.

    file_commentstr

    File comment to associate with the strain map file.

    header_row_countint

    Number of rows before the file’s column header.

    reference_id_columnstr

    Name of the column in the file with the reference IDs.

    strain_columnstr

    Name of the column in the file with the strain values.

    strain_unitsstr

    Strain units: Options are µε and ε.

    ccasList of (cca_name), optional

    List of CCA names to assign the strain map file to. When no list is specified, the strain map is assigned to all CCAs in the project.

Examples

>>> from ansys.sherlock.core.launcher import launch_sherlock
>>> sherlock = launch_sherlock()
>>> project.add_strain_maps("Tutorial Project",
    [("StrainMap.csv",
    "This is the strain map file for the project",
    0,
    "refDes",
    "strain",
    "µε"
    ["Main Board"])
    )],