Emit

class ansys.aedt.core.emit.Emit(project=None, design=None, solution_type=None, version=None, non_graphical=False, new_desktop=True, close_on_exit=True, student_version=False, machine='', port=0, aedt_process_id=None, remove_lock=False)

Provides the EMIT application interface.

Parameters:

projectstr, optional

Name of the project to select or the full path to the project or AEDTZ archive to open. The default is None, in which case an attempt is made to get an active project. If no projects are present, an empty project is created.

designstr, optional

Name of the design to select. The default is None, in which case an attempt is made to get an active design. If no designs are present, an empty design is created.

solution_typestr, optional

Solution type to apply to the design. The default is None, in which case the default type is applied.

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. Examples of input values are 232, 23.2,``2023.2``,``”2023.2”``.

non_graphicalbool, optional

Whether to launch AEDT in non-graphical mode. The default is False, in which case AEDT is launched in graphical mode. This parameter is ignored when a script is launched within AEDT.

new_desktopbool, optional

Whether to launch an instance of AEDT in a new thread, even if another instance of the specified_version is active on the machine. The default is False.

close_on_exitbool, optional

Whether to release AEDT on exit. The default is False.

student_versionbool, optional

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

portint, optional

Port number on which to start the oDesktop communication on an already existing server. This parameter is ignored when creating a server. This parameter works only in 2022 R2 or later. The remote server must be up and running with the command “ansysedt.exe -grpcsrv portnum”. The default is 0.

machinestr, optional

Machine name that the Desktop session is to connect to. This parameter works only in 2022 R2 and later. The remote server must be up and running with the command “ansysedt.exe -grpcsrv portnum”. If the machine is “localhost”, the server starts if it is not present.

aedt_process_idint, optional

Process ID for the instance of AEDT to point PyAEDT at. The default is None. This parameter is only used when new_desktop = False.

remove_lockbool, optional

Whether to remove lock to project before opening it or not. The default is False, which means to not unlock the existing project if needed and raise an exception.

Examples

Create an Emit instance. You can also choose to define parameters for this instance here.

>>> from ansys.aedt.core import Emit
>>> aedtapp = Emit()

Typically, it is desirable to specify a project name, design name, and other parameters.

>>> aedtapp = Emit(projectname, designame, version=232)

Once an Emit instance is initialized, you can edit the schematic:

>>> rad1 = aedtapp.modeler.components.create_component("Bluetooth")
>>> ant1 = aedtapp.modeler.components.create_component("Antenna")
>>> if rad1 and ant1:
>>>     ant1.move_and_connect_to(rad1)

Once the schematic is generated, the Emit object can be analyzed to generate a revision. Each revision is added as an element of the Emit object member’s Results.revisions list.

>>> revision = aedtapp.results.analyze()

A revision within PyAEDT is analogous to a revision in AEDT. An interaction domain must be defined and then used as the input to the run command used on that revision.

>>> domain = aedtapp.results.interaction_domain()
>>> domain.rx_radio_name = "UE - HandHeld"
>>> interaction = revision.run(domain)

The output of the run command is an interaction object. This object summarizes the interaction data that is defined in the interaction domain.

>>> instance = interaction.worst_instance(ResultType.SENSITIVITY)
>>> val = instance.value(ResultType.SENSITIVITY)
>>> print(f"Worst-case sensitivity for Rx '{domain.rx_radio_name}' is {val}dB.")

Methods

