Siwave

class pyedb.siwave.Siwave(specified_version=None)

Bases: object

Initializes SIwave based on the inputs provided and manages SIwave release and closing.

Parameters:

specified_versionstr, int, float, optional

Version of AEDT to use. The default is None, in which case the active setup is used or the latest installed version is used.

Overview

Methods

open_project	Open a project.
save_project	Save the project.
save	Save the project.
close_project	Close the project.
quit_application	Quit the application.
export_element_data	Export element data.
export_siwave_report	Export the Siwave report.
export_dc_simulation_report	Export the Siwave DC simulation report.
run_dc_simulation	Run DC simulation.
export_icepak_project	Exports an Icepak project for standalone use.
run_icepak_simulation	Runs an Icepak simulation.
export_edb	Export the layout as EDB.
import_edb	Import layout from EDB.
load_configuration	Load configuration settings from a configure file.Import
export_configuration	Export layout information into a configuration file.

Properties

version
version_keys	Version keys for AEDT.
current_version	Current version of AEDT.
project_name	Project name.
project_path	Project path.
project_file	Project file.
lock_file	Lock file.
results_directory	Results directory.
src_dir	Source directory.
pyaedt_dir	PyAEDT directory.
oproject	Project.
icepak
file_dir	Directory path of the open project.
file_path	Path of the open project file.

Import detail

from pyedb.siwave import Siwave

Property detail

property Siwave.version

property Siwave.version_keys

Version keys for AEDT.

property Siwave.current_version

Current version of AEDT.

property Siwave.project_name

Project name.

Returns:

str

Name of the project.

property Siwave.project_path

Project path.

Returns:

str

Full absolute path for the project.

property Siwave.project_file

Project file.

Returns:

str

Full absolute path and name for the project file.

property Siwave.lock_file

Lock file.

Returns:

str

Full absolute path and name for the project lock file.

property Siwave.results_directory

Results directory.

Returns:

str

Full absolute path to the aedtresults directory.

property Siwave.src_dir

Source directory.

Returns:

str

Full absolute path to the python directory.

property Siwave.pyaedt_dir

PyAEDT directory.

Returns:

str

Full absolute path to the pyaedt directory.

property Siwave.oproject

Project.

property Siwave.icepak

property Siwave.file_dir: str

Directory path of the open project.

property Siwave.file_path: str

Path of the open project file.

Method detail

Siwave.open_project(proj_path=None)

Open a project.

Parameters:

proj_pathstr, optional

Full path to the project. The default is None.

Returns:

bool

True when successful, False when failed.

Siwave.save_project(projectpath=None, projectName=None)

Save the project.

Parameters:

proj_pathstr, optional

Full path to the project. The default is None.

projectNamestr, optional

Name of the project. The default is None.

Returns:

bool

True when successful, False when failed.

Siwave.save(file_path: str | pathlib.Path | None)

Save the project.

Parameters:

file_pathstr, optional

Full path to the project. The default is None.

Siwave.close_project(save_project=False)

Close the project.

Parameters:

save_projectbool, optional

Whether to save the current project before closing it. The default is False.

Returns:

bool

True when successful, False when failed.

Siwave.quit_application()

Quit the application.

Returns:

bool

True when successful, False when failed.

Siwave.export_element_data(simulation_name, file_path, data_type='Vias')

Export element data.

Parameters:

simulation_namestr

Name of the setup.

file_pathstr

Path to the exported report.

data_typestr, optional

Type of the data. The default is "Vias".

Returns:

bool

True when successful, False when failed.

Siwave.export_siwave_report(simulation_name, file_path, bkground_color='White')

Export the Siwave report.

Parameters:

simulation_namestr

Name of the setup.

file_pathstr

Path to the exported report.

bkground_colorstr, optional

Color of the report’s background. The default is "White".

Returns:

bool

True when successful, False when failed.

Siwave.export_dc_simulation_report(simulation_name, file_path, background_color='White')

Export the Siwave DC simulation report.

Parameters:

simulation_namestr

Name of the setup.

file_pathstr

Path to the exported report.

background_colorstr, optional

Color of the report’s background. The default is "White".

Returns:

bool

True when successful, False when failed.

Siwave.run_dc_simulation(export_dc_power_data_to_icepak=False)

Run DC simulation.

Siwave.export_icepak_project(file_path, dc_simulation_name)

Exports an Icepak project for standalone use.

Parameters:

file_pathstr,

Path of the Icepak project.

dc_simulation_namestr

Name of the DC simulation.

Returns:

bool

True when successful, False when failed.

Siwave.run_icepak_simulation(icepak_simulation_name, dc_simulation_name)

Runs an Icepak simulation.

Parameters:

icepak_simulation_namestr

Name of the Icepak simulation.

dc_simulation_namestr

Name of the DC simulation.

Returns:

bool

True when successful, False when failed.

Siwave.export_edb(file_path: str)

Export the layout as EDB.

Parameters:

file_pathstr

Path to the EDB.

Returns:

bool

Siwave.import_edb(file_path: str)

Import layout from EDB.

Parameters:

file_pathStr

Path to the EDB file.

Returns

——-

bool

Siwave.load_configuration(file_path: str)

Load configuration settings from a configure file.Import

Parameters:

file_pathstr

Path to the configuration file.

Siwave.export_configuration(file_path: str, fix_padstack_names: bool = False)

Export layout information into a configuration file.

Parameters:

file_pathstr

Path to the configuration file.

fix_padstack_namesbool

Name all the padstacks in edb.