ANSYS HFSS

Note: Users must procure and maintain valid licenses to integrate this commercial DE tool with the Istari Digital platform. Please contact your local IT administrator for assistance.

Supported Functions:

extract

run

The following table lists the extract and simulation functions currently supported by the HFSS:

Function Name	Description	Required Parameters	Optional Model Inputs	Optional Parameters	Example Input
extract_input	Input Extraction function. aedt format files are supported.	model_id	None	None	"input_arguments": {}
extract_results	Results Extraction function. aedtz format files are supported.	model_id	None	None	"input_arguments": {}
run	Simulation Execution function, aedt & aedtz format files are supported.	model_id	None	None	"input_arguments": {}

Getting Started

The HFSS module contains tools for executing HFSS simulations and extracting various input and output data from HFSS models.

Methods to Link to Istari Digital Platform

Upload: Yes

Link: No

Files Supported

The istari Digital Platform can extract from the following file types:

• .aedt
• .aedtz

All other HFSS file types not supported at this time. Please submit a feature request if an important file type is not supported.

Example Files

Setup for Administrators

Ensure that ANSYS HFSS 2024 is installed on a Virtual Machine (VM) with Istari Digital Agent and appropriate Istari Digital Software.
Verify that the installation is up to date with the latest patches and updates.

Version Compatibility

This module extracts information from HFSS input data format (aedt) and results (aedtz) files.

Function Coverage and Outputs

The HFSS module software can produce a number of artifacts extracted from the HFSS model. The table below describes each output artifact and its type.

Route	Coverage	Artifact Content Example
Simulation Execution [Messages] - JSON	Yes
Simulation Execution [Metrics] - JSON	Yes
Extract Input [Messages] - JSON	Yes
Extract Input [Inputs] - JSON	Yes
Extract Input [Materials] - JSON	Yes
Extract Input [OBJ Model View] - OBJ	Yes
Extract Results [Messages] - JSON	Yes
Extract Results [Results Data] - CSV	Yes
Extract Results [Results Plot] - GIF	Yes

Detailed SDK Reference

Prerequisite: Install Istari Digital SDK and initialize Istari Digital Client per instructions here

Step 1: Upload and Extract the File(s)

Upload the file as a model

model = client.add_model(
    path="example.aedt",
    description="HFSS example model",
    display_name="HFSS Model Name",
)
print(f"Uploaded base model with ID {model.id}")

Extract model summary information from a HFSS input file once you have the model ID

extraction_job = client.add_job(
    model_id  = model.id,
    function  = "@istari:extract_input",
    tool_name = "ansys_hfss",
    tool_version = "2024",
    operating_system = "Windows 10",
)
print(f"Extraction started for model ID {model.id}, job ID: {extraction_job.id}")

Please choose appropriate function, tool_name, tool_version, and operating_system for your installation of this software.
Above is an example of how to call the function

Extract results summary information from HFSS output.

extraction_job = client.add_job(
    model_id  = model.id,
    function  = "@istari:extract_results",
    tool_name = "ansys_hfss",
    tool_version = "2024",
    operating_system = "Windows 10",
)
print(f"Extraction started for model ID {model.id}, job ID: {extraction_job.id}")

Please choose appropriate function, tool_name, tool_version, and operating_system for your installation of this software.
Above is an example of how to call the function

Run HFSS simulation.

extraction_job = client.add_job(
    model_id  = model.id,
    function  = "@istari:run",
    tool_name = "ansys_hfss",
    tool_version = "2024",
    operating_system = "Windows 10",
)
print(f"Extraction started for model ID {model.id}, job ID: {extraction_job.id}")

Please choose appropriate function, tool_name, tool_version, and operating_system for your installation of this software.
Above is an example of how to call the function

Step 2: Check the Job Status

extraction_job.poll_job()

Step 3: Retrieve Results

Example

for artifact in model.artifacts:
    output_file_path = f"c:\\extracts\\{artifact.name}"
    with open(output_file_path, "wb") as f:
        f.write(artifact.read_bytes())

Troubleshooting

1. For general Agent and Software Troubleshooting Click Here

FAQ