Emit.activate_variable_optimization(name[, ...])	Activate optimization analysis for a variable and optionally set up ranges.
Emit.activate_variable_sensitivity(name[, ...])	Activate sensitivity analysis for a variable and optionally set up ranges.
Emit.activate_variable_statistical(name[, ...])	Activate statitistical analysis for a variable and optionally set up ranges.
Emit.activate_variable_tuning(name[, ...])	Activate tuning analysis for a variable and optionally set up ranges.
Emit.add_error_message(text[, level])	Add a type 0 "Error" message to either the global, active project, or active design level of the message mmanager tree.
Emit.add_from_toolkit(toolkit[, draw])	Add a new toolkit to the current application.
Emit.add_info_message(text[, level])	Add a type 0 "Info" message to either the global, active project, or active design level of the message manager tree.
Emit.add_warning_message(text[, level])	Add a type 0 "Warning" message to either the global, active project, or active design level of the message manager tree.
Emit.archive_project([project_path, ...])	Archive the AEDT project and add a message.
Emit.autosave_disable()	Disable autosave in AEDT.
Emit.autosave_enable()	Enable autosave in AEDT.
Emit.change_automatically_use_causal_materials([...])	Enable or disable the automatic use of causal materials for lossy dielectrics.
Emit.change_design_settings(settings)	Set Design Settings.
Emit.change_material_override([...])	Enable or disable the material override in the project.
Emit.change_validation_settings([...])	Update the validation design settings.
Emit.check_beta_option_enabled(beta_option)	Check if a beta option is enabled.
Emit.check_if_project_is_loaded(input_file)	Check if a project path is already loaded in active Desktop.
Emit.clean_proj_folder([directory, name])	Delete a project folder.
Emit.close_desktop()	Close AEDT and release it.
Emit.close_project([name, save])	Close an AEDT project.
Emit.copy_design_from(project, design[, ...])	Copy a design from a project into the active project.
Emit.copy_project(destination, name)	Copy the project to another destination.
Emit.create_dataset(name, x, y[, z, v, ...])	Create a dataset.
Emit.create_dataset1d_design(name, x, y[, ...])	Create a design dataset.
Emit.create_dataset1d_project(name, x, y[, ...])	Create a project dataset.
Emit.create_dataset3d(name, x, y[, z, v, ...])	Create a 3D dataset.
Emit.create_new_project(name)	Create a project within AEDT.
Emit.dataset_exists(name[, is_project_dataset])	Check if a dataset exists.
Emit.deactivate_variable_optimization(name)	Deactivate the optimization analysis for a variable.
Emit.deactivate_variable_sensitivity(name)	Deactivate the sensitivity analysis for a variable.
Emit.deactivate_variable_statistical(name)	Deactivate the statistical analysis for a variable.
Emit.deactivate_variable_tuning(name)	Deactivate the tuning analysis for a variable.
Emit.delete_design([name, fallback_design])	Delete a design from the current project.
Emit.delete_project(name)	Delete a project.
Emit.delete_separator(name)	Delete a separator from either the active project or a design.
Emit.delete_unused_variables()	Delete design and project unused variables.
Emit.delete_variable(name)	Delete a variable.
Emit.design_variation([variation])	Generate a string to specify a desired variation.
Emit.duplicate_design(name[, ...])	Copy a design to a new name.
Emit.edit_notes(text)	Edit notes.
Emit.evaluate_expression(expression)	Evaluate a valid string expression and return the numerical value in SI units.
Emit.export_design_preview_to_jpg(output_file)	Export design preview image to a JPG file.
Emit.export_profile(setup[, variation, ...])	Export a solution profile to a PROF file.
Emit.export_variables_to_csv(output_file[, ...])	Export design properties, project variables, or both to a CSV file.
Emit.generate_temp_project_directory(name)	Generate a unique directory string to save a project to.
Emit.get_evaluated_value(name[, units])	Retrieve the evaluated value of a design property or project variable in SI units if no unit is provided.
Emit.get_module(module_name)	Aedt Module object.
Emit.get_oo_name(aedt_object[, object_name])	Return the object-oriented AEDT property names.
Emit.get_oo_object(aedt_object, object_name)	Return the Object Oriented AEDT Object.
Emit.get_oo_properties(aedt_object, object_name)	Return the Object Oriented AEDT Object Properties.
Emit.get_oo_property_value(aedt_object, ...)	Return the Object Oriented AEDT Object Properties.
Emit.get_profile([name])	Get profile information.
Emit.get_registry_key_int(name)	Get the value for the AEDT registry key if one exists.
Emit.get_registry_key_string(name)	Get the value for the AEDT registry key if one exists.
Emit.get_units([unit_type])	Get units for the EMIT design.
Emit.hidden_variable(name[, value])	Set the variable to a hidden or unhidden variable.
Emit.import_dataset1d(input_file[, name, ...])	Import a 1D dataset.
Emit.import_dataset3d(input_file[, name, ...])	Import a 3D dataset.
Emit.insert_design([name, solution_type])	Add a design of a specified type.
Emit.load_project(file_name[, design, ...])	Open an AEDT project based on a project and optional design.
Emit.read_design_data()	Read back the design data as a dictionary.
Emit.read_only_variable(name[, value])	Set the variable to a read-only or not read-only variable.
Emit.release_desktop([close_projects, ...])	Release AEDT.
Emit.remove_all_unused_definitions()	Remove all unused definitions in the project.
Emit.rename_design(name[, save])	Rename the active design.
Emit.save_project([file_name, overwrite, ...])	Save the AEDT project and the current EMIT revision.
Emit.set_active_design(name)	Change the active design to another design.
Emit.set_active_dso_config_name([...])	Change a specific registry key to a new value.
Emit.set_license_type([license_type])	Change the license type between "Pack" and "Pool".
Emit.set_oo_property_value(aedt_object, ...)	Change the property value of the object-oriented AEDT object.
Emit.set_registry_from_file(registry_file[, ...])	Apply desktop registry settings from an ACT file.
Emit.set_registry_key(name, value)	Change a specific registry key to a new value.
Emit.set_temporary_directory(path)	Set temporary directory path.
Emit.set_units(unit_type, unit_value)	Set units for the EMIT design.
Emit.validate_simple([log_file])	Validate a design.
Emit.version([detailed])	Get version information.

