QHFSSRenderer

class QHFSSRenderer(design: QDesign, initiate=True, options: addict.addict.Dict = None)

Subclass of QAnsysRenderer for running HFSS simulations.

QAnsysRenderer Default Options:

• Lj: ‘10nH’ – Lj has units of nanoHenries (nH)

• Cj: 0 – Cj must be 0 for pyEPR analysis! Cj has units of femtofarads (fF)

• _Rj: 0 – _Rj must be 0 for pyEPR analysis! _Rj has units of Ohms

• max_mesh_length_jj: ‘7um’ – Maximum mesh length for Josephson junction elements

• project_path: None – Default project path; if None –> get active

• project_name: None – Default project name

• design_name: None – Default design name

• ansys_file_extension: ‘.aedt’ – Ansys file extension for 2016 version and newer

• x_buffer_width_mm: 0.2 – Buffer between max/min x and edge of ground plane, in mm

• y_buffer_width_mm: 0.2 – Buffer between max/min y and edge of ground plane, in mm

Create a QRenderer for HFSS simulations, subclassed from QAnsysRenderer.

Parameters

• design (QDesign) – Use QGeometry within QDesign to obtain elements for Ansys.

• initiate (bool, optional) – True to initiate the renderer. Defaults to True.

• options (Dict, optional) – Used to override all options. Defaults to None.

Attributes

QHFSSRenderer.NAME_DELIM	Name delimiter
QHFSSRenderer.default_options	Default options
QHFSSRenderer.default_setup	Default setup.
QHFSSRenderer.design	Return a reference to the parent design object.
QHFSSRenderer.element_extensions	Element extensions dictionary
QHFSSRenderer.element_table_data	Element table data.
QHFSSRenderer.hfss_options	HFSS Options
QHFSSRenderer.initialized	Returns True if initialized, False otherwise.
QHFSSRenderer.logger	Returns the logger.
QHFSSRenderer.modeler	The modeler from pyEPR HfssModeler.
QHFSSRenderer.name	Name
QHFSSRenderer.options	Options for the QRenderer.
QHFSSRenderer.pinfo	pyEPR.ProjectInfo).
QHFSSRenderer.rapp
QHFSSRenderer.rdesktop

Methods

