`Configuration`#

class pyedb.configuration.configuration.Configuration(pedb: pyedb.Edb)#: Enables export and import of a JSON configuration file that can be applied to a new or existing design.

Overview#

Methods

`load`	Import configuration settings from a configure file.
`run`	Apply configuration settings to the current design
`apply_boundaries`
`get_boundaries`
`apply_modeler`
`apply_variables`	Set variables into database.
`get_variables`	Retrieve variables from database.
`apply_materials`	Apply material settings to the current design
`get_materials`	Retrieve materials from the current design.
`apply_stackup`
`get_stackup`
`get_data_from_db`	Get configuration data from layout.
`apply_operations`	Apply operations to the current design.
`get_operations`
`apply_terminals`
`get_terminals`
`export`	Export the configuration data from layout to a file.

Attributes

`data`
`cfg_data`

Import detail#

from pyedb.configuration.configuration import Configuration

Attribute detail#

Configuration.data#

Configuration.cfg_data#

Method detail#

Configuration.load(config_file, append=True, apply_file=False, output_file=None, open_at_the_end=True)#

Import configuration settings from a configure file.

Parameters:

config_filestr, dict: Full path to configure file in JSON or TOML format. Dictionary is also supported.
appendbool, optional: Whether if the new file will append to existing properties or the properties will be cleared before import. Default is True to keep stored properties
apply_filebool, optional: Whether to apply the file after the load or not. Default is False.
output_filestr, optional: Full path to the new aedb folder where the configured project will be saved.
open_at_the_endbool, optional: Whether to keep the new generated file opened at the end. Default is True.

Returns:

dict: Config dictionary.

Configuration.run(**kwargs)#: Apply configuration settings to the current design

Configuration.apply_boundaries()#

Configuration.get_boundaries()#

Configuration.apply_modeler()#

Configuration.apply_variables()#: Set variables into database.

Configuration.get_variables()#: Retrieve variables from database.

Configuration.apply_materials()#: Apply material settings to the current design

Configuration.get_materials()#

Retrieve materials from the current design.

Parameters:

append: bool, optional: If True, append materials to the current material list.

Configuration.apply_stackup()#

Configuration.get_stackup()#

Configuration.get_data_from_db(**kwargs)#

Get configuration data from layout.

Parameters:

stackup

Returns:

Configuration.apply_operations()#: Apply operations to the current design.

Configuration.get_operations()#

Configuration.apply_terminals()#

Configuration.get_terminals()#

Configuration.export(file_path, stackup=True, package_definitions=False, setups=True, sources=True, ports=True, nets=True, pin_groups=True, operations=True, components=True, boundaries=True, s_parameters=True, padstacks=True, general=True, variables=True, terminals=False)#

Export the configuration data from layout to a file.

Parameters:

file_pathstr, Path: File path to export the configuration data.
stackupbool: Whether to export stackup or not.
package_definitionsbool: Whether to export package definitions or not.
setupsbool: Whether to export setups or not.
sourcesbool: Whether to export sources or not. Alternative to terminals.
portsbool: Whether to export ports or not. Alternative to terminals.
netsbool: Whether to export nets.
pin_groupsbool: Whether to export pin groups.
operationsbool: Whether to export operations.
componentsbool: Whether to export component.
boundariesbool: Whether to export boundaries.
s_parametersbool: Whether to export s_parameters.
padstacksbool: Whether to export padstacks.
generalbool: Whether to export general information.
variablesbool: Whether to export variable.
terminalsbool: Whether to export terminals. Alternative to ports and sources.
Returns
——-
bool

Configuration#

Overview#

Import detail#

Attribute detail#

Method detail#

`Configuration`#