Attributes

Emit.aedt_version_id	AEDT version.
Emit.boundaries	Design boundaries and excitations.
Emit.boundaries_by_type	Design boundaries by type.
Emit.couplings	EMIT Couplings.
Emit.default_solution_type	Default solution type.
Emit.design_datasets	Dictionary of Design Datasets.
Emit.design_list	Design list.
Emit.design_name	Design name.
Emit.design_properties	Design properties.
Emit.design_type	Design type.
Emit.desktop_class	Desktop class.
Emit.desktop_install_dir	AEDT installation directory.
Emit.info	Dictionary of the PyAEDT session information.
Emit.layouteditor	Return the Circuit Layout Editor.
Emit.library_list	Library list.
Emit.lock_file	Lock file.
Emit.logger	Logger for the design.
Emit.modeler	Modeler.
Emit.o_component_manager	Component manager object.
Emit.o_maxwell_parameters	AEDT Maxwell Parameter Setup Object.
Emit.o_model_manager	Model manager object.
Emit.o_symbol_manager	Aedt Symbol Manager.
Emit.oanalysis	Analysis AEDT Module.
Emit.oboundary	Boundary Object.
Emit.odefinition_manager	Definition Manager Module.
Emit.odesign	Design.
Emit.odesktop	AEDT instance containing all projects and designs.
Emit.oeditor	Oeditor Module.
Emit.oexcitation	Solution Module.
Emit.ofieldsreporter	Fields reporter.
Emit.oimport_export	Import/Export Manager Module.
Emit.omaterial_manager	Material Manager Module.
Emit.omatrix	Matrix Object.
Emit.omeshmodule	Icepak Mesh Module.
Emit.omodelsetup	AEDT Model Setup Object.
Emit.omonitor	AEDT Monitor Object.
Emit.ooptimetrics	AEDT Optimetrics Module.
Emit.ooutput_variable	AEDT Output Variable Module.
Emit.opadstackmanager	AEDT oPadstackManager.
Emit.oproject	Project property.
Emit.oradfield	AEDT Radiation Field Object.
Emit.oreportsetup	Report setup.
Emit.osolution	Solution Module.
Emit.personallib	PersonalLib directory.
Emit.ports	Design excitations.
Emit.project_datasets	Dictionary of project datasets.
Emit.project_file	Project name and path.
Emit.project_list	Project list.
Emit.project_name	Project name.
Emit.project_path	Project path.
Emit.project_properties	Project properties.
Emit.project_time_stamp	Return Project time stamp.
Emit.project_timestamp_changed	Return a bool if time stamp changed or not.
Emit.pyaedt_dir	PyAEDT directory.
Emit.results_directory	Results directory.
Emit.settings	Settings of the current Python/Pyaedt session.
Emit.solution_type	Solution type.
Emit.src_dir	Source directory for Python.
Emit.syslib	SysLib directory.
Emit.temp_directory	Path to the temporary directory.
Emit.toolkit_directory	Path to the toolkit directory.
Emit.userlib	UserLib directory.
Emit.valid_design	Valid design.
Emit.variable_manager	Variable manager for creating and managing project design and postprocessing variables.
Emit.working_directory	Path to the working directory.
Emit.results	''Result'' object for the selected design.