QHFSSRenderer.activate_ansys_design(design_name)	Select a design with the given name from the open project.
QHFSSRenderer.activate_ansys_setup(setup_name)	For active design, either get existing setup, make new setup with name, or make new setup with default name.
QHFSSRenderer.activate_drivenmodal_design([name])	(deprecated) use activate_ansys_design()
QHFSSRenderer.activate_drivenmodal_setup([...])	(deprecated) use activate_ansys_setup()
QHFSSRenderer.activate_eigenmode_design([name])	(deprecated) use activate_ansys_design()
QHFSSRenderer.activate_eigenmode_setup([...])	(deprecated) use activate_ansys_setup()
QHFSSRenderer.add_drivenmodal_design(name[, ...])	(deprecated) use new_ansys_design()
QHFSSRenderer.add_drivenmodal_setup([name, ...])	Create a solution setup in Ansys HFSS Driven Modal.
QHFSSRenderer.add_eigenmode_design(name[, ...])	(deprecated) use new_ansys_design()
QHFSSRenderer.add_eigenmode_setup([name, ...])	Create a solution setup in Ansys HFSS Eigenmode.
QHFSSRenderer.add_endcaps([open_pins])	Create endcaps (rectangular cutouts) for all pins in the list open_pins and add them to chip_subtract_dict.
QHFSSRenderer.add_mesh()	Add mesh to all elements in self.assign_mesh.
QHFSSRenderer.add_message(msg[, severity])	Add message to Message Manager box in Ansys.
QHFSSRenderer.add_sweep([setup_name, ...])	Add a frequency sweep to a driven modal setup.
QHFSSRenderer.add_table_data_to_QDesign(...)	During init of renderer, this needs to happen.
QHFSSRenderer.analyze_setup(setup_name)	Run a specific solution setup in Ansys HFSS.
QHFSSRenderer.analyze_sweep(sweep_name, ...)	Analyze a single sweep within the setup.
QHFSSRenderer.auto_wirebonds(table)	Adds wirebonds to the Ansys model for path elements where; subtract = True and wire_bonds = True.
QHFSSRenderer.chip_designation_error()	Warning message that appears when the Ansys renderer fails to locate a component's chip designation.
QHFSSRenderer.chip_not_in_design_error(...)	Warning message that appears when the Ansys renderer fails to locate a component's chip designation in DesignPlanar (or any child of QDesign).
QHFSSRenderer.chip_not_main()	Warning message that appears when a component's chip designation is not 'main'.
QHFSSRenderer.clean_active_design()	Remove all elements from Ansys Modeler.
QHFSSRenderer.clear_fields(names)	Delete field plots from modeler window in Ansys.
QHFSSRenderer.close()	Alias of _close_renderer()
QHFSSRenderer.connect_ansys([project_path, ...])	If none of the optional parameters are provided: connects to the Ansys COM, then checks for, and grab if present, an active project, design, and design setup.
QHFSSRenderer.connect_ansys_design([design_name])	Used to switch between existing designs.
QHFSSRenderer.create_ports(port_list)	Add ports and their respective impedances in Ohms to designated pins in port_list.
QHFSSRenderer.disconnect_ansys()	Disconnect Ansys.
QHFSSRenderer.distributed_analysis()	Returns class containing info on Hamiltonian parameters from HFSS simulation.
QHFSSRenderer.edit_drivenmodal_setup(setup_args)	User can pass key/values to edit the setup for active driven modal setup.
QHFSSRenderer.edit_eigenmode_setup(setup_args)	User can pass key/values to edit the setup for active eigenmode setup.
QHFSSRenderer.epr_get_frequencies([...])	Returns all frequencies and quality factors vs a variation.
QHFSSRenderer.epr_get_stored_energy([...])	Computes the energy stored in the system pinfo must have a valid list of junctions and dissipatives to compute the energy stored in the system.
QHFSSRenderer.epr_report_hamiltonian([...])	Reports in a markdown friendly table the hamiltonian results.
QHFSSRenderer.epr_run_analysis([junctions, ...])	Executes the EPR analysis pinfo must have a valid list of junctions and dissipatives to compute the energy stored in the system.
QHFSSRenderer.epr_spectrum_analysis([...])	Core epr analysis method.
QHFSSRenderer.epr_start([junctions, ...])	Use to initialize the epr analysis package by first identifying which are the junctions, their electrical properties and their reference plane; then initialize the DistributedAnalysis package, which can execute microwave analysis on eigenmode results.
QHFSSRenderer.execute_design(design_name, ...)	It wraps the render_design() method to 1.
QHFSSRenderer.get_active_design_name()	Returns the name of the Ansys Design Object
QHFSSRenderer.get_all_Pparms_matrices(...)	S = scattering matrix, Y = Admittance, Z= impedance.
QHFSSRenderer.get_chip_names()	Obtain a list of chips on which the selection of components, if valid, resides.
QHFSSRenderer.get_convergences([variation])	Get convergence for convergence_t, convergence_f, and text from GUI for solution data.
QHFSSRenderer.get_f_convergence([variation, ...])	Create a report inside HFSS to plot the converge of frequency and style it.
QHFSSRenderer.get_min_bounding_box()	Determine the max/min x/y coordinates of the smallest rectangular, axis-aligned bounding box that will enclose a selection of components to render, given by self.qcomp_ids.
QHFSSRenderer.get_params([param_name])	Get one or more parameters (S, Y, or Z) as a function of frequency.
QHFSSRenderer.get_renderer(name)	Returns an already loaded and instantiated renderer.
QHFSSRenderer.get_template_options(design[, ...])	Creates template options for the Metal QRenderer class required for the class to function, based on the design template; i.e., be created, made, and rendered.
QHFSSRenderer.get_unique_component_ids([...])	Confirm the list doesn't have names of components repeated.
QHFSSRenderer.initialize_cap_extract(**kwargs)	Any task that needs to occur before running a simulation, such as creating a setup
QHFSSRenderer.initialize_drivenmodal(sweep_setup)	Any task that needs to occur before running a simulation, such as creating a setup
QHFSSRenderer.initialize_eigenmode([vars])	Any task that needs to occur before running a simulation, such as creating a setup
QHFSSRenderer.load()	Load the renderer and register all its extensions.
QHFSSRenderer.metallize()	Assign metallic property to all shapes in self.assign_perfE list.
QHFSSRenderer.new_ansys_design(design_name, ...)	Add an Ansys design with the given name to the Ansys project.
QHFSSRenderer.new_ansys_project()	Creates a new empty project in Ansys.
QHFSSRenderer.new_ansys_setup(name, ...)	Determines the appropriate setup to be created based on the pinfo.design.solution_type.
QHFSSRenderer.open_ansys([path, executable, ...])	Alternative method to open an Ansys session that allows to specify
QHFSSRenderer.parse_value(value)	Same as design.parse_value.
QHFSSRenderer.plot_ansys_delete(names)	(deprecated) Use clear_fields()
QHFSSRenderer.plot_ansys_fields(*args, **kwargs)	(deprecated) use plot_fields()
QHFSSRenderer.plot_convergences([variation, fig])	(deprecated) use EPRanalysis.plot_convergences()
QHFSSRenderer.plot_fields(object_name[, ...])	Plot fields in Ansys.
QHFSSRenderer.plot_params([param_name])	Plot one or more parameters (S, Y, or Z) as a function of frequency.
QHFSSRenderer.populate_element_extensions()	Populate cls.element_extensions which will be used to create columns for tables in QGeometry tables.
QHFSSRenderer.render_chip(chip_name, ...)	Render individual chips.
QHFSSRenderer.render_chips([...])	Render all chips containing components in self.qcomp_ids.
QHFSSRenderer.render_component()	Abstract method.
QHFSSRenderer.render_components(table_type)	Render components by breaking them down into individual elements.
QHFSSRenderer.render_design([selection, ...])	Initiate rendering of components in design contained in selection, assuming they're valid.
QHFSSRenderer.render_element(qgeom, is_junction)	Render an individual shape whose properties are listed in a row of QGeometry table.
QHFSSRenderer.render_element_junction(qgeom)	Render a Josephson junction depending on the solution type.
QHFSSRenderer.render_element_path(qgeom)	Render a path-type element.
QHFSSRenderer.render_element_poly(qgeom)	Render a closed polygon.
QHFSSRenderer.render_junction_inductor(...)	Render a junction as an inductor with a bounding box given by xmin/xmax and ymin/ymax, a height z, and a horizontal or vertical axis.
QHFSSRenderer.render_junction_port(qgeom, ...)	Render a junction as a port with a bounding box given by xmin/xmax and ymin/ymax, a height z, and a horizontal or vertical axis.
QHFSSRenderer.render_tables([skip_junction])	Render components in design grouped by table type (path, poly, or junction).
QHFSSRenderer.save_screenshot([path, show])	Save the screenshot.
QHFSSRenderer.set_mode(mode, setup_name)	Set the eigenmode in pyEPR for a design with solution_type set to Eigenmode.
QHFSSRenderer.set_variables(variables)	Fixes the junction properties before setup.
QHFSSRenderer.start([force])	Call any initialization (single run) step required to setup the renderer for the first execution, such as connecting to some API or COM, or importing the correct material libraries, etc.
QHFSSRenderer.stop()	Any calls that one may want to make after a rendering is complete.
QHFSSRenderer.subtract_from_ground()	For each chip, subtract all "negative" shapes residing on its surface if any such shapes exist.
QHFSSRenderer.update_options([...])	If template options has not been set for this renderer, then gather all the default options for children and add to design.