keysight.ads.de

ADS Design Environment scripting.

Automate the ADS Design Environment using the keysight.ads.de package. This is typically imported as:

from keysight.ads import de

Classes

Functions

keysight.ads.de.active_workspace() → Workspace

Return the currently opened workspace.

This method raises a RuntimeError if there is no workspace open.

keysight.ads.de.add_model_definition(library: Library, model_def: ModelDefBase) → None
keysight.ads.de.add_smart_package(package_name: str, path: str | Path) → None

Create an ADS Smart Package.

keysight.ads.de.cellview_exists(library_name: str, cell_name: str, view_name: str) → bool
keysight.ads.de.close_library(library_name: str) → None
keysight.ads.de.close_library_if_open(library_name: str) → None
keysight.ads.de.close_workspace() → None
keysight.ads.de.create_new_library(library_name: str, library_path: Path | str) → Library
keysight.ads.de.create_workspace(wrk_path: str | PathLike) → Workspace

Create a new workspace at the specified path.

Raises a RuntimeError if the path already exists.

keysight.ads.de.designs_have_different_parameters(this_design: Design, equiv_design: Design) → bool
keysight.ads.de.directory_is_workspace(path: Path | PathLike) → bool
keysight.ads.de.directory_might_be_workspace(path: Path | PathLike) → bool
keysight.ads.de.find_equivalent_design(design: Design) → Design | None

Return the equivalent design.

If design is the ‘schematic’ view, return the ‘layout’ view. If design is the ‘layout’ view, return the ‘schematic’ view.

keysight.ads.de.find_inst_in_associated_schematic(inst_name: str, design: Design) → tuple[Instance, Design]

Find the named instance in the associated schematic of the given design.

Typically used to find the substrate or process block referenced by parameters of layout instances. The value returned is a tuple containing the instance and its parent design. The parent design is only used to keep the design open so the instance won’t be deleted. Will raise an exception if there is no associated schematic or if the instance is not found or is deactivated.

keysight.ads.de.find_inst_in_schematic_hierarchy(inst_name: str, hierarchy: DesignHierarchy) → tuple[Instance, Design]

Search up the hierarchy to find the named instance in the associated schematics of the designs in the hierarchy.

Typically used to find the substrate or process block referenced by parameters of layout instances. The value returned is a tuple containing the instance and its parent design. The parent design is only used to keep the design open so the instance won’t be deleted. Will raise an exception if no activated instance is found in the schematics of the hierarchy.

keysight.ads.de.format_number(number: int | float | complex | str | None, width: int = 10, precision: int | None = None) → str
keysight.ads.de.generate_netlist(hierarchy: DesignHierarchy) → str
keysight.ads.de.get_cell_module(lib_name: str, cell_name: str) → module

Import the Python module for an OpenAccess cell.

keysight.ads.de.get_hierarchy_from_current_expr_context() → DesignHierarchy

Get the DesignHierarchy from the current ExpressionContext.

Intended for use during layout pcell generation or custom callbacks. Will raise an exception if there is no current ExpressionContext or if the hierarchy is not valid.

keysight.ads.de.get_library_module(lib_name: str) → module

Import the Python module for an OpenAccess library.

keysight.ads.de.get_open_library(library_name: str) → Library
keysight.ads.de.get_open_writable_library_names() → set[str]
keysight.ads.de.get_path_to_open_library(library_name: str) → Path | None
keysight.ads.de.get_smart_package_module(package_name: str) → module

Import the Python module for an ADS Smart Package.

keysight.ads.de.get_view_module(lib_name: str, cell_name: str, view_name: str) → module

Import the Python module for an OpenAccess cellview.

keysight.ads.de.get_view_name_for_sub_design_from_hierarchy(hierarchy: DesignHierarchy, instance: Instance) → str
keysight.ads.de.hpeesof_path() → str
keysight.ads.de.is_open_library_in_workspace(library: str | Library) → bool
keysight.ads.de.is_pde_app() → bool

Return True if the ADS application is running.

keysight.ads.de.library_exists_at_path(path: Path | str) → bool
keysight.ads.de.library_is_open(library_name: str) → bool
keysight.ads.de.library_is_read_only(library_name: str) → bool
keysight.ads.de.open_workspace(wrk_path: str | PathLike, *, force: bool = False) → Workspace

Open the specified ADS workspace.

forcebool [optional, default = False]

If False, raises a RuntimeErro if a workspace is already open. If True, will first close any open workspace, losing unsaved changes.

keysight.ads.de.product_version() → str
keysight.ads.de.remove_smart_package(package_name: str) → None

Remove the named ADS Smart Package.

keysight.ads.de.running_automation() → bool

Return True if the running application is Python.

If True, then both keysight.ads.de.is_pde_app() and keysight.ads.dds.is_dds_app() will return False.

keysight.ads.de.unarchive_file(zap_file_path: str | Path | PathLike, dest_path: str | Path | PathLike, *, exclude_em_files: bool = False) → None

Unarchive a workspace 7zads file.

Usage: de.unarchive_file(zap_name, dest_path) de.unarchive_file(zap_name, dest_path, exclude_em_files=True)

keysight.ads.de.update_design_parameters_to_match_other_design(this_design: Design, other_design: Design) → None
keysight.ads.de.version() → int
keysight.ads.de.workspace_is_open() → bool

Check if a workspace is currently open.

On this page