Exporting to ANSYS HFSS

[WorkQuoh]

Hi, I am having trouble with exporting design to ANSYS with kqcircuits. Using the ansys_export.py to export my design I will get an error which will say: "export_ansys_json() got an unexpected keyword argument 'ansys_tool'". The reason is because this line of code in ansys_export.lym: "json = export_ansys_json(simulation, path, ansys_tool='hfss') # Alternatively choose ansys_tool='q3d' for Q3D export". However, if you go back to the ansys_export.py you will find this function has no parameter "ansys_tool" in the function. These are the parameters that ansys_export.py has for this function: "def export_ansys_json(simulation: Union[Simulation, CrossSectionSimulation], solution: AnsysSolution, path: Path):". This must have not been updated on the GitHub because there is no way to do export in ANSYS HFSS.

[qpavsmi]

Hi! The ansys_export.lym macro is a bit outdated. If you open the macro in KLayout's macro editor and modify its contents with following, it should work then:

from kqcircuits.klayout_view import KLayoutView
from kqcircuits.simulations.export.ansys.ansys_solution import AnsysHfssSolution, AnsysQ3dSolution
from kqcircuits.simulations.export.simulation_export import copy_content_into_directory
from kqcircuits.simulations.simulation import Simulation
from kqcircuits.simulations.export.ansys.ansys_export import export_ansys_json, export_ansys_bat
from kqcircuits.util.export_helper import create_or_empty_tmp_directory, write_commit_reference_file
from kqcircuits.defaults import TMP_PATH, ANSYS_EXECUTABLE, ANSYS_SCRIPT_PATHS

"""Before using this script, have your project in view as the top cell."""

name = "Dev"  # makes filename Dev.json and Dev.gds
path = TMP_PATH / name # Your path here

top_cell = KLayoutView(current=True).active_cell

simulation = Simulation.from_cell(top_cell, margin=100, name=name)

create_or_empty_tmp_directory(path)
write_commit_reference_file(path)
copy_content_into_directory(ANSYS_SCRIPT_PATHS, path, "scripts")
json = export_ansys_json(simulation, AnsysHfssSolution(), path)  # Alternatively choose AnsysQ3dSolution for Q3D export
exec_file = export_ansys_bat([json], path)
print(f"Simulation exported, execute {exec_file} to run simulation in Ansys")

I would recommend to study the method that we support more at this time, which is to define the element in code that you wish to simulate, then running the kqc sim utility. You will need standalone installation to do this.

Here is an example of simulating the SingleXmons chip.

We define a simulation class that uses this chip and defines ports for it, and removes elements that are not relevant for simulation.

Finally, we have the simulation script where we define Ansys configuration. Not present in this script, but you are also able to sweep different properties of the chip using functions sweep_simulation or cross_sweep_simulation. For example the readout resonator lengths (readout_res_lengths) could be sweeped for qubits of the chip. Then running command kqc sim <SIMULATION SCRIPT FILE> will run simulations for every sweep. This is an advantage over simulating a manually crafted design, which would need to be modified manually for each such sweep.

For single element simulations like ConcentricTransmon coupling simulation you can skip defining a simulation class and just use the function get_single_element_sim_class.

More information on the current methods of running simulations can be found here and feel free to ask me for more info.

[WorkQuoh]

Hi thanks for the response! So, I tried that script, and it worked however I ran into other problems as well. For example, I had to change the geometry.py file to allow the import of the geometries since there was a syntax error:

This is what fixed it for me:

# ["NAME:ChangedProps", ["NAME:Material", "Value:=", f'"{material}"']],  #This causes an error
   ["NAME:ChangedProps", ["NAME:Material", "Value:=", '"{}"'.format(material)]],  #This works

This fixes it because fstrings like f"" in python only started in version 3.6 I believe, so you have to use the older .format('') fstring for it not to be a syntax error. I only ran into these issues once I was in the ANSYS HFSS software, so I think there must be some compatibility issues that are causing the problem. Also, I am using the latest version of ANSYS HFSS 2024 version.

I would be able to import some of my designs and others it would not, and many times port and materials were not assigned either so there seems to be many issues at the moment with getting the simulation started.

Any help will be greatly appreciated. Thanks in Advance.

[qpavsmi]

ok good! So when you type exit() so that your cmd terminal exits the python interpreter, can you then using this same cmd terminal run either

kqc sim xs1_full_chip_sim.py

or

python klayout_package/python/scripts/simulations/xs1_full_chip_sim.py

or will it complain about etch_width again?

[WorkQuoh]

It runs but it only open klayout and not ANSYS

[qpavsmi]

If you close KLayout window it should open ANSYS next if you ran kqc sim ...

[WorkQuoh]

Awesome, thank you so much it worked!

[qpavsmi]

Great, I'm glad it worked out in the end!

I'd recommend cleaning up all of the changes we made in KQC code when debugging the issue. You can use git status to see which files were modified and git diff to see how they were modified. Probably good to return port.py back to what it was, but you can keep use_elmer = False in xs1_full_chip_sim.py.