Rmxprt#

class ansys.aedt.core.rmxprt.Rmxprt(project=None, design=None, solution_type=None, model_units=None, setup=None, version=None, non_graphical=False, new_desktop=False, close_on_exit=False, student_version=False, machine='', port=0, aedt_process_id=None, remove_lock=False)#

Provides the RMxprt app 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.
model_unitsstr, optional: Model units.
setupstr, optional: Name of the setup to use as the nominal. The default is None, in which case the active setup is used or nothing is used.
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 open the AEDT student version. The default is False.
machinestr, optional: Machine name to connect the oDesktop session to. This works only in 2022 R2 or later. The remote server must be up and running with the command “ansysedt.exe -grpcsrv portnum”. If the machine is “localhost”, the server also starts if not present.
portint, optional: Port number on which to start the oDesktop communication on an already existing server. This parameter is ignored when creating a new server. It works only in 2022 R2 or later. The remote server must be up and running with the command “ansysedt.exe -grpcsrv portnum”.
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 instance of RMxprt and connect to an existing RMxprt design or create a new RMxprt design if one does not exist.

>>> from ansys.aedt.core import Rmxprt
>>> app = Rmxprt()

Create an instance of Rmxprt and link to a project named "projectname". If this project does not exist, create one with this name.

>>> app = Rmxprt(projectname)

Create an instance of RMxprt and link to a design named "designname" in a project named "projectname".

>>> app = Rmxprt(projectname,designame)

Create an instance of RMxprt and open the specified project, which is "myfile.aedt".

>>> app = Rmxprt("myfile.aedt")

Methods

