import_ipc2581_archive

Project.import_ipc2581_archive(archive_file: str, include_other_layers: bool, guess_part_properties: bool, project: str | None = None, cca_name: str | None = None, polyline_simplification: bool = False, polyline_tolerance: float = 0.1, polyline_tolerance_units: str = 'mm') → int

Import an IPC-2581 archive file.

Available Since: 2021R1

Parameters:

• archive_file (str) – Full path to the IPC-2581 archive file.

• include_other_layers (bool) – Whether to include other layers.

• guess_part_properties (bool) – Whether to guess part properties

• project (str, optional) – Name of the Sherlock project. The default is None, in which case the name of the IPC-2581 archive file is used for the project name.

• cca_name (str, optional) – Name of the CCA. The default is None, in which case the name of the IPC-2581 archive file is used for the CCA name.

• polyline_simplification (bool, optional) – Whether to enable polyline simplification

• polyline_tolerance (float, optional) – Polyline simplification tolerance

• polyline_tolerance_units (str, optional) – Polyline simplification tolerance units

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_ipc2581_archive("Tutorial.zip", True, True,
                        project="Tutorial",
                        cca_name="Card",
                        polyline_simplification=True,
                        polyline_tolerance=0.1,
                        polyline_tolerance_units="mm")