Edb#
- class pyedb.dotnet.edb.Edb(edbpath: str | Path | None = None, cellname: str | None = None, isreadonly: bool = False, edbversion: str | None = None, isaedtowned: bool = False, oproject=None, student_version: bool = False, use_ppe: bool = False, technology_file: str | None = None, remove_existing_aedt: bool = False)[source]#
Provides the EDB application interface.
This module inherits all objects that belong to EDB.
- Parameters:
- edbpath
str
,optional
Full path to the
aedb
folder. The variable can also contain the path to a layout to import. Allowed formats are BRD, MCM, XML (IPC2581), GDS, ODB++(TGZ and ZIP) and DXF. The default isNone
. For GDS import, the Ansys control file (also XML) should have the same name as the GDS file. Only the file extension differs.- cellname
str
,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
.- edbversion
str
,int
,float
,optional
Version of EDB to use. The default is
None
. Examples of input values are232
,23.2
,2023.2
,"2023.2"
.- isaedtownedbool,
optional
Whether to launch EDB from HFSS 3D Layout. The default is
False
.- oproject
optional
Reference to the AEDT project object.
- student_versionbool,
optional
Whether to open the AEDT student version. The default is
False.
- technology_file
str
,optional
Full path to technology file to be converted to xml before importing or xml. Supported by GDS format only.
- edbpath
Examples
Create an
Edb
object and a new EDB cell.>>> from pyedb import Edb >>> app = Edb()
Add a new variable named “s1” to the
Edb
instance.>>> app['s1'] = "0.25 mm" >>> app['s1'].tofloat >>> 0.00025 >>> app['s1'].tostring >>> "0.25mm"
or add a new parameter with description:
>>> app['s2'] = ["20um", "Spacing between traces"] >>> app['s2'].value >>> 1.9999999999999998e-05 >>> app['s2'].description >>> 'Spacing between traces'
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 variable to edb.
Edb.add_project_variable
(variable_name, ...)Add a variable to edb database (project).
Check if all terminal references in design are connected.
Edb.attach
(hdb)Attach the database to existing AEDT instance.
Edb.auto_parametrize_design
([layers, ...])Assign automatically design and project variables with current values.
Edb.build_simulation_project
(simulation_setup)Build a ready-to-solve simulation project.
Edb.calculate_initial_extent
(expansion_factor)Compute a float representing the larger number between the dielectric thickness or trace width multiplied by the nW factor.
Change a variable value.
Close the database.
Close EDB and cleanup variables.
Edb.copy_cells
(cells_to_copy)Copy Cells from other Databases or this Database into this Database.
Edb.copy_zones
([working_directory])Copy multizone EDB project to one new edb per zone.
Edb.create
(db_path)Create a Database at the specified file location.
Edb.create_current_source
(terminal, ref_terminal)Create a current source.
Create EDB.
Edb.create_hfss_setup
([name])Create an HFSS simulation setup from a template.
Edb.create_hfsspi_setup
([name])Create an HFSS PI simulation setup from a template.
Generate EDB design to be consumed by PyAEDT to generate arbitrary wave ports shapes.
Edb.create_port
(terminal[, ref_terminal, ...])Create a port.
Edb.create_raptorx_setup
([name])Create an RaptorX simulation setup from a template.
Edb.create_siwave_dc_setup
([name])Create a setup from a template.
Edb.create_siwave_syz_setup
([name])Create a setup from a template.
Edb.create_voltage_probe
(terminal, ref_terminal)Create a voltage probe.
Edb.create_voltage_source
(terminal, ref_terminal)Create a voltage source.
Edb.cutout
([signal_list, reference_list, ...])Create a cutout using an approach entirely based on PyAEDT.
Edb.cutout_multizone_layout
(zone_dict[, ...])Create a multizone project cutout.
Edb.delete
(db_path)Delete a database at the specified file location.
Edb.edb_exception
(ex_value, tb_data)Write the trace stack to AEDT when a Python error occurs.
Edb.edb_value
(val)Convert a value to an 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_siwave_dc_results
(siwave_project, ...)Close EDB and solve it with Siwave.
Edb.export_to_ipc2581
([ipc_path, units])Create an XML IPC2581 file from the active EDB.
Edb.find_by_id
(db_id)Find a database by ID.
Get the layout bounding box.
Edb.get_conformal_polygon_from_netlist
([netlist])Return an EDB conformal polygon based on a netlist.
Edb.get_connected_objects
(layout_object_instance)Get connected objects.
Edb.get_point_terminal
(name, net_name, ...)Place a voltage probe between two points.
Edb.get_product_property
(prod_id, attr_it)Get the product-specific property value.
Edb.get_product_property_ids
(prod_id)Get a list of attribute ids corresponding to a product property id.
Edb.get_statistics
([compute_area])Get the EDBStatistics object.
Edb.get_variable
(variable_name)Return Variable Value if variable exists.
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[, ...])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.import_material_from_control_file
(...[, ...])Import materials from the provided control file.
Edb.new_simulation_configuration
([filename])New SimulationConfiguration Object.
Edb.number_with_units
(value[, units])Convert a number to a string with units.
Edb.open
(db_path, read_only)Open an existing Database at the specified file location.
Open EDB.
Edb.point_3d
(x, y[, z])Compute the Edb 3d Point Data.
Edb.point_data
(x[, y])Compute the Edb Point Data.
Edb.run_as_standalone
(flag)Set if Edb is run as standalone or embedded in AEDT.
Edb.save
()Save any changes into a file.
Edb.save_as
(path[, version])Save this Database to a new location and older EDB version.
Save the EDB file.
Edb.save_edb_as
(fname)Save the EDB file as another file.
Edb.scale
(scale_factor)Uniformly scale all geometry and their locations by a positive factor.
Edb.set_product_property
(prod_id, attr_it, ...)Set the product property associated with the given product and attribute ids.
Close EDB and solve it with Siwave.
Edb.variable_exists
(variable_name)Check if a variable exists or not.
Edb.write_export3d_option_config_file
(...[, ...])Write the options for a 3D export to a configuration file.
Attributes
Active cell.
Database object.
Active layout.
Get all APD bondwire definitions in this Database.
Return Ansys.Ansoft.Edb class object.
Return Ansys.Ansoft.Edb object.
Cell name container.
Get all circuit cells in the Database.
Get all component definitions in the database.
Edb Components methods and properties.
Edb project configuration from file.
Edb Dotnet Api Database.
Get all dataset definitions in the database.
Active database object.
Edb Dotnet Api Database Edb.Definition.
Definitions class.
Edb Design Settings and Options.
Get all edb design variables.
Get all differential pairs.
Get the directory of the Database.
Edb Dotnet Api class.
Get ID of the database.
Get all layout excitations.
Get all excitations net names.
Get all extended nets.
Get all footprint cells in the Database.
Core HFSS methods and properties.
Active HFSS setup in EDB.
Determine if the database is open in a read-only mode.
Get all JEDEC4 bondwire definitions in this Database.
Get all JEDEC5 bondwire definitions in this Database.
Layout object.
Edb Layout Instance.
pyedb.dotnet.edb_core.edb_data.layout_validation.LayoutValidation
.Logger for EDB.
Get all material definitions in the database.
Material Database.
Core primitives modeler.
Get all net classes.
Core nets.
Get all Package definitions in this Database.
Get all Padstack definitions in this Database.
Core padstack.
Get all ports.
Get all layout probes.
Get all project variables.
Get the dictionary of all EDB HFSS and SIwave setups.
Core SIWave methods and properties.
Active Siwave SYZ setups.
Active Siwave DC IR Setups.
Get source name for this Database.
Get the source version for this Database.
Get all layout sources.
Stackup manager.
Set the student version flag.
Get terminals belonging to active layout.
Get top circuit cells.
Get all Edb variables.
Get version of the Database.
Get all voltage regulator modules
Workflow class.