generate_project_report#

Project.generate_project_report(project: str, author: str, company: str, report_file: str) int#

Generate a project report.

Available Since: 2021R1

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

  • author (str) – Name of the author who is generating the report.

  • company (str) – Name of the author’s company.

  • report_file (str) – Full path to where to create the report.

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="Tutorial",
                        cca_name="Card")
>>> sherlock.project.generate_project_report(
    "Tutorial",
    "John Doe",
    "Example",
    "Project Report.pdf"
)