pyaedt.Edb#

class pyaedt.Edb(edbpath=None, cellname=None, isreadonly=False, edbversion=None, isaedtowned=False, oproject=None, student_version=False, use_ppe=False)[source]#

Provides the EDB application interface.

This module inherits all objects that belong to EDB.

Parameters:
edbpathstr, optional

Full path to the aedb folder. The variable can also contain the path to a layout to import. Allowed formats are BRD, XML (IPC2581), GDS, and DXF. The default is None. For GDS import, the Ansys control file (also XML) should have the same name as the GDS file. Only the file extension differs.

cellnamestr, optional

Name of the cell to select. The default is None.

isreadonlybool, optional

Whether to open EBD in read-only mode when it is owned by HFSS 3D Layout. The default is False.

edbversionstr, optional

Version of EDB to use. The default is "2021.2".

isaedtownedbool, optional

Whether to launch EDB from HFSS 3D Layout. The default is False.

oprojectoptional

Reference to the AEDT project object.

student_versionbool, optional

Whether to open the AEDT student version. The default is False.

Examples

Create an Edb object and a new EDB cell.

>>> from pyaedt import Edb
>>> app = Edb()

Create an Edb object and open the specified project.

>>> app = Edb("myfile.aedb")

Create an Edb object from GDS and control files. The XML control file resides in the same directory as the GDS file: (myfile.xml).

>>> app = Edb("/path/to/file/myfile.gds")

Methods

Edb.add_design_variable(variable_name, ...)

Add a design variable.

Edb.arg_with_dim(Value, sUnits)

Format arguments with dimensions.

Edb.build_simulation_project([simulation_setup])

Build a ready-to-solve simulation project.

Edb.change_design_variable_value(...)

Change a variable value.

Edb.close_edb()

Close EDB.

Edb.create_cutout([signal_list, ...])

Create a cutout and save it to a new AEDB file.

Edb.create_cutout_on_point_list(point_list)

Create a cutout on a specified shape and save it to a new AEDB file.

Edb.create_edb([init_dlls])

Create EDB.

Edb.edb_exception(ex_value, tb_data)

Write the trace stack to AEDT when a Python error occurs.

Edb.edb_value(val)

EDB value.

Edb.execute(func)

Execute a function.

Edb.export_hfss(path_to_output[, net_list, ...])

Export EDB to HFSS.

Edb.export_maxwell(path_to_output[, ...])

Export EDB to Maxwell 3D.

Edb.export_q3d(path_to_output[, net_list, ...])

Export EDB to Q3D.

Edb.export_to_ipc2581([ipc_path, units])

Create an XML IPC2581 file from the active EDB.

Edb.get_bounding_box()

Get the layout bounding box.

Edb.get_conformal_polygon_from_netlist([netlist])

Return an EDB conformal polygon based on a netlist.

Edb.get_statistics([compute_area])

Get the EDBStatistics object.

Edb.import_cadence_file(inputBrd[, WorkDir, ...])

Import a board file and generate an edb.def file in the working directory.

Edb.import_gds_file(inputGDS[, WorkDir, ...])

Import a GDS file and generate an edb.def file in the working directory.

Edb.import_layout_pcb(input_file, working_dir)

Import a board file and generate an edb.def file in the working directory.

Edb.open_edb([init_dlls])

Open EDB.

Edb.open_edb_inside_aedt([init_dlls])

Open EDB inside of AEDT.

Edb.save_edb()

Save the EDB file.

Edb.save_edb_as(fname)

Save the EDB file as another file.

Edb.solve_siwave()

Close EDB and solve it with Siwave.

Edb.write_export3d_option_config_file(...[, ...])

Write the options for a 3D export to a configuration file.

Attributes

Edb.active_cell

Active cell.

Edb.active_layout

Active layout.

Edb.cell_names

Cell name container.

Edb.core_components

Core components.

Edb.core_hfss

Core HFSS.

Edb.core_nets

Core nets.

Edb.core_padstack

Core padstack.

Edb.core_primitives

Core primitives.

Edb.core_siwave

Core SI Wave.

Edb.core_stackup

Core stackup.

Edb.db

Database object.

Edb.edblib

EDB library object containing advanced EDB methods not accessible directly from Python.

Edb.logger

Logger for EDB.

Edb.pins

Pins.