export_project#

Project.export_project(project_name: str, export_design_files: bool, export_result_files: bool, export_archive_results: bool, export_user_files: bool, export_log_files: bool, export_system_data: bool, export_file_dir: str, export_file_name: str, overwrite_existing_file: bool) → int#

Export a sherlock project.

Available Since: 2025R1

Parameters:

  • project_name (str) – Name of the project being exported.

  • export_design_files (bool) – Determines if design files should be exported.

  • export_result_files (bool) – Determines if all analysis module result files should be exported.

  • export_archive_results (bool) – Determines if all archive result files should be exported.

  • export_user_files (bool) – Determines if user properties and custom data files should be exported.

  • export_log_files (bool) – Determines if Sherlock console and application log files should be exported.

  • export_system_data (bool) – Determines if system technical data should be exported.

  • export_file_dir (str) – Destination of export file.

  • export_file_name (str) – Name to be given to the exported file.

  • overwrite_existing_file (bool) – Determines if exported file will overwrite a previously existing file.

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.export_project("Tutorial Project",
True,
True,
True,
True,
True,
True,
"C:/Path/To/Exported/Project",
"Exported_Project",
True)