`Rmxprt.activate_variable_optimization`(name)	Activate optimization analysis for a variable and optionally set up ranges.
`Rmxprt.activate_variable_sensitivity`(name[, ...])	Activate sensitivity analysis for a variable and optionally set up ranges.
`Rmxprt.activate_variable_statistical`(name[, ...])	Activate statitistical analysis for a variable and optionally set up ranges.
`Rmxprt.activate_variable_tuning`(name[, ...])	Activate tuning analysis for a variable and optionally set up ranges.
`Rmxprt.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.
`Rmxprt.add_from_toolkit`(toolkit[, draw])	Add a new toolkit to the current application.
`Rmxprt.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.
`Rmxprt.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.
`Rmxprt.analyze`([setup, cores, tasks, gpus, ...])	Solve the active design.
`Rmxprt.analyze_setup`([name, cores, tasks, ...])	Analyze a design setup.
`Rmxprt.archive_project`([project_path, ...])	Archive the AEDT project and add a message.
`Rmxprt.autosave_disable`()	Disable autosave in AEDT.
`Rmxprt.autosave_enable`()	Enable autosave in AEDT.
`Rmxprt.change_automatically_use_causal_materials`([...])	Enable or disable the automatic use of causal materials for lossy dielectrics.
`Rmxprt.change_design_settings`(settings)	Set Design Settings.
`Rmxprt.change_material_override`([...])	Enable or disable the material override in the project.
`Rmxprt.change_property`(aedt_object, ...)	Change a property.
`Rmxprt.change_validation_settings`([...])	Update the validation design settings.
`Rmxprt.check_beta_option_enabled`(beta_option)	Check if a beta option is enabled.
`Rmxprt.check_if_project_is_loaded`(input_file)	Check if a project path is already loaded in active Desktop.
`Rmxprt.clean_proj_folder`([directory, name])	Delete a project folder.
`Rmxprt.close_desktop`()	Close AEDT and release it.
`Rmxprt.close_project`([name, save])	Close an AEDT project.
`Rmxprt.copy_design_from`(project, design[, ...])	Copy a design from a project into the active project.
`Rmxprt.copy_project`(destination, name)	Copy the project to another destination.
`Rmxprt.create_dataset`(name, x, y[, z, v, ...])	Create a dataset.
`Rmxprt.create_dataset1d_design`(name, x, y[, ...])	Create a design dataset.
`Rmxprt.create_dataset1d_project`(name, x, y)	Create a project dataset.
`Rmxprt.create_dataset3d`(name, x, y[, z, v, ...])	Create a 3D dataset.
`Rmxprt.create_maxwell_design`(setup_name[, ...])	Create a Maxwell design from Rmxprt project.
`Rmxprt.create_new_project`(name)	Create a project within AEDT.
`Rmxprt.create_output_variable`(variable, ...)	Create or modify an output variable.
`Rmxprt.create_setup`([name, setup_type])	Create an analysis setup for RmXport.
`Rmxprt.dataset_exists`(name[, is_project_dataset])	Check if a dataset exists.
`Rmxprt.deactivate_variable_optimization`(name)	Deactivate the optimization analysis for a variable.
`Rmxprt.deactivate_variable_sensitivity`(name)	Deactivate the sensitivity analysis for a variable.
`Rmxprt.deactivate_variable_statistical`(name)	Deactivate the statistical analysis for a variable.
`Rmxprt.deactivate_variable_tuning`(name)	Deactivate the tuning analysis for a variable.
`Rmxprt.delete_design`([name, fallback_design])	Delete a design from the current project.
`Rmxprt.delete_project`(name)	Delete a project.
`Rmxprt.delete_separator`(name)	Delete a separator from either the active project or a design.
`Rmxprt.delete_setup`(name)	Delete a setup.
`Rmxprt.delete_unused_variables`()	Delete design and project unused variables.
`Rmxprt.delete_variable`(name)	Delete a variable.
`Rmxprt.design_variation`([variation])	Generate a string to specify a desired variation.
`Rmxprt.disable_modelcreation`([solution_type])	Enable the RMxprt solution.
`Rmxprt.duplicate_design`(name[, ...])	Copy a design to a new name.
`Rmxprt.edit_notes`(text)	Edit notes.
`Rmxprt.edit_setup`(name, properties)	Modify a setup.
`Rmxprt.enable_modelcreation`([solution_type])	Enable model creation for the Maxwell model wizard.
`Rmxprt.evaluate_expression`(expression)	Evaluate a valid string expression and return the numerical value in SI units.
`Rmxprt.export_configuration`(output_file)	Export Rmxprt project to config file.
`Rmxprt.export_convergence`(setup[, ...])	Export a solution convergence to a file.
`Rmxprt.export_design_preview_to_jpg`(output_file)	Export design preview image to a JPG file.
`Rmxprt.export_parametric_results`(sweep, ...)	Export a list of all parametric variations solved for a sweep to a CSV file.
`Rmxprt.export_profile`(setup[, variation, ...])	Export a solution profile to a PROF file.
`Rmxprt.export_results`([analyze, ...])	Export all available reports to a file, including profile, and convergence and sNp when applicable.
`Rmxprt.export_rl_matrix`(matrix_name, output_file)	Export R/L matrix after solving.
`Rmxprt.export_variables_to_csv`(output_file)	Export design properties, project variables, or both to a CSV file.
`Rmxprt.generate_temp_project_directory`(name)	Generate a unique directory string to save a project to.
`Rmxprt.generate_unique_setup_name`([name])	Generate a new setup with a unique name.
`Rmxprt.get_evaluated_value`(name[, units])	Retrieve the evaluated value of a design property or project variable in SI units if no unit is provided.
`Rmxprt.get_module`(module_name)	Aedt Module object.
`Rmxprt.get_monitor_data`()	Check and get monitor data of an existing analysis.
`Rmxprt.get_nominal_variation`([with_values])	Retrieve the nominal variation.
`Rmxprt.get_object_material_properties`([...])	Retrieve the material properties for a list of objects and return them in a dictionary.
`Rmxprt.get_oo_name`(aedt_object[, object_name])	Return the object-oriented AEDT property names.
`Rmxprt.get_oo_object`(aedt_object, object_name)	Return the Object Oriented AEDT Object.
`Rmxprt.get_oo_properties`(aedt_object, ...)	Return the Object Oriented AEDT Object Properties.
`Rmxprt.get_oo_property_value`(aedt_object, ...)	Return the Object Oriented AEDT Object Properties.
`Rmxprt.get_output_variable`(variable[, solution])	Retrieve the value of the output variable.
`Rmxprt.get_profile`([name])	Get profile information.
`Rmxprt.get_registry_key_int`(name)	Get the value for the AEDT registry key if one exists.
`Rmxprt.get_registry_key_string`(name)	Get the value for the AEDT registry key if one exists.
`Rmxprt.get_setup`(name)	Get the setup from the current design.
`Rmxprt.get_setups`()	Retrieve setups.
`Rmxprt.get_sweeps`(name)	Retrieve all sweeps for a setup.
`Rmxprt.get_traces_for_plot`([get_self_terms, ...])	Retrieve a list of traces of specified designs ready to use in plot reports.
`Rmxprt.hidden_variable`(name[, value])	Set the variable to a hidden or unhidden variable.
`Rmxprt.import_configuration`(input_file)	Parse a json file and assign all the properties to the Rmxprt design.
`Rmxprt.import_dataset1d`(input_file[, name, ...])	Import a 1D dataset.
`Rmxprt.import_dataset3d`(input_file[, name, ...])	Import a 3D dataset.
`Rmxprt.insert_design`([name, solution_type])	Add a design of a specified type.
`Rmxprt.list_of_variations`([setup, sweep])	Retrieve a list of active variations for input setup.
`Rmxprt.load_project`(file_name[, design, ...])	Open an AEDT project based on a project and optional design.
`Rmxprt.number_with_units`(value[, units])	Convert a number to a string with units.
`Rmxprt.read_design_data`()	Read back the design data as a dictionary.
`Rmxprt.read_only_variable`(name[, value])	Set the variable to a read-only or not read-only variable.
`Rmxprt.release_desktop`([close_projects, ...])	Release AEDT.
`Rmxprt.remove_all_unused_definitions`()	Remove all unused definitions in the project.
`Rmxprt.rename_design`(name[, save])	Rename the active design.
`Rmxprt.save_project`([file_name, overwrite, ...])	Save the project and add a message.
`Rmxprt.set_active_design`(name)	Change the active design to another design.
`Rmxprt.set_active_dso_config_name`([...])	Change a specific registry key to a new value.
`Rmxprt.set_license_type`([license_type])	Change the license type between `"Pack"` and `"Pool"`.
`Rmxprt.set_material_threshold`([...])	Set material threshold.
`Rmxprt.set_oo_property_value`(aedt_object, ...)	Change the property value of the object-oriented AEDT object.
`Rmxprt.set_registry_from_file`(registry_file)	Apply desktop registry settings from an ACT file.
`Rmxprt.set_registry_key`(name, value)	Change a specific registry key to a new value.
`Rmxprt.set_temporary_directory`(path)	Set temporary directory path.
`Rmxprt.solve_in_batch`([file_name, machine, ...])	Analyze a design setup in batch mode.
`Rmxprt.stop_simulations`([clean_stop])	Check if there are simulation running and stops them.
`Rmxprt.submit_job`(cluster_name[, ...])	Submit a job to be solved on a cluster.
`Rmxprt.validate_simple`([log_file])	Validate a design.
`Rmxprt.value_with_units`(value[, units, ...])	Combine a number and a string containing the modeler length unit in a single string e.g. "1.2mm".

Attributes

`Rmxprt.Position`	Position of the object.
`Rmxprt.SimulationSetupTypes`	Simulation setup types.
`Rmxprt.SolutionTypes`	Solution types.
`Rmxprt.active_setup`	Get or Set the name of the active setup.
`Rmxprt.aedt_version_id`	AEDT version.
`Rmxprt.are_there_simulations_running`	Check if there are simulation running.
`Rmxprt.available_variations`	Available variation object.
`Rmxprt.boundaries`	Design boundaries and excitations.
`Rmxprt.boundaries_by_type`	Design boundaries by type.
`Rmxprt.default_solution_type`	Default solution type.
`Rmxprt.design_datasets`	Dictionary of Design Datasets.
`Rmxprt.design_list`	Design list.
`Rmxprt.design_name`	Design name.
`Rmxprt.design_properties`	Design properties.
`Rmxprt.design_type`	Machine design type.
`Rmxprt.desktop_class`	`Desktop` class.
`Rmxprt.desktop_install_dir`	AEDT installation directory.
`Rmxprt.excitation_objects`	Get all excitation.
`Rmxprt.excitations`	Get all excitation names.
`Rmxprt.excitations_by_type`	Design excitations by type.
`Rmxprt.existing_analysis_setups`	Existing analysis setups.
`Rmxprt.existing_analysis_sweeps`	Existing analysis sweeps.
`Rmxprt.info`	Dictionary of the PyAEDT session information.
`Rmxprt.layouteditor`	Return the Circuit Layout Editor.
`Rmxprt.library_list`	Library list.
`Rmxprt.lock_file`	Lock file.
`Rmxprt.logger`	Logger for the design.
`Rmxprt.materials`	Materials in the project.
`Rmxprt.modeler`	Modeler.
`Rmxprt.native_component_names`	Native component names.
`Rmxprt.native_components`	Native Component dictionary.
`Rmxprt.nominal_adaptive`	Nominal adaptive sweep.
`Rmxprt.nominal_sweep`	Nominal sweep.
`Rmxprt.o_component_manager`	Component manager object.
`Rmxprt.o_maxwell_parameters`	AEDT Maxwell Parameter Setup Object.
`Rmxprt.o_model_manager`	Model manager object.
`Rmxprt.o_symbol_manager`	Aedt Symbol Manager.
`Rmxprt.oanalysis`	Analysis AEDT Module.
`Rmxprt.oboundary`	Boundary Object.
`Rmxprt.odefinition_manager`	Definition Manager Module.
`Rmxprt.odesign`	Design.
`Rmxprt.odesktop`	AEDT instance containing all projects and designs.
`Rmxprt.oeditor`	Oeditor Module.
`Rmxprt.oexcitation`	Solution Module.
`Rmxprt.ofieldsreporter`	Fields reporter.
`Rmxprt.oimport_export`	Import/Export Manager Module.
`Rmxprt.omaterial_manager`	Material Manager Module.
`Rmxprt.omatrix`	Matrix Object.
`Rmxprt.omeshmodule`	Icepak Mesh Module.
`Rmxprt.omodelsetup`	AEDT Model Setup Object.
`Rmxprt.omonitor`	AEDT Monitor Object.
`Rmxprt.ooptimetrics`	AEDT Optimetrics Module.
`Rmxprt.ooutput_variable`	AEDT Output Variable Module.
`Rmxprt.opadstackmanager`	AEDT oPadstackManager.
`Rmxprt.oproject`	Project property.
`Rmxprt.optimizations`	Optimizations in the project.
`Rmxprt.oradfield`	AEDT Radiation Field Object.
`Rmxprt.oreportsetup`	Report setup.
`Rmxprt.osolution`	Solution Module.
`Rmxprt.output_variables`	List of output variables.
`Rmxprt.parametrics`	Setups in the project.
`Rmxprt.personallib`	PersonalLib directory.
`Rmxprt.ports`	Design excitations.
`Rmxprt.post`	Post Object.
`Rmxprt.project_datasets`	Dictionary of project datasets.
`Rmxprt.project_file`	Project name and path.
`Rmxprt.project_list`	Project list.
`Rmxprt.project_name`	Project name.
`Rmxprt.project_path`	Project path.
`Rmxprt.project_properties`	Project properties.
`Rmxprt.project_time_stamp`	Return Project time stamp.
`Rmxprt.project_timestamp_changed`	Return a bool if time stamp changed or not.
`Rmxprt.pyaedt_dir`	PyAEDT directory.
`Rmxprt.results_directory`	Results directory.
`Rmxprt.settings`	Settings of the current Python/Pyaedt session.
`Rmxprt.setup_names`	Setup names.
`Rmxprt.setups`	Setups in the project.
`Rmxprt.solution_type`	Solution type.
`Rmxprt.src_dir`	Source directory for Python.
`Rmxprt.syslib`	SysLib directory.
`Rmxprt.temp_directory`	Path to the temporary directory.
`Rmxprt.toolkit_directory`	Path to the toolkit directory.
`Rmxprt.userlib`	UserLib directory.
`Rmxprt.valid_design`	Valid design.
`Rmxprt.variable_manager`	Variable manager for creating and managing project design and postprocessing variables.
`Rmxprt.working_directory`	Path to the working directory.