From 84a7b79702c2c45a48cc5501a20ebb741eeb1119 Mon Sep 17 00:00:00 2001 From: Maxime Rey <87315832+MaxJPRey@users.noreply.github.com> Date: Tue, 17 Dec 2024 22:38:49 +0100 Subject: [PATCH] DOCS: Fix numpy docstyle warnings and errors. (#5586) --- src/ansys/aedt/core/__init__.py | 2 +- .../aedt/core/application/aedt_objects.py | 18 --- src/ansys/aedt/core/application/analysis.py | 27 ----- .../aedt/core/application/analysis_3d.py | 10 -- .../core/application/analysis_3d_layout.py | 6 - .../aedt/core/application/analysis_hf.py | 6 - .../aedt/core/application/analysis_nexxim.py | 8 -- .../core/application/analysis_r_m_xprt.py | 1 - .../core/application/analysis_twin_builder.py | 3 - src/ansys/aedt/core/application/design.py | 61 ----------- src/ansys/aedt/core/application/variables.py | 28 ----- src/ansys/aedt/core/circuit.py | 11 -- src/ansys/aedt/core/common_rpc.py | 4 +- src/ansys/aedt/core/desktop.py | 7 +- src/ansys/aedt/core/generic/design_types.py | 4 +- .../aedt/core/generic/general_methods.py | 3 +- src/ansys/aedt/core/generic/ibis_reader.py | 22 ++-- .../aedt/core/generic/python_optimizers.py | 2 +- src/ansys/aedt/core/hfss.py | 54 --------- src/ansys/aedt/core/hfss3dlayout.py | 18 --- src/ansys/aedt/core/icepak.py | 50 --------- src/ansys/aedt/core/maxwell.py | 33 +----- src/ansys/aedt/core/mechanical.py | 11 -- .../core/modeler/advanced_cad/stackup_3d.py | 1 - .../aedt/core/modeler/cad/component_array.py | 3 - .../aedt/core/modeler/cad/components_3d.py | 13 --- .../aedt/core/modeler/cad/elements_3d.py | 28 ----- src/ansys/aedt/core/modeler/cad/object_3d.py | 46 -------- src/ansys/aedt/core/modeler/cad/polylines.py | 9 +- src/ansys/aedt/core/modeler/cad/primitives.py | 103 +----------------- .../aedt/core/modeler/cad/primitives_2d.py | 5 - .../aedt/core/modeler/cad/primitives_3d.py | 21 ---- .../modeler/circuits/object_3d_circuit.py | 12 -- .../modeler/circuits/primitives_circuit.py | 17 --- .../core/modeler/circuits/primitives_emit.py | 14 +-- .../circuits/primitives_maxwell_circuit.py | 5 - .../modeler/circuits/primitives_nexxim.py | 19 ---- .../circuits/primitives_twin_builder.py | 8 -- src/ansys/aedt/core/modeler/modeler_2d.py | 1 - src/ansys/aedt/core/modeler/modeler_3d.py | 4 - src/ansys/aedt/core/modeler/modeler_pcb.py | 16 --- .../aedt/core/modeler/pcb/object_3d_layout.py | 34 ------ .../core/modeler/pcb/primitives_3d_layout.py | 8 -- src/ansys/aedt/core/modeler/schematic.py | 9 -- .../aedt/core/modules/boundary/common.py | 4 +- .../core/modules/boundary/icepak_boundary.py | 4 +- .../aedt/core/modules/design_xploration.py | 10 -- src/ansys/aedt/core/modules/layer_stackup.py | 11 -- src/ansys/aedt/core/modules/material.py | 35 ------ src/ansys/aedt/core/modules/material_lib.py | 11 -- src/ansys/aedt/core/modules/mesh.py | 18 --- src/ansys/aedt/core/modules/mesh_3d_layout.py | 8 -- src/ansys/aedt/core/modules/mesh_icepak.py | 16 +-- src/ansys/aedt/core/modules/solve_setup.py | 35 ------ src/ansys/aedt/core/q3d.py | 17 --- src/ansys/aedt/core/rmxprt.py | 1 - src/ansys/aedt/core/twinbuilder.py | 5 - .../aedt/core/visualization/post/common.py | 12 -- .../core/visualization/post/field_data.py | 4 +- .../core/visualization/post/monitor_icepak.py | 4 - .../core/visualization/post/post_3dlayout.py | 2 +- .../core/visualization/post/post_common_3d.py | 11 -- .../core/visualization/post/post_icepak.py | 4 - .../core/visualization/post/solution_data.py | 2 +- .../aedt/core/visualization/post/spisim.py | 3 +- .../aedt/core/visualization/report/common.py | 1 - .../core/workflows/hfss/choke_designer.py | 4 +- .../workflows/icepak/power_map_from_csv.py | 2 +- tests/unit/conftest.py | 1 - 69 files changed, 32 insertions(+), 958 deletions(-) diff --git a/src/ansys/aedt/core/__init__.py b/src/ansys/aedt/core/__init__.py index 06fa85ba28d..7aae035fbb9 100644 --- a/src/ansys/aedt/core/__init__.py +++ b/src/ansys/aedt/core/__init__.py @@ -53,7 +53,7 @@ def deprecation_warning(): # Define and use custom showwarning def custom_show_warning(message, category, filename, lineno, file=None, line=None): - """Custom warning used to remove :loc: pattern.""" + """Define and use custom warning to remove :loc: pattern.""" print(f"{category.__name__}: {message}") warnings.showwarning = custom_show_warning diff --git a/src/ansys/aedt/core/application/aedt_objects.py b/src/ansys/aedt/core/application/aedt_objects.py index 7a40d704c13..51e79a7f568 100644 --- a/src/ansys/aedt/core/application/aedt_objects.py +++ b/src/ansys/aedt/core/application/aedt_objects.py @@ -88,7 +88,6 @@ def oradfield(self): References ---------- - >>> oDesign.GetModule("RadField") """ if self.design_type == "HFSS" and self._odesign.GetSolutionType() not in ["EigenMode", "Characteristic Mode"]: @@ -111,7 +110,6 @@ def o_symbol_manager(self): References ---------- - >>> oSymbolManager = oDefinitionManager.GetManager("Symbol") """ if self.odefinition_manager: @@ -124,7 +122,6 @@ def opadstackmanager(self): References ---------- - >>> oPadstackManger = oDefinitionManager.GetManager("Padstack") """ if self._oproject and not self._opadstackmanager: @@ -153,7 +150,6 @@ def oimport_export(self): References ---------- - >>> oDesktop.GetTool("ImportExport") """ if not self._oimport_export: @@ -166,7 +162,6 @@ def ooptimetrics(self): References ---------- - >>> oDesign.GetModule("Optimetrics") """ if not self._ooptimetrics and self.design_type not in ["Circuit Netlist", "Maxwell Circuit", "EMIT"]: @@ -179,7 +174,6 @@ def ooutput_variable(self): References ---------- - >>> oDesign.GetModule("OutputVariable") """ if not self._ooutput_variable and self.design_type not in ["EMIT", "Maxwell Circuit", "Circuit Netlist"]: @@ -192,7 +186,6 @@ def oanalysis(self): References ---------- - >>> oDesign.GetModule("SolveSetups") >>> oDesign.GetModule("SimSetup") >>> oDesign.GetModule("AnalysisSetup") @@ -215,7 +208,6 @@ def odefinition_manager(self): References ---------- - >>> oDefinitionManager = oProject.GetDefinitionManager() """ if not self._odefinition_manager and self._oproject: @@ -228,7 +220,6 @@ def omaterial_manager(self): References ---------- - >>> oMaterialManager = oDefinitionManager.GetManager("Material") """ if self.odefinition_manager and not self._omaterial_manager: @@ -241,7 +232,6 @@ def omodelsetup(self): References ---------- - >>> oDesign.GetModule("ModelSetup") """ if self.design_type not in ["Maxwell 3D", "Maxwell 2D", "HFSS"]: @@ -261,7 +251,6 @@ def o_maxwell_parameters(self): References ---------- - >>> oDesign.GetModule("MaxwellParameterSetup") """ if self._odesign and self.design_type not in ["Maxwell 3D", "Maxwell 2D"]: @@ -285,7 +274,6 @@ def osolution(self): References ---------- - >>> oModule = oDesign.GetModule("Solutions") """ if not self._osolution: @@ -310,7 +298,6 @@ def oexcitation(self): References ---------- - >>> oModule = oDesign.GetModule("Excitations") """ if self.design_type not in ["HFSS3DLayout", "HFSS 3D Layout Design"]: @@ -339,7 +326,6 @@ def ofieldsreporter(self): References ---------- - >>> oDesign.GetModule("FieldsReporter") """ if self.design_type in [ @@ -366,7 +352,6 @@ def oreportsetup(self): References ---------- - >>> oDesign.GetModule("ReportSetup") """ if not self._oreportsetup: @@ -379,7 +364,6 @@ def omeshmodule(self): References ---------- - >>> oDesign.GetModule("MeshRegion") """ meshers = { @@ -403,7 +387,6 @@ def oeditor(self): References ---------- - >>> oEditor = oDesign.SetActiveEditor("SchematicEditor")""" if not self._oeditor and self._odesign: if self.design_type in ["Circuit Design", "Twin Builder", "Maxwell Circuit", "EMIT"]: @@ -427,7 +410,6 @@ def layouteditor(self): References ---------- - >>> oDesign.SetActiveEditor("Layout") """ if not self._layouteditor and self.design_type in ["Circuit Design"]: diff --git a/src/ansys/aedt/core/application/analysis.py b/src/ansys/aedt/core/application/analysis.py index b7568fc1e19..424497c7247 100644 --- a/src/ansys/aedt/core/application/analysis.py +++ b/src/ansys/aedt/core/application/analysis.py @@ -206,7 +206,6 @@ def output_variables(self): References ---------- - >>> oModule.GetOutputVariables() """ return self.ooutput_variable.GetOutputVariables() @@ -312,7 +311,6 @@ def active_setup(self): References ---------- - >>> oModule.GetAllSolutionSetups() """ if self._setup: @@ -345,7 +343,6 @@ def existing_analysis_sweeps(self): References ---------- - >>> oModule.GelAllSolutionNames >>> oModule.GetSweeps """ @@ -386,7 +383,6 @@ def nominal_adaptive(self): References ---------- - >>> oModule.GelAllSolutionNames >>> oModule.GetSweeps """ @@ -426,7 +422,6 @@ def existing_analysis_setups(self): References ---------- - >>> oModule.GetSetups """ setups = [] @@ -447,7 +442,6 @@ def setup_names(self): References ---------- - >>> oModule.GetSetups """ setup_names = [] @@ -489,7 +483,6 @@ def excitations(self): References ---------- - >>> oModule.GetExcitations """ try: @@ -529,7 +522,6 @@ def excitation_objects(self): References ---------- - >>> oModule.GetExcitations """ exc_names = self.excitations[::] @@ -676,7 +668,6 @@ def list_of_variations(self, setup=None, sweep=None): References ---------- - >>> oModule.ListVariations """ @@ -761,7 +752,6 @@ def export_results( References ---------- - >>> oModule.GetAllPortsList >>> oDesign.ExportProfile >>> oModule.ExportToFile @@ -977,7 +967,6 @@ def export_convergence(self, setup, variations="", output_file=None): References ---------- - >>> oModule.ExportConvergence """ if " : " in setup: @@ -1098,7 +1087,6 @@ def variations(self, setup_sweep=None, output_as_dict=False): References ---------- - >>> oModule.GetAvailableVariations """ variations_string = self.get_variation_strings(setup_sweep) @@ -1150,7 +1138,6 @@ def get_variation_strings(self, setup_sweep=None): References ---------- - >>> oModule.GetAvailableVariations """ if not setup_sweep: @@ -1177,7 +1164,6 @@ def nominal_w_values(self): References ---------- - >>> oDesign.GetChildObject('Variables').GetChildNames >>> oDesign.GetVariables >>> oDesign.GetVariableValue @@ -1200,7 +1186,6 @@ def nominal_w_values_dict(self): References ---------- - >>> oDesign.GetChildObject('Variables').GetChildNames >>> oDesign.GetVariables >>> oDesign.GetVariableValue @@ -1223,7 +1208,6 @@ def nominal_w_values_dict_w_dependent(self): References ---------- - >>> oDesign.GetChildObject('Variables').GetChildNames >>> oDesign.GetVariables >>> oDesign.GetVariableValue @@ -1259,7 +1243,6 @@ def get_setups(self): References ---------- - >>> oModule.GetSetups """ setups = self.oanalysis.GetSetups() @@ -1301,7 +1284,6 @@ def get_sweeps(self, name): References ---------- - >>> oModule.GetSweeps """ sweeps = self.oanalysis.GetSweeps(name) @@ -1328,7 +1310,6 @@ def export_parametric_results(self, sweep, output_file, export_units=True): References ---------- - >>> oModule.ExportParametricResults """ self.ooptimetrics.ExportParametricResults(sweep, output_file, export_units) @@ -1467,7 +1448,6 @@ def delete_setup(self, name): References ---------- - >>> oModule.DeleteSetups Examples @@ -1506,7 +1486,6 @@ def edit_setup(self, name, properties): References ---------- - >>> oModule.EditSetup """ @@ -1573,7 +1552,6 @@ def create_output_variable(self, variable, expression, solution=None, context=No References ---------- - >>> oModule.CreateOutputVariable """ if context is None: @@ -1611,7 +1589,6 @@ def get_output_variable(self, variable, solution=None): References ---------- - >>> oDesign.GetNominalVariation >>> oModule.GetOutputVariableValue """ @@ -1722,7 +1699,6 @@ def analyze( References ---------- - >>> oDesign.Analyze """ if solve_in_batch: @@ -1795,7 +1771,6 @@ def analyze_setup( References ---------- - >>> oDesign.Analyze """ start = time.time() @@ -2139,7 +2114,6 @@ def submit_job( References ---------- - >>> oDesktop.SubmitJob """ return self.desktop_class.submit_job( @@ -2464,7 +2438,6 @@ def change_property(self, aedt_object, tab_name, property_object, property_name, References ---------- - >>> oEditor.ChangeProperty """ if isinstance(property_value, list) and len(property_value) == 3: diff --git a/src/ansys/aedt/core/application/analysis_3d.py b/src/ansys/aedt/core/application/analysis_3d.py index 59ad9f755a0..37228551970 100644 --- a/src/ansys/aedt/core/application/analysis_3d.py +++ b/src/ansys/aedt/core/application/analysis_3d.py @@ -400,7 +400,6 @@ def get_property_value(self, assignment, property_name, property_type=None): References ---------- - >>> oDesign.GetPropertyValue """ boundary = {"HFSS": "HfssTab", "Icepak": "Icepak", "Q3D": "Q3D", "Maxwell3D": "Maxwell3D"} @@ -587,7 +586,6 @@ def import_3d_cad( References ---------- - >>> oEditor.Import """ return self.modeler.import_3d_cad( @@ -650,7 +648,6 @@ def export_3d_model( References ---------- - >>> oEditor.Export """ return self.modeler.export_3d_model( @@ -674,7 +671,6 @@ def get_all_sources(self): References ---------- - >>> oModule.GetAllSources """ return list(self.osolution.GetAllSources()) @@ -690,7 +686,6 @@ def get_all_source_modes(self): References ---------- - >>> oModule.GetAllSources """ return list(self.osolution.GetAllSourceModes()) @@ -713,7 +708,6 @@ def set_source_context(self, sources, number_of_modes=1): References ---------- - >>> oModule.SetSourceContexts """ @@ -746,7 +740,6 @@ def assign_material(self, assignment, material): References ---------- - >>> oEditor.AssignMaterial Examples @@ -845,7 +838,6 @@ def get_all_conductors_names(self): References ---------- - >>> oEditor.GetObjectsByMaterial """ if len(self.modeler.objects) != len(self.modeler.object_names): @@ -917,7 +909,6 @@ def assignmaterial_from_sherlock_files(self, component_file, material_file): References ---------- - >>> oEditor.AssignMaterial """ with open_file(material_file) as csvfile: @@ -1332,7 +1323,6 @@ def import_dxf( References ---------- - >>> oEditor.ImportDXF """ diff --git a/src/ansys/aedt/core/application/analysis_3d_layout.py b/src/ansys/aedt/core/application/analysis_3d_layout.py index 83040e8dedf..796953d1bee 100644 --- a/src/ansys/aedt/core/application/analysis_3d_layout.py +++ b/src/ansys/aedt/core/application/analysis_3d_layout.py @@ -182,7 +182,6 @@ def excitations(self): References ---------- - >>> oModule.GetExcitations """ return list(self.oboundary.GetAllPortsList()) @@ -227,7 +226,6 @@ def export_mesh_stats(self, setup, variations="", mesh_path=None): References ---------- - >>> oModule.ExportMeshStats """ if not mesh_path: @@ -258,7 +256,6 @@ def port_list(self): References ---------- - >>> oModule.GetAllPorts""" return self.oexcitation.GetAllPortsList() @@ -273,7 +270,6 @@ def existing_analysis_setups(self): References ---------- - >>> oModule.GetSetups """ setups = self.oanalysis.GetSetups() @@ -303,7 +299,6 @@ def create_setup(self, name="MySetupAuto", setup_type=None, **kwargs): References ---------- - >>> oModule.Add Examples @@ -379,7 +374,6 @@ def delete_setup(self, name): References ---------- - >>> oModule.Delete Examples diff --git a/src/ansys/aedt/core/application/analysis_hf.py b/src/ansys/aedt/core/application/analysis_hf.py index 1fda12d8a34..7d0ba7dea71 100644 --- a/src/ansys/aedt/core/application/analysis_hf.py +++ b/src/ansys/aedt/core/application/analysis_hf.py @@ -87,7 +87,6 @@ def get_all_return_loss_list(self, excitations=None, excitation_name_prefix="", References ---------- - >>> oEditor.GetAllPorts """ if excitations is None: @@ -143,7 +142,6 @@ def get_all_insertion_loss_list( References ---------- - >>> oEditor.GetAllPorts """ if drivers is None: @@ -203,7 +201,6 @@ def get_next_xtalk_list(self, drivers=None, drivers_prefix_name="", math_formula References ---------- - >>> oEditor.GetAllPorts """ next_xtalks = [] @@ -270,7 +267,6 @@ def get_fext_xtalk_list( References ---------- - >>> oEditor.GetAllPorts """ @@ -310,7 +306,6 @@ def get_touchstone_data(self, setup=None, sweep=None, variations=None): References ---------- - >>> oModule.GetSolutionDataPerVariation """ from ansys.aedt.core.visualization.advanced.touchstone_parser import TouchstoneData @@ -380,7 +375,6 @@ def export_touchstone( References ---------- - >>> oDesign.ExportNetworkData """ return self._app._export_touchstone( diff --git a/src/ansys/aedt/core/application/analysis_nexxim.py b/src/ansys/aedt/core/application/analysis_nexxim.py index 4dfd326032a..c5e653e257d 100644 --- a/src/ansys/aedt/core/application/analysis_nexxim.py +++ b/src/ansys/aedt/core/application/analysis_nexxim.py @@ -49,7 +49,6 @@ class FieldAnalysisCircuit(Analysis): Parameters ---------- - """ def __init__( @@ -111,7 +110,6 @@ def delete_setup(self, name): References ---------- - >>> oModule.RemoveSimSetup """ if name in self.existing_analysis_setups: @@ -192,7 +190,6 @@ def existing_analysis_sweeps(self): References ---------- - >>> oModule.GetAllSolutionSetups""" return self.existing_analysis_setups @@ -202,7 +199,6 @@ def existing_analysis_setups(self): References ---------- - >>> oModule.GetAllSolutionSetups""" setups = self.oanalysis.GetAllSolutionSetups() return setups @@ -238,7 +234,6 @@ def setup_names(self): References ---------- - >>> oModule.GetAllSolutionSetups""" return self.oanalysis.GetAllSolutionSetups() @@ -253,7 +248,6 @@ def source_names(self): References ---------- - >>> oDesign.GetChildObject("Excitations").GetChildNames() """ return list(self.odesign.GetChildObject("Excitations").GetChildNames()) @@ -325,7 +319,6 @@ def excitations(self): References ---------- - >>> oModule.GetAllPorts """ ports = [p.replace("IPort@", "").split(";")[0] for p in self.modeler.oeditor.GetAllPorts() if "IPort@" in p] @@ -412,7 +405,6 @@ def create_setup(self, name="MySetupAuto", setup_type=None, **kwargs): References ---------- - >>> oModule.AddLinearNetworkAnalysis >>> oModule.AddDCAnalysis >>> oModule.AddTransient diff --git a/src/ansys/aedt/core/application/analysis_r_m_xprt.py b/src/ansys/aedt/core/application/analysis_r_m_xprt.py index 4af51cf8634..e8f7f3f8d7f 100644 --- a/src/ansys/aedt/core/application/analysis_r_m_xprt.py +++ b/src/ansys/aedt/core/application/analysis_r_m_xprt.py @@ -35,7 +35,6 @@ class FieldAnalysisRMxprt(Analysis): Parameters ---------- - Returns ------- diff --git a/src/ansys/aedt/core/application/analysis_twin_builder.py b/src/ansys/aedt/core/application/analysis_twin_builder.py index 7bfd644282b..d2008966d90 100644 --- a/src/ansys/aedt/core/application/analysis_twin_builder.py +++ b/src/ansys/aedt/core/application/analysis_twin_builder.py @@ -36,7 +36,6 @@ class AnalysisTwinBuilder(Analysis): Parameters ---------- - Returns ------- @@ -48,7 +47,6 @@ def existing_analysis_setups(self): References ---------- - >>> oModule.GetAllSolutionSetups""" setups = list(self.oanalysis.GetAllSolutionSetups()) return setups @@ -59,7 +57,6 @@ def setup_names(self): References ---------- - >>> oModule.GetAllSolutionSetups""" return list(self.oanalysis.GetAllSolutionSetups()) diff --git a/src/ansys/aedt/core/application/design.py b/src/ansys/aedt/core/application/design.py index 5598bed480a..d3884f1f8cd 100644 --- a/src/ansys/aedt/core/application/design.py +++ b/src/ansys/aedt/core/application/design.py @@ -666,7 +666,6 @@ def aedt_version_id(self) -> str: References ---------- - >>> oDesktop.GetVersion() """ return aedt_versions.get_version_env_variable(self._aedt_version) @@ -686,7 +685,6 @@ def design_name(self) -> Optional[str]: References ---------- - >>> oDesign.GetName >>> oDesign.RenameDesignInstance @@ -743,7 +741,6 @@ def design_list(self) -> List[str]: References ---------- - >>> oProject.GetTopDesignList() """ deslist = list(self.oproject.GetTopDesignList()) @@ -782,7 +779,6 @@ def project_name(self) -> Optional[str]: References ---------- - >>> oProject.GetName """ if self._project_name: @@ -808,7 +804,6 @@ def project_list(self) -> List[str]: References ---------- - >>> oDesktop.GetProjectList """ return list(self.odesktop.GetProjectList()) @@ -824,7 +819,6 @@ def project_path(self) -> Optional[str]: References ---------- - >>> oProject.GetPath """ if not self._project_path and self.oproject: @@ -896,7 +890,6 @@ def solution_type(self) -> Optional[str]: References ---------- - >>> oDesign.GetSolutionType >>> oDesign.SetSolutionType """ @@ -942,7 +935,6 @@ def personallib(self) -> str: References ---------- - >>> oDesktop.GetPersonalLibDirectory """ return self.desktop_class.personallib @@ -958,7 +950,6 @@ def userlib(self) -> str: References ---------- - >>> oDesktop.GetUserLibDirectory """ return self.desktop_class.userlib @@ -974,7 +965,6 @@ def syslib(self) -> str: References ---------- - >>> oDesktop.GetLibraryDirectory """ return self.desktop_class.syslib @@ -1167,7 +1157,6 @@ def odesign(self): References ---------- - >>> oProject.SetActiveDesign >>> oProject.InsertDesign """ @@ -1215,7 +1204,6 @@ def oproject(self): References ---------- - >>> oDesktop.GetActiveProject >>> oDesktop.SetActiveProject >>> oDesktop.NewProject @@ -1781,7 +1769,6 @@ def set_license_type(self, license_type="Pool"): References ---------- - >>> oDesktop.SetRegistryString """ try: @@ -1847,7 +1834,6 @@ def get_registry_key_string(self, name): References ---------- - >>> oDesktop.GetRegistryString """ return self.odesktop.GetRegistryString(name) @@ -1868,7 +1854,6 @@ def get_registry_key_int(self, name): References ---------- - >>> oDesktop.GetRegistryInt """ return self.odesktop.GetRegistryInt(name) @@ -1889,7 +1874,6 @@ def check_beta_option_enabled(self, beta_option): References ---------- - >>> oDesktop.GetRegistryString """ limit = 100 @@ -1936,7 +1920,6 @@ def set_active_dso_config_name(self, product_name="HFSS", config_name="Local"): References ---------- - >>> oDesktop.SetRegistryString """ try: @@ -1967,7 +1950,6 @@ def set_registry_from_file(self, registry_file, make_active=True): References ---------- - >>> oDesktop.SetRegistryFromFile """ try: @@ -2089,7 +2071,6 @@ def activate_variable_statistical( References ---------- - >>> oDesign.ChangeProperty """ arg = ["NAME:AllTabs"] @@ -2120,7 +2101,6 @@ def activate_variable_optimization(self, name, minimum=None, maximum=None): References ---------- - >>> oDesign.ChangeProperty """ arg = ["NAME:AllTabs"] @@ -2151,7 +2131,6 @@ def activate_variable_sensitivity(self, name, minimum=None, maximum=None): References ---------- - >>> oDesign.ChangeProperty """ arg = ["NAME:AllTabs"] @@ -2182,7 +2161,6 @@ def activate_variable_tuning(self, name, minimum=None, maximum=None): References ---------- - >>> oDesign.ChangeProperty """ arg = ["NAME:AllTabs"] @@ -2209,7 +2187,6 @@ def deactivate_variable_statistical(self, name): References ---------- - >>> oDesign.ChangeProperty """ arg = ["NAME:AllTabs"] @@ -2236,7 +2213,6 @@ def deactivate_variable_optimization(self, name): References ---------- - >>> oDesign.ChangeProperty """ arg = ["NAME:AllTabs"] @@ -2263,7 +2239,6 @@ def deactivate_variable_sensitivity(self, name): References ---------- - >>> oDesign.ChangeProperty """ arg = ["NAME:AllTabs"] @@ -2290,7 +2265,6 @@ def deactivate_variable_tuning(self, name): References ---------- - >>> oDesign.ChangeProperty """ arg = ["NAME:AllTabs"] @@ -2320,7 +2294,6 @@ def hidden_variable(self, name, value=True): References ---------- - >>> oDesign.ChangeProperty Examples @@ -2374,7 +2347,6 @@ def read_only_variable(self, name, value=True): References ---------- - >>> oDesign.ChangeProperty Examples @@ -2571,7 +2543,6 @@ def autosave_disable(self): References ---------- - >>> oDesktop.EnableAutoSave """ self.odesktop.EnableAutoSave(False) @@ -2588,7 +2559,6 @@ def autosave_enable(self): References ---------- - >>> oDesktop.EnableAutoSave """ self.odesktop.EnableAutoSave(True) @@ -2686,7 +2656,6 @@ def load_project(self, file_name, design=None, close_active=False, set_active=Fa References ---------- - >>> oDesktop.OpenProject """ proj = self.odesktop.OpenProject(file_name) @@ -2730,7 +2699,6 @@ def create_dataset1d_design(self, name, x, y, x_unit="", y_unit="", sort=True): References ---------- - >>> oProject.AddDataset >>> oDesign.AddDataset """ @@ -2762,7 +2730,6 @@ def create_dataset1d_project(self, name, x, y, x_unit="", y_unit="", sort=True): References ---------- - >>> oProject.AddDataset >>> oDesign.AddDataset """ @@ -2816,7 +2783,6 @@ def create_dataset3d( References ---------- - >>> oDesign.AddDataset """ if name[0] == "$": @@ -2860,7 +2826,6 @@ def import_dataset1d(self, input_file, name=None, is_project_dataset=True, sort= References ---------- - >>> oProject.AddDataset >>> oDesign.AddDataset """ @@ -2918,7 +2883,6 @@ def import_dataset3d(self, input_file, name=None, encoding="utf-8-sig", is_proje References ---------- - >>> oProject.AddDataset """ index_of_dot = input_file.rfind(".") @@ -3039,7 +3003,6 @@ def create_dataset( References ---------- - >>> oProject.AddDataset >>> oDesign.AddDataset """ @@ -3130,7 +3093,6 @@ def change_automatically_use_causal_materials(self, lossy_dielectric=True): References ---------- - >>> oDesign.SetDesignSettings """ if lossy_dielectric: @@ -3156,7 +3118,6 @@ def change_material_override(self, material_override=True): References ---------- - >>> oDesign.SetDesignSettings """ if material_override: @@ -3188,7 +3149,6 @@ def change_validation_settings( References ---------- - >>> oDesign.SetDesignSettings """ self.logger.info("Changing the validation design settings") @@ -3258,7 +3218,6 @@ def copy_project(self, destination, name): References ---------- - >>> oProject.SaveAs """ self.logger.info("Copy AEDT Project ") @@ -3282,7 +3241,6 @@ def create_new_project(self, name): References ---------- - >>> oDesktop.NewProject """ self.logger.info("Creating new Project ") @@ -3312,7 +3270,6 @@ def close_project(self, name=None, save=True): References ---------- - >>> oDesktop.CloseProject """ legacy_name = self.project_name @@ -3381,7 +3338,6 @@ def delete_design(self, name=None, fallback_design=None): References ---------- - >>> oProject.DeleteDesign """ if not name: @@ -3427,7 +3383,6 @@ def delete_separator(self, name): References ---------- - >>> oProject.ChangeProperty >>> oDesign.ChangeProperty """ @@ -3444,7 +3399,6 @@ def delete_variable(self, name): References ---------- - >>> oProject.ChangeProperty >>> oDesign.ChangeProperty """ @@ -3486,7 +3440,6 @@ def insert_design(self, name=None, solution_type=None): References ---------- - >>> oProject.InsertDesign """ self._close_edb() @@ -3599,7 +3552,6 @@ def rename_design(self, name, save=True): References ---------- - >>> oDesign.RenameDesignInstance """ self._odesign.RenameDesignInstance(self.design_name, name) @@ -3636,7 +3588,6 @@ def copy_design_from(self, project, design, save_project=True, set_active_design References ---------- - >>> oProject.CopyDesign >>> oProject.Paste """ @@ -3695,7 +3646,6 @@ def duplicate_design(self, name, save_after_duplicate=True): References ---------- - >>> oProject.CopyDesign >>> oProject.Paste """ @@ -3769,7 +3719,6 @@ def export_variables_to_csv(self, output_file, export_project_variables=True, ex References ---------- - >>> oProject.GetProperties >>> oDesign.GetProperties >>> oProject.GetVariableValue @@ -3828,7 +3777,6 @@ def save_project(self, file_name=None, overwrite=True, refresh_ids=False): References ---------- - >>> oProject.Save >>> oProject.SaveAs """ @@ -3884,7 +3832,6 @@ def archive_project( References ---------- - >>> oProject.Save >>> oProject.SaveProjectArchive """ @@ -3915,7 +3862,6 @@ def delete_project(self, name): References ---------- - >>> oDesktop.DeleteProject """ if self.project_name == name: @@ -3934,7 +3880,6 @@ def set_active_design(self, name): References ---------- - >>> oProject.SetActiveDesign """ self._close_edb() @@ -3958,7 +3903,6 @@ def validate_simple(self, log_file=None): References ---------- - >>> oDesign.ValidateDesign """ if log_file: @@ -3985,7 +3929,6 @@ def get_evaluated_value(self, name, units=None): References ---------- - >>> oDesign.GetNominalVariation >>> oDesign.GetVariationVariableValue @@ -4112,7 +4055,6 @@ def design_variation(self, variation=None): References ---------- - >>> oDesign.GetNominalVariation """ nominal = self._odesign.GetNominalVariation() @@ -4232,7 +4174,6 @@ def set_temporary_directory(self, path): References ---------- - >>> oDesktop.SetTempDirectory() """ self.odesktop.SetTempDirectory(path) @@ -4256,7 +4197,6 @@ def edit_notes(self, text): References ---------- - >>> oDesign.EditNotes() Examples @@ -4278,7 +4218,6 @@ class DesignSettings: References ---------- - >>> oDesign.GetChildObject("Design Settings") """ diff --git a/src/ansys/aedt/core/application/variables.py b/src/ansys/aedt/core/application/variables.py index 74f0aa1a23c..ff951562e54 100644 --- a/src/ansys/aedt/core/application/variables.py +++ b/src/ansys/aedt/core/application/variables.py @@ -477,7 +477,6 @@ def variables(self): References ---------- - >>> oProject.GetVariables >>> oDesign.GetVariables >>> oProject.GetChildObject("Variables").GetChildNames @@ -529,7 +528,6 @@ def design_variables(self): References ---------- - >>> oDesign.GetVariables >>> oDesign.GetChildObject("Variables").GetChildNames """ @@ -546,7 +544,6 @@ def project_variables(self): References ---------- - >>> oProject.GetVariables >>> oProject.GetChildObject("Variables").GetChildNames """ @@ -564,7 +561,6 @@ def post_processing_variables(self): References ---------- - >>> oProject.GetVariables >>> oDesign.GetVariables >>> oProject.GetChildObject("Variables").GetChildNames @@ -593,7 +589,6 @@ def independent_variables(self): References ---------- - >>> oProject.GetVariables >>> oDesign.GetVariables >>> oProject.GetChildObject("Variables").GetChildNames @@ -612,7 +607,6 @@ def independent_project_variables(self): References ---------- - >>> oProject.GetVariables >>> oProject.GetChildObject("Variables").GetChildNames """ @@ -630,7 +624,6 @@ def independent_design_variables(self): References ---------- - >>> oDesign.GetVariables >>> oDesign.GetChildObject("Variables").GetChildNames """ @@ -648,7 +641,6 @@ def dependent_variables(self): References ---------- - >>> oProject.GetVariables >>> oDesign.GetVariables >>> oProject.GetChildObject("Variables").GetChildNames @@ -667,7 +659,6 @@ def dependent_project_variables(self): References ---------- - >>> oProject.GetVariables >>> oProject.GetChildObject("Variables").GetChildNames """ @@ -685,7 +676,6 @@ def dependent_design_variables(self): References ---------- - >>> oDesign.GetVariables >>> oDesign.GetChildObject("Variables").GetChildNames """ @@ -702,7 +692,6 @@ def project_variable_names(self): References ---------- - >>> oProject.GetVariables >>> oProject.GetChildObject("Variables").GetChildNames """ @@ -714,7 +703,6 @@ def design_variable_names(self): References ---------- - >>> oDesign.GetVariables >>> oDesign.GetChildObject("Variables").GetChildNames""" return [var_name for var_name in self.design_variables] @@ -725,7 +713,6 @@ def independent_project_variable_names(self): References ---------- - >>> oProject.GetVariables >>> oProject.GetChildObject("Variables").GetChildNames """ @@ -737,7 +724,6 @@ def independent_design_variable_names(self): References ---------- - >>> oDesign.GetVariables >>> oDesign.GetChildObject("Variables").GetChildNames""" return [var_name for var_name in self.independent_design_variables] @@ -748,7 +734,6 @@ def independent_variable_names(self): References ---------- - >>> oProject.GetVariables >>> oDesign.GetVariables >>> oProject.GetChildObject("Variables").GetChildNames @@ -761,7 +746,6 @@ def dependent_project_variable_names(self): References ---------- - >>> oProject.GetVariables >>> oProject.GetChildObject("Variables").GetChildNames """ @@ -773,7 +757,6 @@ def dependent_design_variable_names(self): References ---------- - >>> oDesign.GetVariables >>> oDesign.GetChildObject("Variables").GetChildNames""" return [var_name for var_name in self.dependent_design_variables] @@ -784,7 +767,6 @@ def dependent_variable_names(self): References ---------- - >>> oProject.GetVariables >>> oDesign.GetVariables >>> oProject.GetChildObject("Variables").GetChildNames @@ -931,7 +913,6 @@ def get_expression(self, name): # TODO: Should be renamed to "evaluate" References ---------- - >>> oProject.GetVariableValue >>> oDesign.GetVariableValue """ @@ -1218,7 +1199,6 @@ def delete_separator(self, name): References ---------- - >>> oProject.ChangeProperty >>> oDesign.ChangeProperty """ @@ -1259,7 +1239,6 @@ def delete_variable(self, name): References ---------- - >>> oProject.ChangeProperty >>> oDesign.ChangeProperty """ @@ -2280,7 +2259,6 @@ def create(self): References ---------- - >>> oProject.AddDataset >>> oDesign.AddDataset """ @@ -2312,7 +2290,6 @@ def add_point(self, x, y, z=None, v=None): References ---------- - >>> oProject.EditDataset >>> oDesign.EditDataset """ @@ -2339,7 +2316,6 @@ def remove_point_from_x(self, x): References ---------- - >>> oProject.EditDataset >>> oDesign.EditDataset """ @@ -2365,7 +2341,6 @@ def remove_point_from_index(self, id_to_remove): References ---------- - >>> oProject.EditDataset >>> oDesign.EditDataset """ @@ -2390,7 +2365,6 @@ def update(self): References ---------- - >>> oProject.EditDataset >>> oDesign.EditDataset """ @@ -2414,7 +2388,6 @@ def delete(self): References ---------- - >>> oProject.DeleteDataset >>> oDesign.DeleteDataset """ @@ -2443,7 +2416,6 @@ def export(self, output_dir=None): References ---------- - >>> oProject.ExportDataset >>> oDesign.ExportDataset """ diff --git a/src/ansys/aedt/core/circuit.py b/src/ansys/aedt/core/circuit.py index beb3fbb4b97..c7917d140b5 100644 --- a/src/ansys/aedt/core/circuit.py +++ b/src/ansys/aedt/core/circuit.py @@ -671,7 +671,6 @@ def get_source_pin_names( References ---------- - >>> oModule.GetExcitationsOfType """ if source_project_name and self.project_name != source_project_name and not source_project_path: @@ -723,7 +722,6 @@ def import_touchstone_solution(self, input_file, solution="Imported_Data"): References ---------- - >>> oDesign.ImportData """ if input_file[-2:] == "ts": @@ -894,7 +892,6 @@ def export_fullwave_spice( References ---------- - >>> oDesign.ExportFullWaveSpice """ if not design: @@ -1040,7 +1037,6 @@ def push_excitations(self, instance, thevenin_calculation=False, setup="LinearFr References ---------- - >>> oEditor.PushExcitations """ arg = ["NAME:options", "CalcThevenin:=", thevenin_calculation, "Sol:=", setup] @@ -1092,7 +1088,6 @@ def push_time_excitations( References ---------- - >>> oEditor.PushExcitations """ arg = [ @@ -1146,7 +1141,6 @@ def create_source(self, source_type, name=None): References ---------- - >>> oDesign.UpdateSources """ if not name: @@ -1194,7 +1188,6 @@ def assign_voltage_sinusoidal_excitation_to_ports(self, ports): References ---------- - >>> oDesign.UpdateSources """ @@ -1220,7 +1213,6 @@ def assign_current_sinusoidal_excitation_to_ports(self, ports): References ---------- - >>> oDesign.UpdateSources """ source_i = self.create_source(source_type="CurrentSin") @@ -1245,7 +1237,6 @@ def assign_power_sinusoidal_excitation_to_ports(self, ports): References ---------- - >>> oDesign.UpdateSources """ source_p = self.create_source(source_type="PowerSin") @@ -1272,7 +1263,6 @@ def assign_voltage_frequency_dependent_excitation_to_ports(self, ports, input_fi References ---------- - >>> oDesign.UpdateSources """ if not os.path.exists(input_file) or os.path.splitext(input_file)[1] != ".fds": @@ -2154,7 +2144,6 @@ def create_ibis_schematic_from_pins( Parameters ---------- - ibis_tx_file : str Full path to the IBIS file for transmitters. ibis_rx_file : str diff --git a/src/ansys/aedt/core/common_rpc.py b/src/ansys/aedt/core/common_rpc.py index 386c3b5e1a6..7673a04fe3e 100644 --- a/src/ansys/aedt/core/common_rpc.py +++ b/src/ansys/aedt/core/common_rpc.py @@ -139,7 +139,7 @@ def pyaedt_service_manager(port=17878, aedt_version=None, student_version=False): - """Starts the PyAEDT service manager using RPyC server on CPython. + """Start the PyAEDT service manager using RPyC server on CPython. This method, which must run on a server machine, is used as a service on the server machine to listen on a dedicated port for inbound requests to launch @@ -205,7 +205,7 @@ def pyaedt_service_manager(port=17878, aedt_version=None, student_version=False) def launch_server(port=18000, ansysem_path=None, non_graphical=False, threaded=True): - """Starts an RPyC server and listens on a specified port. + """Start an RPyC server and listens on a specified port. This method must run on a server machine only. diff --git a/src/ansys/aedt/core/desktop.py b/src/ansys/aedt/core/desktop.py index cdb19974194..f25703d17bb 100644 --- a/src/ansys/aedt/core/desktop.py +++ b/src/ansys/aedt/core/desktop.py @@ -241,7 +241,7 @@ def _find(): def exception_to_desktop(ex_value, tb_data): # pragma: no cover - """Writes the trace stack to AEDT when a Python error occurs. + """Write the trace stack to AEDT when a Python error occurs. The message is added to the AEDT global logger and to the log file (if present). @@ -747,7 +747,6 @@ def active_design(self, project_object=None, name=None, design_type=None): References ---------- - >>> oProject.GetActiveDesign >>> oProject.SetActiveDesign """ @@ -774,7 +773,6 @@ def active_project(self, name=None): References ---------- - >>> oDesktop.GetActiveProject >>> oDesktop.SetActiveProject """ @@ -807,7 +805,6 @@ def close_windows(self): References ---------- - >>> oDesktop.CloseAllWindows """ self.odesktop.CloseAllWindows() @@ -1852,7 +1849,6 @@ def submit_job( References ---------- - >>> oDesktop.SubmitJob """ @@ -1959,7 +1955,6 @@ def submit_ansys_cloud_job( References ---------- - >>> oDesktop.SubmitJob Examples diff --git a/src/ansys/aedt/core/generic/design_types.py b/src/ansys/aedt/core/generic/design_types.py index 98519369059..3fe5c007376 100644 --- a/src/ansys/aedt/core/generic/design_types.py +++ b/src/ansys/aedt/core/generic/design_types.py @@ -97,7 +97,7 @@ def launch_desktop( port=0, aedt_process_id=None, ): - """Initializes AEDT based on the inputs provided. + """Initialize AEDT based on the inputs provided. Parameters ---------- @@ -187,7 +187,7 @@ def launch_desktop( def get_pyaedt_app(project_name=None, design_name=None, desktop=None): - """Gets the PyAEDT object with a given project name and design name. + """Get the PyAEDT object with a given project name and design name. Parameters ---------- diff --git a/src/ansys/aedt/core/generic/general_methods.py b/src/ansys/aedt/core/generic/general_methods.py index fcb8ac29873..b5dcd1ddb91 100644 --- a/src/ansys/aedt/core/generic/general_methods.py +++ b/src/ansys/aedt/core/generic/general_methods.py @@ -277,8 +277,7 @@ def deprecate_kwargs(func_name, kwargs, aliases): def pyaedt_function_handler(direct_func=None, **deprecated_kwargs): - """Provides an exception handler, logging mechanism, and argument converter for client-server - communications. + """Provide an exception handler, logging mechanism, and argument converter for client-server communications. This method returns the function itself if correctly executed. Otherwise, it returns ``False`` and displays errors. diff --git a/src/ansys/aedt/core/generic/ibis_reader.py b/src/ansys/aedt/core/generic/ibis_reader.py index facb4da6a51..0cc4ea19977 100644 --- a/src/ansys/aedt/core/generic/ibis_reader.py +++ b/src/ansys/aedt/core/generic/ibis_reader.py @@ -783,7 +783,7 @@ def ibis_model(self): return self._ibis_model def parse_ibis_file(self): - """Reads \\*.ibis file content. + """Read \\*.ibis file content. Parameters ---------- @@ -885,7 +885,7 @@ def parse_ibis_file(self): # Model def read_model(self, ibis, model_list): - """Extracts model's info. + """Extract model's info. Parameters ---------- @@ -929,7 +929,7 @@ def read_model(self, ibis, model_list): # Model Selector def read_model_selector(self, ibis, model_selector_list): - """Extracts model selector's info. + """Extract model selector's info. Parameters ---------- @@ -957,7 +957,7 @@ def read_model_selector(self, ibis, model_selector_list): @classmethod def make_model(cls, current_line): - """Creates model object. + """Create model object. Parameters ---------- @@ -1015,7 +1015,7 @@ def read_component(self, ibis, comp_infos): @classmethod def fill_package_info(cls, component, pkg_info): - """Extracts model's info. + """Extract model's info. Parameters ---------- @@ -1038,7 +1038,7 @@ def fill_package_info(cls, component, pkg_info): @classmethod def get_component_name(cls, line): - """Gets the name of the component. + """Get the name of the component. Parameters ---------- @@ -1109,7 +1109,7 @@ def make_diff_pin_object(self, line, component, ibis): return def make_pin_object(self, line, component_name, ibis): - """Extracts model's info. + """Extract model's info. Parameters ---------- @@ -1164,7 +1164,7 @@ def make_pin_object(self, line, component_name, ibis): @classmethod def get_first_parameter(cls, line): - """Gets first parameter string value. + """Get first parameter string value. Parameters ---------- @@ -1175,9 +1175,7 @@ def get_first_parameter(cls, line): ------- str First info extracted from the current line. - """ - if line == "": return "" @@ -1307,7 +1305,7 @@ def parse_ibis_file(self): def is_started_with(src, find, ignore_case=True): - """Verifies if a string content starts with a specific string or not. + """Verify if a string content starts with a specific string or not. This is identical to ``str.startswith``, except that it includes the ``ignore_case`` parameter. @@ -1325,9 +1323,7 @@ def is_started_with(src, find, ignore_case=True): ------- bool ``True`` if the src string starts with the pattern. - """ - if ignore_case: return src.lower().startswith(find.lower()) return src.startswith(find) diff --git a/src/ansys/aedt/core/generic/python_optimizers.py b/src/ansys/aedt/core/generic/python_optimizers.py index a3e9e36a011..692b1231838 100644 --- a/src/ansys/aedt/core/generic/python_optimizers.py +++ b/src/ansys/aedt/core/generic/python_optimizers.py @@ -273,7 +273,7 @@ def __init__( self.evaluate_val = 1e10 def run(self): - """Implements the genetic algorithm""" + """Implement the genetic algorithm""" # Init Population pop = np.array([np.zeros(self.dim + 1)] * self.population_size) solo = np.zeros(self.dim + 1) diff --git a/src/ansys/aedt/core/hfss.py b/src/ansys/aedt/core/hfss.py index 2eaacfb7016..b77bf3aa13d 100644 --- a/src/ansys/aedt/core/hfss.py +++ b/src/ansys/aedt/core/hfss.py @@ -330,7 +330,6 @@ def table_names(self): References ---------- - >>> oModule.GetValidISolutionList """ table_names = [] @@ -724,7 +723,6 @@ def assign_coating( References ---------- - >>> oModule.AssignFiniteCond Examples @@ -825,7 +823,6 @@ def create_setup(self, name="MySetupAuto", setup_type=None, **kwargs): References ---------- - >>> oModule.InsertSetup Examples @@ -916,7 +913,6 @@ def create_linear_count_sweep( References ---------- - >>> oModule.InsertFrequencySweep Examples @@ -1029,7 +1025,6 @@ def create_linear_step_sweep( References ---------- - >>> oModule.InsertFrequencySweep Examples @@ -1111,7 +1106,6 @@ def create_single_point_sweep( References ---------- - >>> oModule.InsertFrequencySweep Examples @@ -1469,7 +1463,6 @@ def create_sbr_antenna( References ---------- - >>> oEditor.InsertNativeComponent Examples @@ -1594,7 +1587,6 @@ def create_sbr_file_based_antenna( References ---------- - >>> oEditor.InsertNativeComponent Examples @@ -1713,7 +1705,6 @@ def create_sbr_linked_antenna( References ---------- - >>> oEditor.InsertNativeComponent Examples @@ -1962,7 +1953,6 @@ def set_sbr_txrx_settings(self, txrx_settings): References ---------- - >>> oModule.SetSBRTxRxSettings """ if self.solution_type != "SBR+": @@ -2188,7 +2178,6 @@ def create_voltage_source_from_objects( References ---------- - >>> oModule.AssignVoltage Examples @@ -2243,7 +2232,6 @@ def create_current_source_from_objects( References ---------- - >>> oModule.AssignCurrent Examples @@ -2292,7 +2280,6 @@ def create_source_excitation(self, assignment, point1, point2, name, source_type References ---------- - >>> oModule.AssignVoltage >>> oModule.AssignCurrent """ @@ -2355,7 +2342,6 @@ def create_floquet_port( References ---------- - >>> oModule.AssignFloquetPort """ face_id = self.modeler.convert_to_selections(assignment, True) @@ -2449,7 +2435,6 @@ def assign_lattice_pair( References ---------- - >>> oModule.AssignLatticePair """ props = {} @@ -2491,7 +2476,6 @@ def auto_assign_lattice_pairs(self, assignment, coordinate_system="Global", coor References ---------- - >>> oModule.AutoIdentifyLatticePair """ objectname = self.modeler.convert_to_selections(assignment, True) @@ -2563,7 +2547,6 @@ def assign_secondary( References ---------- - >>> oModule.AssignSecondary """ props = {} @@ -2622,7 +2605,6 @@ def assign_primary(self, assignment, u_start, u_end, reverse_v=False, coordinate References ---------- - >>> oModule.AssignPrimary """ props = {} @@ -2728,7 +2710,6 @@ def create_perfecte_from_objects( References ---------- - >>> oModule.AssignPerfectE Examples @@ -2796,7 +2777,6 @@ def create_perfecth_from_objects( References ---------- - >>> oModule.AssignPerfectH Examples @@ -2858,7 +2838,6 @@ def sar_setup(self, assignment=-1, tissue_mass=1, material_density=1, voxel_size References ---------- - >>> oDesign.SARSetup """ self.odesign.SARSetup(tissue_mass, material_density, assignment, voxel_size, average_sar_method) @@ -2889,7 +2868,6 @@ def create_open_region(self, frequency="1GHz", boundary="Radiation", apply_infin References ---------- - >>> oModule.CreateOpenRegion """ vars = [ @@ -2971,7 +2949,6 @@ def create_lumped_rlc_between_objects( References ---------- - >>> oModule.AssignLumpedRLC Examples @@ -3072,7 +3049,6 @@ def create_impedance_between_objects( References ---------- - >>> oModule.AssignImpedance Examples @@ -3241,7 +3217,6 @@ def assign_voltage_source_to_sheet(self, assignment, start_direction=0, name=Non References ---------- - >>> oModule.AssignVoltage Examples @@ -3293,7 +3268,6 @@ def assign_current_source_to_sheet(self, assignment, start_direction=0, name=Non References ---------- - >>> oModule.AssignCurrent Examples @@ -3343,7 +3317,6 @@ def assign_perfecte_to_sheets(self, assignment, name=None, is_infinite_ground=Fa References ---------- - >>> oModule.AssignPerfectE Examples @@ -3385,7 +3358,6 @@ def assign_perfecth_to_sheets(self, assignment, name=None): References ---------- - >>> oModule.AssignPerfectH Examples @@ -3460,7 +3432,6 @@ def assign_lumped_rlc_to_sheet( References ---------- - >>> oModule.AssignLumpedRLC Examples @@ -3556,7 +3527,6 @@ def assign_impedance_to_sheet( References ---------- - >>> oModule.AssignImpedance Examples @@ -3670,7 +3640,6 @@ def create_circuit_port_from_edges( References ---------- - >>> oModule.AssignCircuitPort Examples @@ -3853,7 +3822,6 @@ def edit_source(self, assignment=None, power="1W", phase="0deg"): References ---------- - >>> oModule.EditSources Examples @@ -4091,7 +4059,6 @@ def thicken_port_sheets(self, assignment, value, extrude_internally=True, intern References ---------- - >>> oEditor.ThickenSheet Examples @@ -4248,7 +4215,6 @@ def validate_full_design(self, design=None, output_dir=None, ports=None): References ---------- - >>> oDesign.ValidateDesign Examples @@ -4384,7 +4350,6 @@ def create_scattering( References ---------- - >>> oModule.CreateReport Examples @@ -4436,7 +4401,6 @@ def create_qfactor_report(self, project_dir, output, setup, name, x_axis="X"): References ---------- - >>> oModule.CreateReport """ @@ -4469,7 +4433,6 @@ def assign_radiation_boundary_to_objects(self, assignment, name=None): References ---------- - >>> oModule.AssignRadiation Examples @@ -4512,7 +4475,6 @@ def assign_hybrid_region(self, assignment, name=None, hybrid_region="SBR+"): References ---------- - >>> oModule.AssignHybridRegion Examples @@ -4555,7 +4517,6 @@ def assign_febi(self, assignment, name=None): References ---------- - >>> oModule.AssignFEBI Examples @@ -4597,7 +4558,6 @@ def assign_radiation_boundary_to_faces(self, assignment, name=None): References ---------- - >>> oModule.AssignRadiation Examples @@ -4731,7 +4691,6 @@ def create_sbr_chirp_i_doppler_setup( References ---------- - >>> oModule.InsertSetup """ @@ -4837,7 +4796,6 @@ def create_sbr_chirp_iq_doppler_setup( References ---------- - >>> oModule.InsertSetup """ if self.solution_type != "SBR+": @@ -4934,7 +4892,6 @@ def create_sbr_pulse_doppler_setup( References ---------- - >>> oModule.InsertSetup """ if self.solution_type != "SBR+": @@ -5454,7 +5411,6 @@ def set_sbr_current_sources_options(self, conformance=False, thin_sources=False, References ---------- - >>> oModule.EditGlobalCurrentSourcesOption """ if self.solution_type != "SBR+": @@ -6066,7 +6022,6 @@ def assign_symmetry(self, assignment, name=None, is_perfect_e=True): References ---------- - >>> oModule.AssignSymmetry Examples @@ -6117,7 +6072,6 @@ def set_impedance_multiplier(self, multiplier): References ---------- - >>> oModule.ChangeImpedanceMult Examples @@ -6158,7 +6112,6 @@ def set_phase_center_per_port(self, coordinate_system=None): References ---------- - >>> oModule.SetPhaseCenterPerPort Examples @@ -6292,7 +6245,6 @@ def circuit_port( References ---------- - >>> oModule.AssignCircuitPort Examples @@ -6517,7 +6469,6 @@ def wave_port( References ---------- - >>> oModule.AssignWavePort Examples @@ -6693,7 +6644,6 @@ def plane_wave( References ---------- - >>> oModule.AssignPlaneWave Examples @@ -6853,7 +6803,6 @@ def set_mesh_fusion_settings(self, assignment=None, volume_padding=None, priorit References ---------- - >>> oDesign.SetDoMeshAssembly Examples @@ -6943,7 +6892,6 @@ def export_element_pattern( References ---------- - >>> oModule.ExportElementPatternToFile """ self.logger.info("Exporting embedded element patterns...") @@ -7024,7 +6972,6 @@ def export_antenna_metadata( References ---------- - >>> oModule.ExportMetadata """ self.logger.info("Exporting antenna metadata...") @@ -7124,7 +7071,6 @@ def export_touchstone_on_completion(self, export=True, output_dir=None): References ---------- - >>> oDesign.SetDesignSettings """ if export: diff --git a/src/ansys/aedt/core/hfss3dlayout.py b/src/ansys/aedt/core/hfss3dlayout.py index a2a9890f7bc..81243de5679 100644 --- a/src/ansys/aedt/core/hfss3dlayout.py +++ b/src/ansys/aedt/core/hfss3dlayout.py @@ -259,7 +259,6 @@ def create_edge_port( References ---------- - >>> oEditor.CreateEdgePort """ assignment = self.modeler.convert_to_selections(assignment, False) @@ -400,7 +399,6 @@ def create_wave_port_from_two_conductors(self, assignment=None, edge_numbers=Non References ---------- - >>> oEditor.CreateEdgePort """ if edge_numbers is None: @@ -478,7 +476,6 @@ def create_ports_on_component_by_nets( References ---------- - >>> oEditor.CreateEdgePort """ listp = self.port_list @@ -522,7 +519,6 @@ def create_pec_on_component_by_nets( References ---------- - >>> oEditor.CreateEdgePort """ if isinstance(nets, list): @@ -555,7 +551,6 @@ def create_differential_port(self, via_signal, via_reference, name, deembed=True References ---------- - >>> oEditor.CreateEdgePort """ listp = self.port_list @@ -604,7 +599,6 @@ def create_coax_port(self, via, radial_extent=0.1, layer=None, alignment="lower" References ---------- - >>> oEditor.CreateEdgePort """ listp = self.port_list @@ -658,7 +652,6 @@ def create_pin_port(self, name, x=0, y=0, rotation=0, top_layer=None, bottom_lay References ---------- - >>> oEditor.CreatePin """ layers = self.modeler.layers.all_signal_layers @@ -711,7 +704,6 @@ def delete_port(self, name): References ---------- - >>> oModule.Delete """ self.oexcitation.Delete(name) @@ -736,7 +728,6 @@ def import_edb(self, input_folder): References ---------- - >>> oModule.ImportEDB """ if "edb.def" not in input_folder: @@ -770,7 +761,6 @@ def validate_full_design(self, name=None, output_dir=None, ports=None): References ---------- - >>> oDesign.ValidateDesign """ if name is None: @@ -875,7 +865,6 @@ def create_scattering( References ---------- - >>> oModule.CreateReport """ solution_data = "Standard" @@ -910,7 +899,6 @@ def export_touchstone_on_completion(self, export=True, output_dir=""): References ---------- - >>> oDesign.DesignOptions """ touchstone_settings = [] @@ -1153,7 +1141,6 @@ def create_linear_count_sweep( References ---------- - >>> oModule.AddSweep """ if sweep_type not in ["Discrete", "Interpolating", "Fast"]: @@ -1266,7 +1253,6 @@ def create_linear_step_sweep( References ---------- - >>> oModule.AddSweep """ if sweep_type not in ["Discrete", "Interpolating", "Fast"]: @@ -1348,7 +1334,6 @@ def create_single_point_sweep( References ---------- - >>> oModule.AddSweep """ if name is None: @@ -1565,7 +1550,6 @@ def import_brd( References ---------- - >>> oModule.ImportExtracta """ return self._import_cad(input_file, "brd", output_dir, control_file, set_as_active, close_active_project) @@ -1713,7 +1697,6 @@ def edit_cosim_options( References ---------- - >>> oDesign.EditCoSimulationOptions Examples @@ -2533,7 +2516,6 @@ def export_touchstone_on_completion(self, export=True, output_dir=None): References ---------- - >>> oDesign.SetDesignSettings """ if export: diff --git a/src/ansys/aedt/core/icepak.py b/src/ansys/aedt/core/icepak.py index 618ffa9ea2c..03ac510f68e 100644 --- a/src/ansys/aedt/core/icepak.py +++ b/src/ansys/aedt/core/icepak.py @@ -275,7 +275,6 @@ def assign_grille( References ---------- - >>> oModule.AssignGrilleBoundary """ if boundary_name is None: @@ -322,7 +321,6 @@ def assign_openings(self, air_faces): References ---------- - >>> oModule.AssignOpeningBoundary Examples @@ -377,7 +375,6 @@ def assign_2way_coupling( References ---------- - >>> oModule.AddTwoWayCoupling Examples @@ -432,7 +429,6 @@ def create_source_blocks_from_list(self, list_powers, assign_material=True, defa References ---------- - >>> oModule.AssignBlockBoundary Examples @@ -498,7 +494,6 @@ def create_source_block( References ---------- - >>> oModule.AssignBlockBoundary Examples @@ -696,7 +691,6 @@ def create_source_power( References ---------- - >>> oModule.AssignSourceBoundary Examples @@ -789,7 +783,6 @@ def create_network_block( References ---------- - >>> oModule.AssignNetworkBoundary Examples @@ -883,7 +876,6 @@ def create_network_blocks( References ---------- - >>> oModule.AssignNetworkBoundary Examples @@ -949,7 +941,6 @@ def assign_surface_monitor(self, face_name, monitor_type="Temperature", monitor_ References ---------- - >>> oModule.AssignFaceMonitor Examples @@ -1019,7 +1010,6 @@ def assign_point_monitor_in_object(self, name, monitor_type="Temperature", monit References ---------- - >>> oModule.AssignPointMonitor Examples @@ -1051,7 +1041,6 @@ def assign_block_from_sherlock_file(self, csv_name): References ---------- - >>> oModule.AssignBlockBoundary """ with open_file(csv_name) as csvfile: @@ -1113,7 +1102,6 @@ def assign_priority_on_intersections(self, component_prefix="COMP_"): References ---------- - >>> oEditor.UpdatePriorityList """ temp_log = os.path.join(self.working_directory, "validation.log") @@ -1156,7 +1144,6 @@ def find_top(self, gravityDir): References ---------- - >>> oEditor.GetModelBoundingBox """ dirs = ["-X", "+X", "-Y", "+Y", "-Z", "+Z"] @@ -1805,7 +1792,6 @@ def assign_em_losses( References ---------- - >>> oModule.AssignEMLoss """ if surface_objects is None: @@ -1908,7 +1894,6 @@ def eval_surface_quantity_from_field_summary( References ---------- - >>> oModule.ExportFieldsSummary """ name = generate_unique_name(quantity_name) @@ -1981,7 +1966,6 @@ def eval_volume_quantity_from_field_summary( References ---------- - >>> oModule.ExportFieldsSummary """ if not savedir: @@ -2057,7 +2041,6 @@ def export_summary( References ---------- - >>> oModule.EditFieldsSummarySetting >>> oModule.ExportFieldsSummary """ @@ -2249,7 +2232,6 @@ def create_fan( References ---------- - >>> oModule.InsertNativeComponent """ if not name: @@ -2392,7 +2374,6 @@ def create_ipk_3dcomponent_pcb( References ---------- - >>> oModule.InsertNativeComponent """ if "extenttype" in kwargs: @@ -2552,7 +2533,6 @@ def create_pcb_from_3dlayout( References ---------- - >>> oModule.InsertNativeComponent """ if "extenttype" in kwargs: @@ -2612,7 +2592,6 @@ def copyGroupFrom(self, group_name, source_design, source_project_name=None, sou References ---------- - >>> oEditor.Copy >>> oeditor.Paste """ @@ -2702,7 +2681,6 @@ def globalMeshSettings( References ---------- - >>> oModule.EditGlobalMeshRegion """ bounding_box = self.modeler.oeditor.GetModelBoundingBox() @@ -2783,7 +2761,6 @@ def create_meshregion_component( References ---------- - >>> oeditor.ChangeProperty """ warnings.warn( @@ -2847,7 +2824,6 @@ def delete_em_losses(self, bound_name): References ---------- - >>> oModule.DeleteBoundaries """ self.oboundary.DeleteBoundaries([bound_name]) @@ -2869,7 +2845,6 @@ def delete_pcb_component(self, comp_name): References ---------- - >>> oEditor.Delete """ arg = ["NAME:Selections", "Selections:=", comp_name] @@ -3110,7 +3085,6 @@ def apply_icepak_settings( References ---------- - >>> oDesign.SetDesignSettings """ @@ -3142,7 +3116,6 @@ def assign_surface_material(self, obj, mat): References ---------- - >>> oEditor.ChangeProperty """ objs = ["NAME:PropServers"] @@ -3276,7 +3249,6 @@ def import_idf( References ---------- - >>> oDesign.ImportIDF """ active_design_name = self.desktop_class.active_design(self.oproject).GetName() @@ -3399,7 +3371,6 @@ def create_two_resistor_network_block(self, object_name, pcb, power, rjb, rjc): References ---------- - >>> oModule.AssignNetworkBoundary Examples @@ -3626,7 +3597,6 @@ def assign_stationary_wall( References ---------- - >>> oModule.AssignStationaryWallBoundary """ if not name: @@ -3762,7 +3732,6 @@ def assign_stationary_wall_with_heat_flux( References ---------- - >>> oModule.AssignStationaryWallBoundary """ return self.assign_stationary_wall( @@ -3825,7 +3794,6 @@ def assign_stationary_wall_with_temperature( References ---------- - >>> oModule.AssignStationaryWallBoundary """ return self.assign_stationary_wall( @@ -3961,7 +3929,6 @@ def assign_stationary_wall_with_htc( References ---------- - >>> oModule.AssignStationaryWallBoundary """ return self.assign_stationary_wall( @@ -4020,7 +3987,6 @@ def create_setup(self, name=None, setup_type=None, **kwargs): References ---------- - >>> oModule.InsertSetup Examples @@ -4118,7 +4084,6 @@ def assign_source( References ---------- - >>> oModule.AssignSourceBoundary Examples @@ -4215,7 +4180,6 @@ def create_network_object(self, name=None, props=None, create=False): References ---------- - >>> oModule.AssignNetworkBoundary Examples @@ -4263,7 +4227,6 @@ def create_resistor_network_from_matrix(self, sources_power, faces_ids, matrix, References ---------- - >>> oModule.AssignNetworkBoundary Examples @@ -4346,7 +4309,6 @@ def assign_solid_block( References ---------- - >>> oModule.AssignBlockBoundary Examples @@ -4456,7 +4418,6 @@ def assign_hollow_block( References ---------- - >>> oModule.AssignBlockBoundary Examples @@ -4570,7 +4531,6 @@ def get_fans_operating_point(self, export_file=None, setup_name=None, time_step= References ---------- - >>> oModule.ExportFanOperatingPoint Examples @@ -4994,7 +4954,6 @@ def assign_symmetry_wall(self, geometry, boundary_name=None): References ---------- - >>> oModule.AssignSymmetryWallBoundary """ if not boundary_name: @@ -5042,7 +5001,6 @@ def assign_adiabatic_plate(self, assignment, high_radiation_dict=None, low_radia References ---------- - >>> oModule.AssignAdiabaticPlateBoundary Examples @@ -5193,7 +5151,6 @@ def assign_resistance( References ---------- - >>> oModule.AssignResistanceBoundary Examples @@ -5318,7 +5275,6 @@ def assign_power_law_resistance( References ---------- - >>> oModule.AssignResistanceBoundary Examples @@ -5406,7 +5362,6 @@ def assign_loss_curve_resistance( References ---------- - >>> oModule.AssignResistanceBoundary Examples @@ -5490,7 +5445,6 @@ def assign_device_resistance( References ---------- - >>> oModule.AssignResistanceBoundary Examples @@ -5575,7 +5529,6 @@ def assign_recirculation_opening( References ---------- - >>> oModule.AssignRecircBoundary Examples @@ -5725,7 +5678,6 @@ def assign_blower_type1( References ---------- - >>> oModule.AssignBlowerBoundary Examples @@ -5808,7 +5760,6 @@ def assign_blower_type2( References ---------- - >>> oModule.AssignBlowerBoundary Examples @@ -6438,7 +6389,6 @@ def clear_linked_data(self): References ---------- - >>> oDesign.ClearLinkedData """ try: diff --git a/src/ansys/aedt/core/maxwell.py b/src/ansys/aedt/core/maxwell.py index ea612a27ab3..1f4ebca5d1f 100644 --- a/src/ansys/aedt/core/maxwell.py +++ b/src/ansys/aedt/core/maxwell.py @@ -58,7 +58,6 @@ def symmetry_multiplier(self): References ---------- - >>> oModule.GetSymmetryMultiplier() """ return int(self.omodelsetup.GetSymmetryMultiplier()) @@ -69,7 +68,6 @@ def windings(self): References ---------- - >>> oModule.GetExcitationsOfType("Winding Group")""" windings = self.oboundary.GetExcitationsOfType("Winding Group") return list(windings) @@ -97,7 +95,6 @@ def change_symmetry_multiplier(self, value=1): References ---------- - >>> oDesign.SetDesignSettings """ return self.change_design_settings({"Multiplier": value}) @@ -122,7 +119,6 @@ def change_inductance_computation(self, compute_transient_inductance=True, incre References ---------- - >>> oDesign.SetDesignSettings """ return self.change_design_settings( @@ -237,7 +233,6 @@ def set_core_losses(self, assignment, core_loss_on_field=False): References ---------- - >>> oModule.SetCoreLoss Examples @@ -298,7 +293,6 @@ def assign_matrix( References ---------- - >>> oModule.AssignMatrix Examples @@ -552,7 +546,6 @@ def eddy_effects_on(self, assignment, enable_eddy_effects=True, enable_displacem References ---------- - >>> oModule.SetEddyEffect """ solid_objects_names = self.get_all_conductors_names() @@ -650,7 +643,6 @@ def setup_y_connection(self, assignment=None): References ---------- - >>> oModule.SetupYConnection Examples @@ -708,7 +700,6 @@ def assign_current(self, assignment, amplitude=1, phase="0deg", solid=True, swap References ---------- - >>> oModule.AssignCurrent Examples @@ -834,7 +825,6 @@ def assign_translate_motion( References ---------- - >>> oModule.AssignBand """ assert self.solution_type == SOLUTIONS.Maxwell3d.Transient, "Motion applies only to the Transient setup." @@ -932,7 +922,6 @@ def assign_rotate_motion( References ---------- - >>> oModule.AssignBand """ assert self.solution_type == SOLUTIONS.Maxwell3d.Transient, "Motion applies only to the Transient setup." @@ -985,7 +974,6 @@ def assign_voltage(self, assignment, amplitude=1, name=None): References ---------- - >>> oModule.AssignVoltage """ if isinstance(amplitude, (int, float)): @@ -1042,7 +1030,6 @@ def assign_voltage_drop(self, assignment, amplitude=1, swap_direction=False, nam References ---------- - >>> oModule.AssignVoltageDrop """ if isinstance(amplitude, (int, float)): @@ -1187,7 +1174,6 @@ def assign_winding( References ---------- - >>> oModule.AssignWindingGroup """ @@ -1242,7 +1228,6 @@ def add_winding_coils(self, assignment, coils): References ---------- - >>> oModule.AddWindingTerminals >>> oModule.AddWindingCoils """ @@ -1275,7 +1260,6 @@ def assign_coil(self, assignment, conductors_number=1, polarity="Positive", name References ---------- - >>> oModule.AssignCoil """ if polarity.lower() == "positive": @@ -1347,7 +1331,6 @@ def assign_force(self, assignment, coordinate_system="Global", is_virtual=True, References ---------- - >>> oModule.AssignForce Examples @@ -1437,7 +1420,6 @@ def assign_torque( References ---------- - >>> oModule.AssignTorque """ if self.solution_type not in ["ACConduction", "DCConduction"]: @@ -1496,7 +1478,6 @@ def solve_inside(self, name, activate=True): References ---------- - >>> oEditor.ChangeProperty """ self.modeler[name].solve_inside = activate @@ -1515,7 +1496,6 @@ def analyze_from_zero(self): References ---------- - >>> oModule.ResetSetupToTimeZero """ if self.solution_type != "Transient": @@ -1543,7 +1523,6 @@ def set_initial_angle(self, motion_setup, angle): References ---------- - >>> oDesign.ChangeProperty """ self.odesign.ChangeProperty( @@ -1584,7 +1563,6 @@ def assign_symmetry(self, assignment, symmetry_name=None, is_odd=True): References ---------- - >>> oModule.AssignSymmetry """ try: @@ -1770,7 +1748,6 @@ def assign_radiation(self, assignment, radiation=None): References ---------- - >>> oModule.Radiation Examples @@ -2302,9 +2279,7 @@ def __init__( aedt_process_id=None, remove_lock=False, ): - """ - Initialize the ``Maxwell`` class. - """ + """Initialize the ``Maxwell`` class.""" self.is3d = True FieldAnalysis3D.__init__( self, @@ -2349,7 +2324,6 @@ def assign_insulating(self, assignment, insulation=None): References ---------- - >>> oModule.AssignInsulating Examples @@ -2428,7 +2402,6 @@ def assign_impedance( References ---------- - >>> oModule.AssignImpedance Examples @@ -3173,7 +3146,6 @@ def geometry_mode(self): References ---------- - >>> oDesign.GetGeometryMode""" return self.odesign.GetGeometryMode() @@ -3332,7 +3304,6 @@ def assign_balloon(self, assignment, boundary=None): References ---------- - >>> oModule.AssignBalloon @@ -3382,7 +3353,6 @@ def assign_vector_potential(self, assignment, vector_value=0, boundary=None): References ---------- - >>> oModule.AssignVectorPotential @@ -3498,7 +3468,6 @@ def assign_end_connection(self, assignment, resistance=0, inductance=0, boundary References ---------- - >>> oModule.AssignEndConnection """ if self.solution_type not in ["EddyCurrent", "Transient"]: diff --git a/src/ansys/aedt/core/mechanical.py b/src/ansys/aedt/core/mechanical.py index 3cb96b9e53a..06dda2697ef 100644 --- a/src/ansys/aedt/core/mechanical.py +++ b/src/ansys/aedt/core/mechanical.py @@ -213,7 +213,6 @@ def assign_em_losses( References ---------- - >>> oModule.AssignEMLoss """ if surface_objects is None: @@ -319,7 +318,6 @@ def assign_thermal_map( References ---------- - >>> oModule.AssignThermalCondition """ if parameters is None: @@ -402,7 +400,6 @@ def assign_uniform_convection( References ---------- - >>> oModule.AssignConvection """ assert "Thermal" in self.solution_type, "This method works only in a Mechanical Thermal analysis." @@ -451,7 +448,6 @@ def assign_uniform_temperature(self, assignment, temperature="AmbientTemp", name References ---------- - >>> oModule.AssignTemperature """ assert "Thermal" in self.solution_type, "This method works only in a Mechanical Thermal analysis." @@ -497,7 +493,6 @@ def assign_frictionless_support(self, assignment, name=""): References ---------- - >>> oModule.AssignFrictionlessSupport """ if not (self.solution_type == "Structural" or "Modal" in self.solution_type): @@ -542,7 +537,6 @@ def assign_fixed_support(self, assignment, name=""): References ---------- - >>> oModule.AssignFixedSupport """ if not (self.solution_type == "Structural" or "Modal" in self.solution_type): @@ -573,7 +567,6 @@ def existing_analysis_sweeps(self): References ---------- - >>> oModule.GetSetups """ setup_list = self.existing_analysis_setups @@ -605,7 +598,6 @@ def assign_heat_flux(self, assignment, heat_flux_type, value, name=""): References ---------- - >>> oModule.AssignHeatFlux """ assert "Thermal" in self.solution_type, "This method works only in a Mechanical Thermal analysis." @@ -653,7 +645,6 @@ def assign_heat_generation(self, assignment, value, name=""): References ---------- - >>> oModule.AssignHeatGeneration """ assert "Thermal" in self.solution_type, "This method works only in a Mechanical Thermal analysis." @@ -692,7 +683,6 @@ def assign_2way_coupling(self, setup=None, number_of_iterations=2): References ---------- - >>> oModule.AddTwoWayCoupling Examples @@ -747,7 +737,6 @@ def create_setup(self, name="MySetupAuto", setup_type=None, **kwargs): References ---------- - >>> oModule.InsertSetup Examples diff --git a/src/ansys/aedt/core/modeler/advanced_cad/stackup_3d.py b/src/ansys/aedt/core/modeler/advanced_cad/stackup_3d.py index 70562bdcaed..e7e1258784e 100644 --- a/src/ansys/aedt/core/modeler/advanced_cad/stackup_3d.py +++ b/src/ansys/aedt/core/modeler/advanced_cad/stackup_3d.py @@ -2608,7 +2608,6 @@ class Trace(CommonObject, object): Parameters ---------- - application : :class:`ansys.aedt.core.hfss.Hfss` HFSS design or project where the variable is to be created. frequency : float, None diff --git a/src/ansys/aedt/core/modeler/cad/component_array.py b/src/ansys/aedt/core/modeler/cad/component_array.py index c41cb411ab9..540ded9f2da 100644 --- a/src/ansys/aedt/core/modeler/cad/component_array.py +++ b/src/ansys/aedt/core/modeler/cad/component_array.py @@ -360,7 +360,6 @@ def delete(self): References ---------- - >>> oModule.DeleteArray """ @@ -379,7 +378,6 @@ def export_array_info(self, output_file=None): # pragma: no cover References ---------- - >>> oModule.ExportArray """ @@ -505,7 +503,6 @@ def edit_array(self): References ---------- - >>> oModule.EditArray """ diff --git a/src/ansys/aedt/core/modeler/cad/components_3d.py b/src/ansys/aedt/core/modeler/cad/components_3d.py index 65b609c779c..614c7526706 100644 --- a/src/ansys/aedt/core/modeler/cad/components_3d.py +++ b/src/ansys/aedt/core/modeler/cad/components_3d.py @@ -200,7 +200,6 @@ def layout_component(self): References ---------- - >>> oEditor.GetPropertyValue >>> oEditor.ChangeProperty @@ -238,7 +237,6 @@ def group_name(self): References ---------- - >>> oEditor.GetPropertyValue >>> oEditor.ChangeProperty @@ -267,7 +265,6 @@ def group_name(self, name): References ---------- - >>> oEditor.GetPropertyValue >>> oEditor.ChangeProperty @@ -360,7 +357,6 @@ def name(self): References ---------- - >>> oEditor.GetPropertyValue >>> oEditor.ChangeProperty @@ -393,7 +389,6 @@ def parameters(self): References ---------- - >>> oEditor.GetPropertyValue >>> oEditor.ChangeProperty @@ -450,7 +445,6 @@ def target_coordinate_system(self): References ---------- - >>> oEditor.GetPropertyValue >>> oEditor.ChangeProperty @@ -484,7 +478,6 @@ def delete(self): References ---------- - >>> oEditor.Delete Examples @@ -524,7 +517,6 @@ def duplicate_and_mirror(self, origin, vector): References ---------- - >>> oEditor.DuplicateMirror """ return self._primitives.duplicate_and_mirror(self.name, origin=origin, vector=vector, is_3d_comp=True) @@ -549,7 +541,6 @@ def mirror(self, origin, vector): References ---------- - >>> oEditor.Mirror """ if self.is3dcomponent: @@ -583,7 +574,6 @@ def rotate(self, axis, angle=90.0, units="deg"): References ---------- - >>> oEditor.Rotate """ if self.is3dcomponent: @@ -646,7 +636,6 @@ def duplicate_around_axis(self, axis, angle=90, clones=2, create_new_objects=Tru References ---------- - >>> oEditor.DuplicateAroundAxis """ @@ -678,7 +667,6 @@ def duplicate_along_line(self, vector, clones=2, attach=False, **kwargs): References ---------- - >>> oEditor.DuplicateAlongLine """ @@ -1171,7 +1159,6 @@ def update_visibility(self): References ---------- - >>> oEditor.ChangeProperty """ diff --git a/src/ansys/aedt/core/modeler/cad/elements_3d.py b/src/ansys/aedt/core/modeler/cad/elements_3d.py index 19735a69aa5..89168acee53 100644 --- a/src/ansys/aedt/core/modeler/cad/elements_3d.py +++ b/src/ansys/aedt/core/modeler/cad/elements_3d.py @@ -107,7 +107,6 @@ def fillet(self, radius=0.1, setback=0.0): References ---------- - >>> oEditor.Fillet """ @@ -164,7 +163,6 @@ def chamfer(self, left_distance=1, right_distance=None, angle=45, chamfer_type=0 References ---------- - >>> oEditor.Chamfer """ @@ -249,7 +247,6 @@ def position(self): References ---------- - >>> oEditor.GetVertexPosition """ @@ -342,7 +339,6 @@ def vertices(self): References ---------- - >>> oEditor.GetVertexIDsFromEdge """ @@ -370,7 +366,6 @@ def midpoint(self): References ---------- - >>> oEditor.GetVertexPosition """ @@ -387,7 +382,6 @@ def length(self): References ---------- - >>> oEditor.GetEdgeLength """ @@ -415,7 +409,6 @@ def create_object(self, non_model=False): References ---------- - >>> oEditor.CreateObjectFromEdges """ return self._object3d._primitives.create_object_from_edge(self, non_model) @@ -437,7 +430,6 @@ def move_along_normal(self, offset=1.0): References ---------- - >>> oEditor.MoveEdges """ @@ -521,7 +513,6 @@ def edges(self): References ---------- - >>> oEditor.GetEdgeIDsFromFace """ @@ -541,7 +532,6 @@ def vertices(self): References ---------- - >>> oEditor.GetVertexIDsFromFace """ @@ -577,7 +567,6 @@ def center_from_aedt(self): References ---------- - >>> oEditor.GetFaceCenter """ @@ -625,7 +614,6 @@ def center(self): References ---------- - >>> oEditor.GetFaceCenter """ @@ -667,7 +655,6 @@ def area(self): References ---------- - >>> oEditor.GetFaceArea """ @@ -684,7 +671,6 @@ def top_edge_z(self): References ---------- - >>> oEditor.FaceCenter """ @@ -818,7 +804,6 @@ def move_with_offset(self, offset=1.0): References ---------- - >>> oEditor.MoveFaces """ @@ -861,7 +846,6 @@ def move_with_vector(self, vector): References ---------- - >>> oEditor.MoveFaces """ @@ -907,7 +891,6 @@ def normal(self): References ---------- - >>> oEditor.GetVertexPosition """ @@ -961,7 +944,6 @@ def create_object(self, non_model=False): References ---------- - >>> oEditor.CreateObjectFromFaces """ return self._object3d._primitives.create_object_from_face(self, non_model) @@ -1028,7 +1010,6 @@ def name(self): References ---------- - >>> oEditor.GetPropertyValue >>> oEditor.ChangeProperty @@ -1060,7 +1041,6 @@ def valid_properties(self): References ---------- - >>> oEditor.GetProperties """ if not self._all_props: @@ -1080,7 +1060,6 @@ def set_color(self, color_value): References ---------- - >>> oEditor.ChangeProperty Examples @@ -1128,7 +1107,6 @@ def coordinate_system(self): References ---------- - >>> oEditor.GetPropertyValue >>> oEditor.ChangeProperty @@ -1153,7 +1131,6 @@ def delete(self): References ---------- - >>> oEditor.Delete """ arg = ["NAME:Selections", "Selections:=", self._name] @@ -1229,7 +1206,6 @@ def name(self): References ---------- - >>> oEditor.GetPropertyValue >>> oEditor.ChangeProperty @@ -1264,7 +1240,6 @@ def valid_properties(self): References ---------- - >>> oEditor.GetProperties """ if not self._all_props: @@ -1285,7 +1260,6 @@ def set_color(self, color_value): References ---------- - >>> oEditor.ChangeProperty Examples @@ -1333,7 +1307,6 @@ def coordinate_system(self): References ---------- - >>> oEditor.GetPropertyValue >>> oEditor.ChangeProperty @@ -1359,7 +1332,6 @@ def delete(self): References ---------- - >>> oEditor.Delete """ arg = ["NAME:Selections", "Selections:=", self._name] diff --git a/src/ansys/aedt/core/modeler/cad/object_3d.py b/src/ansys/aedt/core/modeler/cad/object_3d.py index da875b90aa1..4dedb6e44a1 100644 --- a/src/ansys/aedt/core/modeler/cad/object_3d.py +++ b/src/ansys/aedt/core/modeler/cad/object_3d.py @@ -159,7 +159,6 @@ def _bounding_box_sat(self): References ---------- - >>> oEditor.GetModelBoundingBox """ @@ -211,7 +210,6 @@ def bounding_box(self): References ---------- - >>> oEditor.GetModelBoundingBox """ @@ -240,7 +238,6 @@ def bounding_dimension(self): References ---------- - >>> oEditor.GetModelBoundingBox """ oBoundingBox = self.bounding_box @@ -383,7 +380,6 @@ def faces(self): References ---------- - >>> oEditor.GetFaceIDs """ @@ -514,7 +510,6 @@ def top_face_z(self): References ---------- - >>> oEditor.FaceCenter """ @@ -535,7 +530,6 @@ def bottom_face_z(self): References ---------- - >>> oEditor.FaceCenter """ @@ -556,7 +550,6 @@ def top_face_x(self): References ---------- - >>> oEditor.FaceCenter """ @@ -577,7 +570,6 @@ def bottom_face_x(self): References ---------- - >>> oEditor.FaceCenter """ @@ -598,7 +590,6 @@ def top_face_y(self): References ---------- - >>> oEditor.FaceCenter """ @@ -619,7 +610,6 @@ def bottom_face_y(self): References ---------- - >>> oEditor.FaceCenter """ @@ -640,7 +630,6 @@ def top_edge_z(self): References ---------- - >>> oEditor.FaceCenter """ @@ -741,7 +730,6 @@ def edges(self): References ---------- - >>> oEditor.GetEdgeIDsFromObject """ @@ -763,7 +751,6 @@ def vertices(self): References ---------- - >>> oEditor.GetVertexIDsFromObject """ @@ -836,7 +823,6 @@ def group_name(self): References ---------- - >>> oEditor.GetPropertyValue >>> oEditor.ChangeProperty @@ -864,7 +850,6 @@ def group_name(self, name): References ---------- - >>> oEditor.GetPropertyValue >>> oEditor.ChangeProperty @@ -918,7 +903,6 @@ def material_name(self): References ---------- - >>> oEditor.GetPropertyValue >>> oEditor.ChangeProperty @@ -974,7 +958,6 @@ def id(self): References ---------- - >>> oEditor.GetObjectIDByName """ @@ -1039,7 +1022,6 @@ def mass(self): References ---------- - >>> oEditor.GetObjectVolume """ @@ -1067,7 +1049,6 @@ def volume(self): References ---------- - >>> oEditor.GetObjectVolume """ @@ -1088,7 +1069,6 @@ def name(self): References ---------- - >>> oEditor.GetPropertyValue >>> oEditor.ChangeProperty @@ -1116,7 +1096,6 @@ def valid_properties(self): References ---------- - >>> oEditor.GetProperties """ if not self._all_props: @@ -1131,7 +1110,6 @@ def color(self): References ---------- - >>> oEditor.GetPropertyValue >>> oEditor.ChangeProperty @@ -1159,7 +1137,6 @@ def color_string(self): References ---------- - >>> oEditor.GetPropertyValue >>> oEditor.ChangeProperty """ @@ -1203,7 +1180,6 @@ def transparency(self): References ---------- - >>> oEditor.GetPropertyValue >>> oEditor.ChangeProperty @@ -1251,7 +1227,6 @@ def part_coordinate_system(self): References ---------- - >>> oEditor.GetPropertyValue >>> oEditor.ChangeProperty @@ -1281,7 +1256,6 @@ def solve_inside(self): References ---------- - >>> oEditor.GetPropertyValue >>> oEditor.ChangeProperty @@ -1321,7 +1295,6 @@ def display_wireframe(self): References ---------- - >>> oEditor.GetPropertyValue >>> oEditor.ChangeProperty @@ -1355,7 +1328,6 @@ def material_appearance(self): References ---------- - >>> oEditor.GetPropertyValue >>> oEditor.ChangeProperty @@ -1411,7 +1383,6 @@ def model(self): References ---------- - >>> oEditor.GetPropertyValue >>> oEditor.ChangeProperty @@ -1449,7 +1420,6 @@ def unite(self, assignment): References ---------- - >>> oEditor.Unite """ @@ -1475,7 +1445,6 @@ def intersect(self, assignment, keep_originals=False): References ---------- - >>> oEditor.Intersect """ assignment = [self.name] + self._primitives.convert_to_selections(assignment, return_list=True) @@ -1503,7 +1472,6 @@ def split(self, plane, sides="Both"): References ---------- - >>> oEditor.Split """ return self._primitives.split(self.name, plane, sides) @@ -1532,7 +1500,6 @@ def mirror(self, origin, vector, duplicate=False): References ---------- - >>> oEditor.Mirror """ if self._primitives.mirror(self.id, origin=origin, vector=vector, duplicate=duplicate): @@ -1561,7 +1528,6 @@ def rotate(self, axis, angle=90.0, units="deg"): References ---------- - >>> oEditor.Rotate """ if self._primitives.rotate(self.id, axis=axis, angle=angle, units=units): @@ -1614,7 +1580,6 @@ def duplicate_around_axis(self, axis, angle=90, clones=2, create_new_objects=Tru References ---------- - >>> oEditor.DuplicateAroundAxis """ @@ -1643,7 +1608,6 @@ def duplicate_along_line(self, vector, clones=2, attach=False): References ---------- - >>> oEditor.DuplicateAlongLine """ @@ -1671,7 +1635,6 @@ def sweep_along_vector(self, sweep_vector, draft_angle=0, draft_type="Round"): References ---------- - >>> oEditor.SweepAlongVector """ @@ -1705,7 +1668,6 @@ def sweep_along_path( References ---------- - >>> oEditor.SweepAlongPath """ @@ -1734,7 +1696,6 @@ def sweep_around_axis(self, axis, sweep_angle=360, draft_angle=0): References ---------- - >>> oEditor.SweepAroundAxis """ @@ -1761,7 +1722,6 @@ def section(self, plane, create_new=True, section_cross_object=False): References ---------- - >>> oEditor.Section """ @@ -1784,7 +1744,6 @@ def detach_faces(self, faces): References ---------- - >>> oEditor.DetachFaces """ @@ -1801,7 +1760,6 @@ def clone(self): References ---------- - >>> oEditor.Clone """ @@ -1830,7 +1788,6 @@ def subtract(self, tool_list, keep_originals=True): References ---------- - >>> oEditor.Subtract """ @@ -1871,7 +1828,6 @@ def delete(self): References ---------- - >>> oEditor.Delete """ arg = ["NAME:Selections", "Selections:=", self._m_name] @@ -1995,7 +1951,6 @@ def fillet(self, vertices=None, edges=None, radius=0.1, setback=0.0): References ---------- - >>> oEditor.Fillet """ @@ -2054,7 +2009,6 @@ def chamfer(self, vertices=None, edges=None, left_distance=1, right_distance=Non References ---------- - >>> oEditor.Chamfer """ diff --git a/src/ansys/aedt/core/modeler/cad/polylines.py b/src/ansys/aedt/core/modeler/cad/polylines.py index fa04db8a79e..706bd3f4339 100644 --- a/src/ansys/aedt/core/modeler/cad/polylines.py +++ b/src/ansys/aedt/core/modeler/cad/polylines.py @@ -383,7 +383,6 @@ def end_point(self): References ---------- - >>> oEditor.GetVertexIDsFromObject >>> oEditor.GetVertexPosition @@ -391,7 +390,7 @@ def end_point(self): return self.points[-1] def _update_segments_and_points(self): - """Updates the self._segment_types and the self._positions from the history. + """Update the self._segment_types and the self._positions from the history. This internal method is called by properties ``points`` and ``segment_types``. It will be called only once after opening a new project, then the internal @@ -541,7 +540,6 @@ def vertex_positions(self): References ---------- - >>> oEditor.GetVertexIDsFromObject >>> oEditor.GetVertexPosition @@ -769,7 +767,6 @@ def clone(self): References ---------- - >>> oEditor.Copy >>> oEditor.Paste @@ -816,7 +813,6 @@ def remove_point(self, position, tolerance=1e-9): References ---------- - >>> oEditor.DeletePolylinePoint Examples @@ -907,7 +903,6 @@ def remove_segments(self, assignment): References ---------- - >>> oEditor.DeletePolylinePoint Examples @@ -988,7 +983,6 @@ def set_crosssection_properties( References ---------- - >>> oEditor.ChangeProperty Examples @@ -1139,7 +1133,6 @@ def insert_segment(self, points, segment=None): References ---------- - >>> oEditor.InsertPolylineSegment """ diff --git a/src/ansys/aedt/core/modeler/cad/primitives.py b/src/ansys/aedt/core/modeler/cad/primitives.py index fe5662c4834..820eba9b6d0 100644 --- a/src/ansys/aedt/core/modeler/cad/primitives.py +++ b/src/ansys/aedt/core/modeler/cad/primitives.py @@ -22,9 +22,7 @@ # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE # SOFTWARE. -""" -This module contains these Primitives classes: `Polyline` and `Primitives`. -""" +"""This module contains these Primitives classes: `Polyline` and `Primitives`.""" from __future__ import absolute_import # noreorder @@ -684,7 +682,6 @@ def user_defined_component_names(self): References ---------- - >>> oEditor.Get3DComponentDefinitionNames >>> oEditor.Get3DComponentInstanceNames """ @@ -1170,7 +1167,6 @@ def get_objects_by_material(self, material=None): References ---------- - >>> oEditor.GetObjectsByMaterial """ @@ -1378,7 +1374,6 @@ def fit_all(self): References ---------- - >>> oEditor.FitAll Examples @@ -1436,7 +1431,6 @@ def cover_lines(self, assignment): References ---------- - >>> oEditor.CoverLines """ obj_to_cover = self.convert_to_selections(assignment, False) @@ -1549,7 +1543,6 @@ def create_coordinate_system( References ---------- - >>> oEditor.CreateRelativeCS """ if name: @@ -1812,7 +1805,6 @@ def set_working_coordinate_system(self, name): References ---------- - >>> oEditor.SetWCS """ if isinstance(name, BaseCoordinateSystem): @@ -1836,7 +1828,6 @@ def get_working_coordinate_system(self): References ---------- - >>> oEditor.GetActiveCoordinateSystem """ @@ -1941,7 +1932,6 @@ def duplicate_coordinate_system_to_global(self, coordinate_system): References ---------- - >>> oEditor.CreateRelativeCS """ cs_names = [i.name for i in self.coordinate_systems] @@ -2103,7 +2093,6 @@ def set_objects_deformation(self, assignment): References ---------- - >>> oDesign.SetObjectDeformation """ self.logger.info("Enabling deformation feedback") @@ -2139,7 +2128,6 @@ def set_objects_temperature(self, assignment, ambient_temperature=22, create_pro References ---------- - >>> oDesign.SetObjectTemperature """ self.logger.info("Set model temperature and enabling Thermal Feedback") @@ -2300,7 +2288,6 @@ def create_sheet_to_ground(self, assignment, ground_name=None, orientation=0, sh References ---------- - >>> oEditor.CreatePolyline """ if orientation > 2: @@ -2463,7 +2450,6 @@ def get_boundaries_name(self): References ---------- - >>> oModule.GetBoundaries """ if self._app.design_type == "Icepak": @@ -2490,7 +2476,6 @@ def set_object_model_state(self, assignment, model=True): References ---------- - >>> oEditor.ChangeProperty """ selections = self.convert_to_selections(assignment, True) @@ -2521,7 +2506,6 @@ def get_objects_in_group(self, group): References ---------- - >>> oEditor.GetObjectsInGroup """ if not isinstance(group, str): @@ -2548,7 +2532,6 @@ def get_group_bounding_box(self, group): References ---------- - >>> oEditor.GetObjectsInGroup >>> oEditor.GetModelBoundingBox """ @@ -2671,7 +2654,6 @@ def split( References ---------- - >>> oEditor.Split """ if plane is None and not tool or plane and tool: @@ -2819,7 +2801,6 @@ def duplicate_and_mirror( References ---------- - >>> oEditor.DuplicateMirror """ return self.mirror( @@ -2856,7 +2837,6 @@ def mirror(self, assignment, origin, vector, duplicate=False, is_3d_comp=False, References ---------- - >>> oEditor.Mirror >>> oEditor.DuplicateMirror """ @@ -2915,7 +2895,6 @@ def move(self, assignment, vector): References ---------- - >>> oEditor.Move """ Xvec, Yvec, Zvec = self._pos_with_arg(vector) @@ -2968,7 +2947,6 @@ def duplicate_around_axis( References ---------- - >>> oEditor.DuplicateAroundAxis """ selections = self.convert_to_selections(assignment) @@ -3041,7 +3019,6 @@ def duplicate_along_line( References ---------- - >>> oEditor.DuplicateAlongLine """ selections = self.convert_to_selections(assignment) @@ -3082,7 +3059,6 @@ def thicken_sheet(self, assignment, thickness, both_sides=False): References ---------- - >>> oEditor.ThickenSheet """ selections = self.convert_to_selections(assignment) @@ -3120,7 +3096,6 @@ def sweep_along_normal(self, assignment, faces, sweep_value=0.1): References ---------- - >>> oEditor.SweepFacesAlongNormal """ if not isinstance(faces, list): @@ -3177,7 +3152,6 @@ def sweep_along_vector(self, assignment, sweep_vector, draft_angle=0, draft_type References ---------- - >>> oEditor.SweepAlongVector """ selections = self.convert_to_selections(assignment) @@ -3235,7 +3209,6 @@ def sweep_along_path( References ---------- - >>> oEditor.SweepAlongPath """ selections = self.convert_to_selections(assignment) + "," + self.convert_to_selections(sweep_object) @@ -3280,7 +3253,6 @@ def sweep_around_axis(self, assignment, axis, sweep_angle=360, draft_angle=0, nu References ---------- - >>> oEditor.SweepAroundAxis """ selections = self.convert_to_selections(assignment) @@ -3335,7 +3307,6 @@ def section(self, assignment, plane, create_new=True, section_cross_object=False References ---------- - >>> oEditor.Section """ section_plane = GeometryOperators.cs_plane_to_plane_str(plane) @@ -3376,7 +3347,6 @@ def separate_bodies(self, assignment, create_group=False): References ---------- - >>> oEditor.SeparateBody """ try: @@ -3425,7 +3395,6 @@ def rotate(self, assignment, axis, angle=90.0, units="deg"): References ---------- - >>> oEditor.Rotate """ selections = self.convert_to_selections(assignment) @@ -3461,7 +3430,6 @@ def subtract(self, blank_list, tool_list, keep_originals=True, **kwargs): References ---------- - >>> oEditor.Subtract """ if "keepOriginals" in kwargs: @@ -3501,7 +3469,6 @@ def imprint(self, blank_list, tool_list, keep_originals=True): References ---------- - >>> oEditor.Imprint """ szList = self.convert_to_selections(blank_list) @@ -3565,7 +3532,6 @@ def imprint_normal_projection( References ---------- - >>> oEditor.ImprintProjection """ return self._imprint_projection(assignment, keep_originals, True) @@ -3599,7 +3565,6 @@ def imprint_vector_projection( References ---------- - >>> oEditor.ImprintProjection """ return self._imprint_projection(assignment, keep_originals, False, vector_points, distance) @@ -3620,7 +3585,6 @@ def purge_history(self, assignment): References ---------- - >>> oEditor.PurgeHistory """ szList = self.convert_to_selections(assignment) @@ -3643,7 +3607,6 @@ def get_model_bounding_box(self): References ---------- - >>> oEditor.GetModelBoundingBox """ bb = list(self.oeditor.GetModelBoundingBox()) @@ -3670,7 +3633,6 @@ def unite(self, assignment, purge=False, keep_originals=False): References ---------- - >>> oEditor.Unite """ slice = min(100, len(assignment)) @@ -3723,7 +3685,6 @@ def clone(self, assignment): References ---------- - >>> oEditor.Copy >>> oEditor.Paste """ @@ -3747,7 +3708,6 @@ def copy(self, assignment): References ---------- - >>> oEditor.Copy """ # convert to string @@ -3772,7 +3732,6 @@ def paste(self): References ---------- - >>> oEditor.Paste """ self.add_new_objects() @@ -3798,7 +3757,6 @@ def intersect(self, assignment, keep_originals=False, **kwargs): References ---------- - >>> oEditor.Intersect """ if "keeporiginal" in kwargs: @@ -3838,7 +3796,6 @@ def detach_faces(self, assignment, faces): References ---------- - >>> oEditor.DetachFaces """ @@ -3871,7 +3828,6 @@ def connect(self, assignment): References ---------- - >>> oEditor.Connect """ try: @@ -3911,7 +3867,6 @@ def chassis_subtraction(self, chassis_part): References ---------- - >>> oEditor.Subtract """ self.logger.info("Subtract all objects from Chassis object - exclude vacuum objs") @@ -4039,7 +3994,6 @@ def get_matched_object_name(self, search_string): References ---------- - >>> oEditor.GetMatchedObjectName """ return self.oeditor.GetMatchedObjectName(search_string) @@ -4060,7 +4014,6 @@ def clean_objects_name(self, main_part_name): References ---------- - >>> oEditor.RenamePart """ cad_suffix = main_part_name + "_" @@ -4099,7 +4052,6 @@ def create_airbox(self, offset=0, offset_type="Absolute", name="AirBox_Auto"): References ---------- - >>> oEditor.CreateBox """ self.logger.info("Adding Airbox to the Bounding ") @@ -4160,7 +4112,6 @@ def create_air_region(self, x_pos=0, y_pos=0, z_pos=0, x_neg=0, y_neg=0, z_neg=0 References ---------- - >>> oEditor.CreateRegion """ return self.create_region(pad_percent=[x_pos, x_neg, y_pos, y_neg, z_pos, z_neg], is_percentage=is_percentage) @@ -4182,7 +4133,6 @@ def edit_region_dimensions(self, values): References ---------- - >>> oEditor.ChangeProperty """ arg = ["NAME:AllTabs"] @@ -4219,7 +4169,6 @@ def create_face_list(self, assignment, name=None): References ---------- - >>> oEditor.CreateEntityList """ if name: @@ -4259,7 +4208,6 @@ def create_object_list(self, assignment, name=None): References ---------- - >>> oEditor.CreateEntityList """ if name: @@ -4297,7 +4245,6 @@ def generate_object_history(self, assignment): References ---------- - >>> oEditor.GenerateHistory """ assignment = self.convert_to_selections(assignment) @@ -4446,7 +4393,6 @@ def get_entitylist_id(self, name): References ---------- - >>> oEditor.GetEntityListIDByName """ id = self.oeditor.GetEntityListIDByName(name) @@ -4492,7 +4438,6 @@ def explicitly_subtract(self, tool_parts, blank_parts): References ---------- - >>> oEditor.Subtract >>> oEditor.PurgeHistory """ @@ -4584,7 +4529,6 @@ def get_bounding_dimension(self): References ---------- - >>> oEditor.GetModelBoundingBox """ oBoundingBox = list(self.oeditor.GetModelBoundingBox()) @@ -4610,7 +4554,6 @@ def get_object_name_from_edge_id(self, assignment): References ---------- - >>> oEditor.GetEdgeIDsFromObject """ for object in self.solid_names + self.sheet_names + self.line_names: @@ -4633,7 +4576,6 @@ def get_solving_volume(self): References ---------- - >>> oEditor.GetModelBoundingBox """ bound = self.get_model_bounding_box() @@ -4682,7 +4624,6 @@ def get_vertices_of_line(self, assignment): References ---------- - >>> oEditor.GetVertexIDsFromObject """ position_list = [] @@ -4748,7 +4689,6 @@ def export_3d_model( References ---------- - >>> oEditor.Export """ @@ -4871,7 +4811,6 @@ def import_3d_cad( References ---------- - >>> oEditor.Import """ if str(healing) in ["0", "1"]: @@ -4924,7 +4863,6 @@ def import_spaceclaim_document(self, input_file): # pragma: no cover References ---------- - >>> oEditor.CreateUserDefinedModel """ env_var = os.environ @@ -5145,7 +5083,6 @@ def import_discovery_model(self, input_file): References ---------- - >>> oEditor.CreateUserDefinedModel """ if is_linux: # pragma: no cover @@ -5258,7 +5195,6 @@ def break_spaceclaim_connection(self): # TODO: Need to change this name. Don't References ---------- - >>> oEditor.BreakUDMConnection """ args = ["NAME:Selections", "Selections:=", "SpaceClaim1"] @@ -5282,7 +5218,6 @@ def load_scdm_in_hfss(self, input_file): References ---------- - >>> oEditor.CreateUserDefinedModel >>> oEditor.BreakUDMConnection """ @@ -5307,7 +5242,6 @@ def get_faces_from_materials(self, filter_materials): References ---------- - >>> oEditor.GetObjectsByMaterial >>> oEditor.GetFaceIDs """ @@ -5349,7 +5283,6 @@ def scale(self, assignment, x=2.0, y=2.0, z=2.0): References ---------- - >>> oEditor.Scale """ selections = self.convert_to_selections(assignment, True) @@ -5374,7 +5307,6 @@ def select_allfaces_fromobjects(self, assignment): References ---------- - >>> oEditor.GetFaceIDs """ self.logger.info("Selecting outer faces.") @@ -5399,7 +5331,6 @@ def setunassigned_mats(self): References ---------- - >>> oEditor.SetPropertyValue """ oObjects = list(self.oeditor.GetObjectsInGroup("Solids")) @@ -5436,7 +5367,6 @@ def automatic_thicken_sheets(self, assignment, value, extrude_internally=True, i References ---------- - >>> oEditor.ThickenSheet """ aedt_bounding_box = self.get_model_bounding_box() @@ -5535,7 +5465,6 @@ def move_face(self, assignment, offset=1.0): References ---------- - >>> oEditor.MoveFaces """ @@ -5596,7 +5525,6 @@ def move_edge(self, assignment, offset=1.0): References ---------- - >>> oEditor.MoveEdges """ @@ -5664,7 +5592,6 @@ def create_group(self, objects=None, components=None, groups=None, group_name=No References ---------- - >>> oEditor.CreateGroup """ if components is None and groups is None and objects is None: @@ -5728,7 +5655,6 @@ def ungroup(self, groups): References ---------- - >>> oEditor.Ungroup """ group_list = self.convert_to_selections(groups, return_list=True) @@ -5747,7 +5673,6 @@ def flatten_assembly(self): References ---------- - >>> oEditor.FlattenGroup """ self.oeditor.FlattenGroup(["Groups:=", ["Model"]]) @@ -6141,7 +6066,6 @@ def create_point(self, position, name=None, color="(143 175 143)"): References ---------- - >>> oEditor.CreateBox Examples @@ -6213,7 +6137,6 @@ def create_plane( References ---------- - >>> oEditor.CreateBox Examples @@ -6504,7 +6427,6 @@ def create_subregion(self, padding_values, padding_types, assignment, name=None) References ---------- - >>> oEditor.CreateRegion """ if name is None: @@ -6531,7 +6453,6 @@ def reassign_subregion(self, region, parts): References ---------- - >>> oEditor.CreateRegion """ is_percentage = region.padding_types in ["Percentage Offset", "Transverse Percentage Offset"] @@ -6653,7 +6574,6 @@ def create_region(self, pad_value=300, pad_type="Percentage Offset", name="Regio References ---------- - >>> oEditor.CreateRegion """ # backward compatibility @@ -6694,7 +6614,6 @@ def create_object_from_edge(self, assignment, non_model=False): References ---------- - >>> oEditor.CreateObjectFromFaces """ edge_ids = self.convert_to_selections(assignment, True) @@ -6744,7 +6663,6 @@ def create_object_from_face(self, assignment, non_model=False): References ---------- - >>> oEditor.CreateObjectFromFaces """ face_ids = self.convert_to_selections(assignment, True) @@ -6910,7 +6828,6 @@ def create_polyline( References ---------- - >>> oEditor.CreatePolyline Examples @@ -7115,7 +7032,6 @@ def create_udp(self, dll, parameters, library="syslib", name=None): References ---------- - >>> oEditor.CreateUserDefinedPart Examples @@ -7173,7 +7089,6 @@ def update_udp(self, assignment, operation, parameters): References ---------- - >>> oEditor.CreateUserDefinedPart Examples @@ -7222,7 +7137,6 @@ def delete(self, assignment=None): References ---------- - >>> oEditor.Delete """ @@ -7279,7 +7193,6 @@ def delete_objects_containing(self, contained_string, case_sensitive=True): References ---------- - >>> oEditor.Delete """ @@ -7636,7 +7549,6 @@ def get_object_faces(self, assignment): References ---------- - >>> oEditor.GetFaceIDs """ @@ -7667,7 +7579,6 @@ def get_object_edges(self, assignment): References ---------- - >>> oEditor.GetEdgeIDsFromObject """ @@ -7697,7 +7608,6 @@ def get_face_edges(self, assignment): References ---------- - >>> oEditor.GetEdgeIDsFromFace """ @@ -7721,7 +7631,6 @@ def get_object_vertices(self, assignment): References ---------- - >>> oEditor.GetVertexIDsFromObject """ @@ -7753,7 +7662,6 @@ def get_face_vertices(self, assignment): References ---------- - >>> oEditor.GetVertexIDsFromFace """ @@ -7806,7 +7714,6 @@ def get_edge_vertices(self, assignment): References ---------- - >>> oEditor.GetVertexIDsFromEdge """ @@ -7834,7 +7741,6 @@ def get_vertex_position(self, assignment): References ---------- - >>> oEditor.GetVertexPosition """ @@ -7862,7 +7768,6 @@ def get_face_area(self, assignment): References ---------- - >>> oEditor.GetFaceArea """ @@ -7887,7 +7792,6 @@ def get_face_center(self, assignment): References ---------- - >>> oEditor.GetFaceCenter """ @@ -7989,7 +7893,6 @@ def get_bodynames_from_position(self, position, units=None, include_non_model=Tr References ---------- - >>> oEditor.GetBodyNamesByPosition """ @@ -8066,7 +7969,6 @@ def get_edgeids_from_vertexid(self, vertex, assignment): References ---------- - >>> oEditor.GetEdgeIDsFromObject >>> oEditor.GetVertexIDsFromEdge @@ -8102,7 +8004,6 @@ def get_faceid_from_position(self, position, assignment=None, units=None): References ---------- - >>> oEditor.GetFaceByPosition """ @@ -9003,12 +8904,10 @@ def convert_segments_to_line(self, assignment): References ---------- - >>> oEditor.ChangeProperty Examples -------- - >>> from ansys.aedt.core import Hfss >>> aedtapp = Hfss() >>> edge_object = aedtapp.modeler.create_object_from_edge("my_edge") diff --git a/src/ansys/aedt/core/modeler/cad/primitives_2d.py b/src/ansys/aedt/core/modeler/cad/primitives_2d.py index c07ac588d00..004de148811 100644 --- a/src/ansys/aedt/core/modeler/cad/primitives_2d.py +++ b/src/ansys/aedt/core/modeler/cad/primitives_2d.py @@ -90,7 +90,6 @@ def create_circle( References ---------- - >>> oEditor.CreateCircle Examples @@ -168,7 +167,6 @@ def create_ellipse( References ---------- - >>> oEditor.CreateEllipse Examples @@ -221,7 +219,6 @@ def create_rectangle(self, origin, sizes, is_covered=True, name=None, material=N References ---------- - >>> oEditor.CreateRectangle Examples @@ -284,7 +281,6 @@ def create_regular_polygon( References ---------- - >>> oEditor.CreateRegularPolygon Examples @@ -346,7 +342,6 @@ def create_region(self, pad_value=300, pad_type="Percentage Offset", name="Regio References ---------- - >>> oEditor.CreateRegion """ # backward compatibility diff --git a/src/ansys/aedt/core/modeler/cad/primitives_3d.py b/src/ansys/aedt/core/modeler/cad/primitives_3d.py index abc835c3b98..87271bf616d 100644 --- a/src/ansys/aedt/core/modeler/cad/primitives_3d.py +++ b/src/ansys/aedt/core/modeler/cad/primitives_3d.py @@ -132,7 +132,6 @@ def create_box(self, origin, sizes, name=None, material=None, **kwargs): References ---------- - >>> oEditor.CreateBox Examples @@ -205,7 +204,6 @@ def create_cylinder(self, orientation, origin, radius, height, num_sides=0, name References ---------- - >>> oEditor.CreateCylinder Examples @@ -290,7 +288,6 @@ def create_polyhedron(self, orientation=None, center=(0.0, 0.0, 0.0), origin=(0. References ---------- - >>> oEditor.CreateRegularPolyhedron Examples @@ -371,7 +368,6 @@ def create_cone(self, orientation, origin, bottom_radius, top_radius, height, na References ---------- - >>> oEditor.CreateCone Examples @@ -452,7 +448,6 @@ def create_sphere(self, origin, radius, name=None, material=None, **kwargs): References ---------- - >>> oEditor.CreateSphere Examples @@ -523,7 +518,6 @@ def create_torus(self, origin, major_radius, minor_radius, axis=None, name=None, References ---------- - >>> oEditor.CreateTorus Examples @@ -629,7 +623,6 @@ def create_bondwire(self, start, end, h1=0.2, h2=0, alpha=80, beta=5, bond_type= References ---------- - >>> oEditor.CreateBondwire Examples @@ -749,7 +742,6 @@ def create_rectangle(self, orientation, origin, sizes, name=None, material=None, References ---------- - >>> oEditor.CreateRectangle """ if len(sizes) != 2: @@ -809,7 +801,6 @@ def create_circle(self, orientation, origin, radius, num_sides=0, is_covered=Tru References ---------- - >>> oEditor.CreateCircle Examples @@ -902,7 +893,6 @@ def create_ellipse( References ---------- - >>> oEditor.CreateEllipse Examples @@ -1009,7 +999,6 @@ def create_equationbased_curve(self, x_t=0, y_t=0, z_t=0, t_start=0, t_end=1, nu References ---------- - >>> oEditor.CreateEquationCurve Examples @@ -1111,7 +1100,6 @@ def create_equationbased_surface(self, x_uv=0, y_uv=0, z_uv=0, u_start=0, u_end= References ---------- - >>> oEditor.CreateEquationSurface Examples @@ -1196,7 +1184,6 @@ def create_helix(self, assignment, origin, x_start_dir, y_start_dir, z_start_dir References ---------- - >>> oEditor.CreateHelix Examples @@ -1285,7 +1272,6 @@ def create_udm( References ---------- - >>> oEditor.CreateUserDefinedModel """ @@ -1586,7 +1572,6 @@ def insert_3d_component( References ---------- - >>> oEditor.Insert3DComponent """ if password is None: @@ -1789,7 +1774,6 @@ def insert_layout_component( References ---------- - >>> oEditor.InsertNativeComponent Examples @@ -2040,7 +2024,6 @@ def get_3d_component_object_list(self, name): References ---------- - >>> oeditor.GetChildObject """ if self._app._is_object_oriented_enabled(): @@ -2161,7 +2144,6 @@ def add_person( References ---------- - >>> oEditor.Insert3DComponent """ self._initialize_multipart() @@ -2250,7 +2232,6 @@ def add_vehicle( References ---------- - >>> oEditor.Insert3DComponent """ self._initialize_multipart() @@ -2353,7 +2334,6 @@ def add_bird( References ---------- - >>> oEditor.Insert3DComponent Examples @@ -2434,7 +2414,6 @@ def add_environment( References ---------- - >>> oEditor.Insert3DComponent """ diff --git a/src/ansys/aedt/core/modeler/circuits/object_3d_circuit.py b/src/ansys/aedt/core/modeler/circuits/object_3d_circuit.py index 1551d66403c..6c67f490567 100644 --- a/src/ansys/aedt/core/modeler/circuits/object_3d_circuit.py +++ b/src/ansys/aedt/core/modeler/circuits/object_3d_circuit.py @@ -57,7 +57,6 @@ def location(self): References ---------- - >>> oPadstackManager.GetComponentPinLocation """ if "Port" in self._circuit_comp.composed_name: @@ -188,7 +187,6 @@ def connect_to_component( References ---------- - >>> oPadstackManager.CreatePagePort """ tol = 1e-8 @@ -522,7 +520,6 @@ def parameters(self): References ---------- - >>> oEditor.GetProperties >>> oEditor.GetPropertyValue """ @@ -558,7 +555,6 @@ def component_info(self): References ---------- - >>> oEditor.GetProperties >>> oEditor.GetPropertyValue """ @@ -637,7 +633,6 @@ def location(self): References ---------- - >>> oEditor.GetPropertyValue >>> oEditor.ChangeProperty """ @@ -678,7 +673,6 @@ def angle(self): References ---------- - >>> oEditor.GetPropertyValue >>> oEditor.ChangeProperty """ @@ -734,7 +728,6 @@ def mirror(self): References ---------- - >>> oEditor.GetPropertyValue >>> oEditor.ChangeProperty """ @@ -780,7 +773,6 @@ def set_use_symbol_color(self, color=None): References ---------- - >>> oEditor.ChangeProperty """ if not color: @@ -809,7 +801,6 @@ def set_color(self, red=255, green=128, blue=0): References ---------- - >>> oEditor.ChangeProperty """ vMaterial = ["NAME:Component Color", "R:=", red, "G:=", green, "B:=", blue] @@ -834,7 +825,6 @@ def set_property(self, name, value): References ---------- - >>> oEditor.ChangeProperty """ if isinstance(name, list): @@ -894,7 +884,6 @@ def change_property(self, property_name, names=None): References ---------- - >>> oEditor.GetPropertyValue >>> oEditor.ChangeProperty """ @@ -931,7 +920,6 @@ def enforce_touchstone_model_passive(self): References ---------- - >>> oModelManager.EditWithComps """ props = self.model_data.props diff --git a/src/ansys/aedt/core/modeler/circuits/primitives_circuit.py b/src/ansys/aedt/core/modeler/circuits/primitives_circuit.py index 6f7567451dd..b5f32fc57d3 100644 --- a/src/ansys/aedt/core/modeler/circuits/primitives_circuit.py +++ b/src/ansys/aedt/core/modeler/circuits/primitives_circuit.py @@ -45,7 +45,6 @@ class CircuitComponents(object): Examples -------- - >>> from ansys.aedt.core import Circuit >>> aedtapp = Circuit() >>> prim = aedtapp.modeler.schematic @@ -136,7 +135,6 @@ def o_definition_manager(self): References ---------- - >>> oDefinitionManager = oProject.GetDefinitionManager() """ return self._app.oproject.GetDefinitionManager() @@ -284,7 +282,6 @@ def add_pin_iports(self, name, id_num): References ---------- - >>> oeditor.AddPinIPorts """ comp_id = "CompInst@" + name + ";" + str(id_num) + ";395" @@ -313,7 +310,6 @@ def create_interface_port(self, name, location=None, angle=0): References ---------- - >>> oEditor.CreateIPort """ if location is None: @@ -358,7 +354,6 @@ def create_page_port(self, name, location=None, angle=0): References ---------- - >>> oEditor.CreatePagePort """ location = [] if location is None else location @@ -432,7 +427,6 @@ def create_model_from_touchstone(self, input_file, model_name=None, show_bitmap= References ---------- - >>> oModelManager.Add >>> oComponentManager.Add """ @@ -725,7 +719,6 @@ def create_touchstone_component( References ---------- - >>> oModelManager.Add >>> oComponentManager.Add >>> oEditor.CreateComponent @@ -791,7 +784,6 @@ def create_component( References ---------- - >>> oEditor.CreateComponent Examples @@ -840,7 +832,6 @@ def disable_data_netlist(self, assignment): References ---------- - >>> oComponentManager.GetData >>> oComponentManager.Edit """ @@ -877,7 +868,6 @@ def enable_global_netlist(self, assignment, global_netlist_list=None): References ---------- - >>> oComponentManager.GetData >>> oComponentManager.Edit """ @@ -918,7 +908,6 @@ def create_symbol(self, name, pins): References ---------- - >>> oSymbolManager.Add """ numpins = len(pins) @@ -998,7 +987,6 @@ def enable_use_instance_name(self, component_library="", component_name="RES_"): References ---------- - >>> oComponentManager.GetData >>> oComponentManager.Edit """ @@ -1033,7 +1021,6 @@ def refresh_all_ids(self): References ---------- - >>> oEditor.GetAllElements() """ obj = self.oeditor.GetAllElements() @@ -1124,7 +1111,6 @@ def get_pins(self, assignment): References ---------- - >>> oEditor.GetComponentPins """ if isinstance(assignment, CircuitComponent): @@ -1155,7 +1141,6 @@ def get_pin_location(self, assignment, pin): References ---------- - >>> oEditor.GetComponentPinLocation """ @@ -1233,7 +1218,6 @@ def create_wire(self, points, name=""): References ---------- - >>> oEditor.CreateWire """ points = [str(tuple(self._convert_point_to_meter(i))) for i in points] @@ -1296,7 +1280,6 @@ def place(self, assignment, location=None, angle=0, use_instance_id_netlist=Fals References ---------- - >>> oEditor.CreateComponent """ if location is None: diff --git a/src/ansys/aedt/core/modeler/circuits/primitives_emit.py b/src/ansys/aedt/core/modeler/circuits/primitives_emit.py index ad762bf0bd1..3f3aef61c98 100644 --- a/src/ansys/aedt/core/modeler/circuits/primitives_emit.py +++ b/src/ansys/aedt/core/modeler/circuits/primitives_emit.py @@ -71,7 +71,6 @@ def o_definition_manager(self): References ---------- - >>> oDefinitionManager = oProject.GetDefinitionManager() """ return self._parent._oproject.GetDefinitionManager() @@ -82,7 +81,6 @@ def o_symbol_manager(self): References ---------- - >>> oSymbolManager = oDefinitionManager.GetManager("Symbol") """ return self._parent.o_symbol_manager @@ -93,7 +91,6 @@ def o_component_manager(self): References ---------- - >>> oComponentManager = oDefinitionManager.GetManager("Component") """ return self._parent.o_component_manager @@ -158,7 +155,6 @@ def create_component(self, component_type, name=None, library=None): References ---------- - >>> oEditor.CreateComponent """ # Pass an empty string to allow name to be automatically assigned. @@ -202,7 +198,6 @@ def create_radio_antenna(self, radio_type, radio_name=None, antenna_name=None, l References ---------- - >>> oEditor.CreateComponent """ # Pass an empty string to allow name to be automatically assigned. @@ -423,7 +418,6 @@ def port_connection(self, port_name): References ---------- - >>> oEditor.GetWireAtPort >>> oEditor.GetWireConnections """ @@ -448,7 +442,6 @@ def update_property_tree(self): References ---------- - >>> oDesign.GetComponentNodeNames """ node_names = sorted(self.odesign.GetComponentNodeNames(self.name)) @@ -483,7 +476,6 @@ def get_node_properties(self, node=None): References ---------- - >>> oDesign.GetComponentNodeNames >>> oDesign.GetComponentNodeProperties """ @@ -968,7 +960,7 @@ def has_rx_channels(self): return len(nodes) > 0 def get_connected_antennas(self): - """Returns a list of antennas connected to this radio instance. + """Return a list of antennas connected to this radio instance. Parameters ---------- @@ -1153,7 +1145,7 @@ def set_channel_sampling(self, sampling_type="Uniform", percentage=None, max_cha @pyaedt_function_handler() def _set_prop_value(self, props=None): - """Sets the property values for this node. + """Set the property values for this node. Parameters ---------- @@ -1183,7 +1175,7 @@ def _set_prop_value(self, props=None): @enabled.setter def enabled(self, value): - """Sets the node enabled or disabled. + """Set the node enabled or disabled. Parameters ---------- diff --git a/src/ansys/aedt/core/modeler/circuits/primitives_maxwell_circuit.py b/src/ansys/aedt/core/modeler/circuits/primitives_maxwell_circuit.py index e83ee107cfe..d5a815724bf 100644 --- a/src/ansys/aedt/core/modeler/circuits/primitives_maxwell_circuit.py +++ b/src/ansys/aedt/core/modeler/circuits/primitives_maxwell_circuit.py @@ -103,7 +103,6 @@ def create_resistor(self, name=None, value=50, location=None, angle=0, use_insta References ---------- - >>> oEditor.CreateComponent """ if location == None: @@ -146,7 +145,6 @@ def create_inductor(self, name=None, value=50, location=None, angle=0, use_insta References ---------- - >>> oEditor.CreateComponent """ if location == None: @@ -189,7 +187,6 @@ def create_capacitor(self, name=None, value=50, location=None, angle=0, use_inst References ---------- - >>> oEditor.CreateComponent """ if location is None: @@ -229,7 +226,6 @@ def create_diode(self, name=None, location=None, angle=0, use_instance_id_netlis References ---------- - >>> oEditor.CreateComponent """ if location is None: @@ -269,7 +265,6 @@ def create_winding(self, name=None, location=None, angle=0, use_instance_id_netl References ---------- - >>> oEditor.CreateComponent """ if location is None: diff --git a/src/ansys/aedt/core/modeler/circuits/primitives_nexxim.py b/src/ansys/aedt/core/modeler/circuits/primitives_nexxim.py index 050299f9ab6..e5afd8a57d0 100644 --- a/src/ansys/aedt/core/modeler/circuits/primitives_nexxim.py +++ b/src/ansys/aedt/core/modeler/circuits/primitives_nexxim.py @@ -375,7 +375,6 @@ def add_subcircuit_3dlayout(self, name): References ---------- - >>> oProject.CopyDesign >>> oEditor.PasteDesign """ @@ -412,7 +411,6 @@ def create_field_model(self, design_name, solution_name, pin_names, model_type=" References ---------- - >>> oModelManager.Add >>> oComponentManager.Add """ @@ -667,7 +665,6 @@ def create_resistor(self, name=None, value=50, location=None, angle=0, use_insta References ---------- - >>> oEditor.CreateComponent """ if location is None: @@ -704,7 +701,6 @@ def create_inductor(self, name=None, value=50, location=None, angle=0, use_insta References ---------- - >>> oEditor.CreateComponent """ if location is None: @@ -747,7 +743,6 @@ def create_capacitor(self, name=None, value=50, location=None, angle=0, use_inst References ---------- - >>> oEditor.CreateComponent """ if location == None: @@ -790,7 +785,6 @@ def create_voltage_dc(self, name=None, value=1, location=None, angle=0, use_inst References ---------- - >>> oEditor.CreateComponent """ if location == None: @@ -939,7 +933,6 @@ def create_current_pulse(self, name=None, value_lists=None, location=None, angle References ---------- - >>> oEditor.CreateComponent """ if value_lists is None: @@ -997,7 +990,6 @@ def create_voltage_pulse(self, name=None, value_lists=None, location=None, angle References ---------- - >>> oEditor.CreateComponent """ if value_lists is None: @@ -1110,7 +1102,6 @@ def create_current_dc(self, name=None, value=1, location=None, angle=0, use_inst References ---------- - >>> oEditor.CreateComponent """ if location is None: @@ -1157,7 +1148,6 @@ def create_coupling_inductors( References ---------- - >>> oEditor.CreateComponent """ if location == None: @@ -1202,7 +1192,6 @@ def create_diode(self, name=None, model_name="required", location=None, angle=0, References ---------- - >>> oEditor.CreateComponent """ if location is None: @@ -1244,7 +1233,6 @@ def create_npn(self, name=None, value=None, location=None, angle=0, use_instance References ---------- - >>> oEditor.CreateComponent """ if location is None: @@ -1286,7 +1274,6 @@ def create_pnp(self, name=None, value=50, location=None, angle=0, use_instance_i References ---------- - >>> oEditor.CreateComponent """ if location is None: @@ -1348,7 +1335,6 @@ def create_new_component_from_symbol( References ---------- - >>> oModelManager.Add >>> oComponentManager.Add """ @@ -1572,7 +1558,6 @@ def add_subcircuit_dynamic_link( References ---------- - >>> oModelManager.Add >>> oComponentManager.Add >>> oDesign.AddCompInstance @@ -1658,7 +1643,6 @@ def _add_subcircuit_link( References ---------- - >>> oModelManager.Add >>> oComponentManager.Add >>> oDesign.AddCompInstance @@ -1926,7 +1910,6 @@ def set_sim_option_on_hfss_subcircuit(self, component, option="simulate"): References ---------- - >>> oProject.ChangeProperty """ if option == "simulate": @@ -1956,7 +1939,6 @@ def set_sim_solution_on_hfss_subcircuit(self, component, solution_name="Setup1 : References ---------- - >>> oProject.ChangeProperty """ arg = ["NAME:Solution", "Value:=", solution_name] @@ -2002,7 +1984,6 @@ def refresh_dynamic_link(self, name): References ---------- - >>> oComponentManager.UpdateDynamicLink """ if "@" in name: diff --git a/src/ansys/aedt/core/modeler/circuits/primitives_twin_builder.py b/src/ansys/aedt/core/modeler/circuits/primitives_twin_builder.py index ffbc8b088a2..3e323a757aa 100644 --- a/src/ansys/aedt/core/modeler/circuits/primitives_twin_builder.py +++ b/src/ansys/aedt/core/modeler/circuits/primitives_twin_builder.py @@ -132,7 +132,6 @@ def create_resistor(self, name=None, value=50, location=None, angle=0, use_insta References ---------- - >>> oEditor.CreateComponent """ if location == None: @@ -175,7 +174,6 @@ def create_inductor(self, name=None, value=50, location=None, angle=0, use_insta References ---------- - >>> oEditor.CreateComponent """ if location == None: @@ -217,7 +215,6 @@ def create_capacitor(self, name=None, value=50, location=None, angle=0, use_inst References ---------- - >>> oEditor.CreateComponent """ if location == None: @@ -266,7 +263,6 @@ def create_voltage_source( References ---------- - >>> oEditor.CreateComponent """ if location == None: @@ -315,7 +311,6 @@ def create_diode(self, name=None, location=None, angle=0, use_instance_id_netlis References ---------- - >>> oEditor.CreateComponent """ if location == None: @@ -353,7 +348,6 @@ def create_npn(self, name=None, location=None, angle=0, use_instance_id_netlist= References ---------- - >>> oEditor.CreateComponent """ if location == None: @@ -391,7 +385,6 @@ def create_pnp(self, name=None, location=None, angle=0, use_instance_id_netlist= References ---------- - >>> oEditor.CreateComponent """ if location == None: @@ -455,7 +448,6 @@ def create_periodic_waveform_source( References ---------- - >>> oEditor.CreateComponent """ if location == None: diff --git a/src/ansys/aedt/core/modeler/modeler_2d.py b/src/ansys/aedt/core/modeler/modeler_2d.py index 8218ab1fd65..9476d7a78b9 100644 --- a/src/ansys/aedt/core/modeler/modeler_2d.py +++ b/src/ansys/aedt/core/modeler/modeler_2d.py @@ -49,7 +49,6 @@ def oeditor(self): References ---------- - >>> oEditor = oDesign.SetActiveEditor("Machine")""" return self._app.oeditor diff --git a/src/ansys/aedt/core/modeler/modeler_3d.py b/src/ansys/aedt/core/modeler/modeler_3d.py index 2c60c11c2a7..907d396a32c 100644 --- a/src/ansys/aedt/core/modeler/modeler_3d.py +++ b/src/ansys/aedt/core/modeler/modeler_3d.py @@ -467,7 +467,6 @@ def replace_3dcomponent( References ---------- - >>> oEditor.ReplaceWith3DComponent """ if not variables_to_include: @@ -651,7 +650,6 @@ def create_coaxial( References ---------- - >>> oEditor.CreateCylinder >>> oEditor.AssignMaterial @@ -732,7 +730,6 @@ def create_waveguide( References ---------- - >>> oEditor.CreateBox >>> oEditor.AssignMaterial @@ -903,7 +900,6 @@ def create_conical_rings( References ---------- - >>> oEditor.CreatePolyline >>> oEditor.SweepAroundAxis >>> oEditor.ThickenSheet diff --git a/src/ansys/aedt/core/modeler/modeler_pcb.py b/src/ansys/aedt/core/modeler/modeler_pcb.py index 1eb485a22b9..c133eab086e 100644 --- a/src/ansys/aedt/core/modeler/modeler_pcb.py +++ b/src/ansys/aedt/core/modeler/modeler_pcb.py @@ -92,7 +92,6 @@ def oeditor(self): References ---------- - >>> oEditor = oDesign.SetActiveEditor("Layout")""" return self._app.oeditor @@ -153,7 +152,6 @@ def fit_all(self): References ---------- - >>> oEditor.ZoomToFit() """ try: @@ -168,7 +166,6 @@ def model_units(self): References ---------- - >>> oEditor.GetActiveUnits >>> oEditor.SetActiveUnits """ @@ -211,7 +208,6 @@ def obounding_box(self, assignment): References ---------- - >>> oEditor.GetBBox """ bb = self.oeditor.GetBBox(assignment) @@ -273,7 +269,6 @@ def change_property(self, assignment, name, value, aedt_tab="BaseElementTab"): References ---------- - >>> oEditor.ChangeProperty """ if isinstance(value, list) and len(value) == 3: @@ -394,7 +389,6 @@ def change_clip_plane_position(self, name, location): References ---------- - >>> oEditor.ChangeProperty """ return self.change_property(name, "Location", location) @@ -418,7 +412,6 @@ def colinear_heal(self, assignment, tolerance=0.1): References ---------- - >>> oEditor.Heal @@ -473,7 +466,6 @@ def expand(self, assignment, size=1, expand_type="ROUND", replace_original=False References ---------- - >>> oEditor.Expand @@ -528,7 +520,6 @@ def import_cadence_brd(self, input_file, output_dir=None, name=None): References ---------- - >>> oImportExport.ImportExtracta """ if not output_dir: @@ -582,7 +573,6 @@ def import_ipc2581(self, input_file, output_dir=None, name=None): References ---------- - >>> oImportExport.ImportIPC """ if not output_dir: @@ -615,7 +605,6 @@ def subtract(self, blank, tool): References ---------- - >>> oEditor.Subtract """ blank = self.convert_to_selections(blank) @@ -681,7 +670,6 @@ def unite(self, assignment): References ---------- - >>> oEditor.Unite """ @@ -714,7 +702,6 @@ def intersect(self, assignment): References ---------- - >>> oEditor.Intersect """ vArg1 = ["NAME:primitives"] @@ -750,7 +737,6 @@ def duplicate(self, assignment, count, vector): References ---------- - >>> oEditor.Duplicate """ assignment = self.convert_to_selections(assignment, True) @@ -777,7 +763,6 @@ def duplicate_across_layers(self, assignment, layers): References ---------- - >>> oEditor.DuplicateAcrossLyrs """ assignment = self.convert_to_selections(assignment, True) @@ -820,7 +805,6 @@ def set_temperature_dependence( References ---------- - >>> oDesign.SetTemperatureSettings """ self.logger.info("Set the temperature dependence for the design.") diff --git a/src/ansys/aedt/core/modeler/pcb/object_3d_layout.py b/src/ansys/aedt/core/modeler/pcb/object_3d_layout.py index ae12f30856f..2c486165bff 100644 --- a/src/ansys/aedt/core/modeler/pcb/object_3d_layout.py +++ b/src/ansys/aedt/core/modeler/pcb/object_3d_layout.py @@ -84,7 +84,6 @@ def change_property(self, value, names=None): References ---------- - >>> oEditor.ChangeProperty """ vChangedProps = ["NAME:ChangedProps", value] @@ -118,7 +117,6 @@ def set_property_value(self, name, value): References ---------- - >>> oEditor.ChangeProperty """ if "Pt" in name: @@ -139,7 +137,6 @@ def angle(self): References ---------- - >>> oEditor.GetPropertyValue """ if self.prim_type in ["component", "pin", "via"]: @@ -196,7 +193,6 @@ def net_name(self): References ---------- - >>> oEditor.GetPropertyValue """ if self.prim_type not in ["component"]: @@ -219,7 +215,6 @@ def placement_layer(self): References ---------- - >>> oEditor.GetPropertyValue """ if self.prim_type not in ["pin", "via"]: @@ -400,7 +395,6 @@ def lock_position(self): References ---------- - >>> oEditor.ChangeProperty """ return ( @@ -513,7 +507,6 @@ def part(self): References ---------- - >>> oEditor.GetPropertyValue """ return self._oeditor.GetPropertyValue("BaseElementTab", self.name, "Part") @@ -529,7 +522,6 @@ def part_type(self): References ---------- - >>> oEditor.GetPropertyValue """ return self._oeditor.GetPropertyValue("BaseElementTab", self.name, "Part Type") @@ -1007,7 +999,6 @@ def start_layer(self): References ---------- - >>> oEditor.GetPropertyValue """ return self._oeditor.GetPropertyValue("BaseElementTab", self.name, "Start Layer") @@ -1023,7 +1014,6 @@ def stop_layer(self): References ---------- - >>> oEditor.GetPropertyValue """ return self._oeditor.GetPropertyValue("BaseElementTab", self.name, "Stop Layer") @@ -1039,7 +1029,6 @@ def holediam(self): References ---------- - >>> oEditor.GetPropertyValue """ return self._oeditor.GetPropertyValue("BaseElementTab", self.name, "HoleDiameter") @@ -1064,7 +1053,6 @@ def obounding_box(self): References ---------- - >>> oEditor.GetBBox """ return self._primitives.obounding_box(self.name) @@ -1241,7 +1229,6 @@ def get_property_value(self, name): References ---------- - >>> oEditor.GetPropertyValue """ return self._oeditor.GetPropertyValue("BaseElementTab", self.name, name) @@ -1261,7 +1248,6 @@ def negative(self): References ---------- - >>> oEditor.ChangeProperty """ if self.is_void: @@ -1287,7 +1273,6 @@ def net_name(self): References ---------- - >>> oEditor.GetPropertyValue """ if self.is_void: @@ -1353,7 +1338,6 @@ def center(self): References ---------- - >>> oEditor.GetPropertyValue """ cent = self._oeditor.GetPropertyValue("BaseElementTab", self.name, "Center") @@ -1376,7 +1360,6 @@ def radius(self): References ---------- - >>> oEditor.GetPropertyValue """ return self._oeditor.GetPropertyValue("BaseElementTab", self.name, "Radius") @@ -1404,7 +1387,6 @@ def corner_radius(self): References ---------- - >>> oEditor.GetPropertyValue """ return self._oeditor.GetPropertyValue("BaseElementTab", self.name, "CornerRadius") @@ -1425,7 +1407,6 @@ def two_point_description(self): References ---------- - >>> oEditor.GetPropertyValue """ return ( @@ -1450,7 +1431,6 @@ def center(self): References ---------- - >>> oEditor.GetPropertyValue """ if not self.two_point_description: @@ -1475,7 +1455,6 @@ def width(self): References ---------- - >>> oEditor.GetPropertyValue """ if not self.two_point_description: @@ -1498,7 +1477,6 @@ def height(self): References ---------- - >>> oEditor.GetPropertyValue """ if not self.two_point_description: @@ -1521,7 +1499,6 @@ def point_a(self): References ---------- - >>> oEditor.GetPropertyValue """ if self.two_point_description: @@ -1546,7 +1523,6 @@ def point_b(self): References ---------- - >>> oEditor.GetPropertyValue """ if self.two_point_description: @@ -1580,7 +1556,6 @@ def bend_type(self): References ---------- - >>> oEditor.GetPropertyValue """ return self._oeditor.GetPropertyValue("BaseElementTab", self.name, "BendType") @@ -1601,7 +1576,6 @@ def start_cap_type(self): References ---------- - >>> oEditor.GetPropertyValue """ return self._oeditor.GetPropertyValue("BaseElementTab", self.name, "StartCapType") @@ -1622,7 +1596,6 @@ def end_cap_type(self): References ---------- - >>> oEditor.GetPropertyValue """ return self._oeditor.GetPropertyValue("BaseElementTab", self.name, "EndCapType") @@ -1643,7 +1616,6 @@ def width(self): References ---------- - >>> oEditor.GetPropertyValue """ return self._oeditor.GetPropertyValue("BaseElementTab", self.name, "LineWidth") @@ -1664,7 +1636,6 @@ def length(self): References ---------- - >>> oEditor.GetPropertyValue """ return self._oeditor.GetPropertyValue("BaseElementTab", self.name, "TotalLength") @@ -1879,7 +1850,6 @@ def angle(self): References ---------- - >>> oEditor.GetPropertyValue """ if self.is_3d_placement: @@ -1991,7 +1961,6 @@ def location(self): References ---------- - >>> oEditor.GetPropertyValue """ location = self._oeditor.GetPropertyValue("BaseElementTab", self.name, "Location").split(",") @@ -2351,7 +2320,6 @@ def create(self): References ---------- - >>> oPadstackManager.Add """ @@ -2369,7 +2337,6 @@ def update(self): References ---------- - >>> oPadstackManager.Edit """ @@ -2386,7 +2353,6 @@ def remove(self): References ---------- - >>> oPadstackManager.Remove """ diff --git a/src/ansys/aedt/core/modeler/pcb/primitives_3d_layout.py b/src/ansys/aedt/core/modeler/pcb/primitives_3d_layout.py index c32d2310232..ca12d6eae8a 100644 --- a/src/ansys/aedt/core/modeler/pcb/primitives_3d_layout.py +++ b/src/ansys/aedt/core/modeler/pcb/primitives_3d_layout.py @@ -123,7 +123,6 @@ def opadstackmanager(self): References ---------- - >>> oPadstackManger = oDefinitionManager.GetManager("Padstack") """ return self._app.opadstackmanager @@ -846,7 +845,6 @@ def change_net_visibility(self, assignment=None, visible=False): References ---------- - >>> oEditor.SetNetVisible """ nets_dictionary = {} @@ -935,7 +933,6 @@ def create_via( References ---------- - >>> oEditor.CreateVia """ layers = self.modeler.layers.all_signal_layers @@ -1014,7 +1011,6 @@ def create_circle(self, layer, x, y, radius, name=None, net=None, **kwargs): References ---------- - >>> oEditor.CreateCircle """ if not name: @@ -1071,7 +1067,6 @@ def create_rectangle(self, layer, origin, sizes, corner_radius=0, angle=0, name= References ---------- - >>> oEditor.CreateRectangle """ if not name: @@ -1129,7 +1124,6 @@ def create_polygon(self, layer, point_list, units=None, name=None, net=None): References ---------- - >>> oEditor.CreatePolygon """ if not name: @@ -1184,7 +1178,6 @@ def create_polygon_void(self, layer, points, assignment, units=None, name=None): References ---------- - >>> oEditor.CreatePolygon """ if not name: @@ -1256,7 +1249,6 @@ def create_line( References ---------- - >>> oEditor.CreateLine """ if "netname" in kwargs: diff --git a/src/ansys/aedt/core/modeler/schematic.py b/src/ansys/aedt/core/modeler/schematic.py index 5d4320e40f0..af339756a57 100644 --- a/src/ansys/aedt/core/modeler/schematic.py +++ b/src/ansys/aedt/core/modeler/schematic.py @@ -107,7 +107,6 @@ def oeditor(self): References ---------- - >>> oEditor = oDesign.SetActiveEditor("SchematicEditor")""" return self._app.oeditor @@ -117,7 +116,6 @@ def zoom_to_fit(self): References ---------- - >>> oEditor.ZoomToFit """ self.oeditor.ZoomToFit() @@ -157,7 +155,6 @@ def connect_schematic_components( References ---------- - >>> oEditor.CreateWire """ if self._app.design_type == "Maxwell Circuit": @@ -256,7 +253,6 @@ def create_text( References ---------- - >>> oEditor.CreateText """ @@ -372,7 +368,6 @@ def change_text_property(self, assignment, name, value): References ---------- - >>> oEditor.ChangeProperty """ graphics_id = [id.split("@")[1] for id in self.oeditor.GetAllGraphics()] @@ -502,7 +497,6 @@ def layouteditor(self): References ---------- - >>> oDesign.SetActiveEditor("Layout") """ return self._app.layouteditor @@ -549,7 +543,6 @@ def model_units(self): References ---------- - >>> oEditor.GetActiveUnits >>> oEditor.SetActiveUnits """ @@ -613,7 +606,6 @@ def move(self, assignment, offset, units=None): References ---------- - >>> oEditor.Move """ sels = self._get_components_selections(assignment) @@ -660,7 +652,6 @@ def rotate(self, assignment, degrees=90): References ---------- - >>> oEditor.Rotate """ sels = self._get_components_selections(assignment) diff --git a/src/ansys/aedt/core/modules/boundary/common.py b/src/ansys/aedt/core/modules/boundary/common.py index 8be386d7e31..c304f8e032d 100644 --- a/src/ansys/aedt/core/modules/boundary/common.py +++ b/src/ansys/aedt/core/modules/boundary/common.py @@ -22,9 +22,7 @@ # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE # SOFTWARE. -""" -This module contains these classes: ``BoundaryCommon`` and ``BoundaryObject``. -""" +"""This module contains these classes: ``BoundaryCommon`` and ``BoundaryObject``.""" from ansys.aedt.core.generic.data_handlers import _dict2arg from ansys.aedt.core.generic.general_methods import PropsManager diff --git a/src/ansys/aedt/core/modules/boundary/icepak_boundary.py b/src/ansys/aedt/core/modules/boundary/icepak_boundary.py index a990c89b447..817b5e7265e 100644 --- a/src/ansys/aedt/core/modules/boundary/icepak_boundary.py +++ b/src/ansys/aedt/core/modules/boundary/icepak_boundary.py @@ -1070,9 +1070,7 @@ def props(self): @pyaedt_function_handler() def delete_link(self): - """ - Delete link from network. - """ + """Delete link from network.""" self._network.props["Links"].pop(self.name) self._network._links.remove(self) diff --git a/src/ansys/aedt/core/modules/design_xploration.py b/src/ansys/aedt/core/modules/design_xploration.py index b6fe097b753..e3387c9a5fe 100644 --- a/src/ansys/aedt/core/modules/design_xploration.py +++ b/src/ansys/aedt/core/modules/design_xploration.py @@ -295,7 +295,6 @@ def update(self, update_dictionary: Optional[Dict[str, Any]] = None) -> bool: References ---------- - >>> oModule.EditSetup """ if update_dictionary: @@ -325,7 +324,6 @@ def create(self) -> bool: References ---------- - >>> oModule.InsertSetup """ arg = ["NAME:" + self.name] @@ -590,7 +588,6 @@ def analyze( References ---------- - >>> oDesign.Analyze """ return self._app.analyze( @@ -674,7 +671,6 @@ def add_calculation( References ---------- - >>> oModule.EditSetup """ return self._add_calculation( @@ -741,7 +737,6 @@ def add_goal( References ---------- - >>> oModule.EditSetup """ @@ -940,7 +935,6 @@ def add_variation( References ---------- - >>> oModule.EditSetup """ if sweep_variable not in self._app.variable_manager.variables: @@ -1010,7 +1004,6 @@ def sync_variables(self, variables, sync_n=1): References ---------- - >>> oModule.EditSetup """ if type(self.props["Sweeps"]["SweepDefinition"]) is not list: @@ -1083,7 +1076,6 @@ def add_calculation( References ---------- - >>> oModule.EditSetup """ return self._add_calculation( @@ -1188,7 +1180,6 @@ def add( References ---------- - >>> oModule.InsertSetup """ if variable not in self._app.variable_manager.variables: @@ -1438,7 +1429,6 @@ def add( References ---------- - >>> oModule.InsertSetup """ if not solution and not self._app.nominal_sweep: diff --git a/src/ansys/aedt/core/modules/layer_stackup.py b/src/ansys/aedt/core/modules/layer_stackup.py index ca39400732f..b02b5b9f6ac 100644 --- a/src/ansys/aedt/core/modules/layer_stackup.py +++ b/src/ansys/aedt/core/modules/layer_stackup.py @@ -881,7 +881,6 @@ def set_layer_color(self, r, g, b): References ---------- - >>> oEditor.ChangeLayer """ rgb = [r, g, b] @@ -899,7 +898,6 @@ def create_stackup_layer(self): References ---------- - >>> oEditor.AddStackupLayer """ self.remove_stackup_layer() @@ -1124,7 +1122,6 @@ def update_stackup_layer(self): References ---------- - >>> oEditor.ChangeLayer """ self.oeditor.ChangeLayer(self._get_layer_arg) @@ -1141,7 +1138,6 @@ def remove_stackup_layer(self): References ---------- - >>> oEditor.RemoveLayer """ if self.name in self.oeditor.GetStackupLayerNames(): @@ -1180,7 +1176,6 @@ def oeditor(self): References ---------- - >>> oEditor = oDesign.SetActiveEditor("Layout") """ return self._modeler.oeditor @@ -1216,7 +1211,6 @@ def all_layers(self): References ---------- - >>> oEditor.GetStackupLayerNames() """ return [i for i in self.oeditor.GetAllLayerNames() if ";" not in i] @@ -1232,7 +1226,6 @@ def drawing_layers(self): References ---------- - >>> oEditor.GetAllLayerNames() """ return [v for k, v in self.layers.items() if v.type not in ["signal", "via", "dielectric"]] @@ -1248,7 +1241,6 @@ def stackup_layers(self): References ---------- - >>> oEditor.GetAllLayerNames() """ return [v for k, v in self.layers.items() if v.type in ["signal", "via", "dielectric"]] @@ -1275,7 +1267,6 @@ def signals(self): References ---------- - >>> oEditor.GetAllLayerNames() """ return {k: v for k, v in self.layers.items() if v.type == "signal"} @@ -1291,7 +1282,6 @@ def dielectrics(self): References ---------- - >>> oEditor.GetAllLayerNames() """ return {k: v for k, v in self.layers.items() if v.type == "dielectric"} @@ -1307,7 +1297,6 @@ def drawings(self): References ---------- - >>> oEditor.GetAllLayerNames() """ return {k: v for k, v in self.layers.items() if v.type in ["signal", "via", "dielectric"]} diff --git a/src/ansys/aedt/core/modules/material.py b/src/ansys/aedt/core/modules/material.py index 5888fa9c304..1a1369f29c9 100644 --- a/src/ansys/aedt/core/modules/material.py +++ b/src/ansys/aedt/core/modules/material.py @@ -489,7 +489,6 @@ def thermalmodifier(self, thermal_value): References ---------- - >>> oDefinitionManager.EditMaterial """ if thermal_value is None: @@ -694,7 +693,6 @@ def add_thermal_modifier_free_form(self, formula, index=0): References ---------- - >>> oDefinitionManager.EditMaterial Examples @@ -727,7 +725,6 @@ def add_thermal_modifier_dataset(self, dataset, index=0): References ---------- - >>> oDefinitionManager.EditMaterial Examples @@ -1006,7 +1003,6 @@ def spatialmodifier(self, spatial_value): References ---------- - >>> oDefinitionManager.EditMaterial """ if spatial_value is None: @@ -1184,7 +1180,6 @@ def add_spatial_modifier_free_form(self, formula, index=0): References ---------- - >>> oDefinitionManager.EditMaterial Examples @@ -1579,7 +1574,6 @@ def permittivity(self): References ---------- - >>> oDefinitionManager.EditMaterial """ return self._permittivity @@ -1599,7 +1593,6 @@ def permeability(self): References ---------- - >>> oDefinitionManager.EditMaterial """ return self._permeability @@ -1619,7 +1612,6 @@ def conductivity(self): References ---------- - >>> oDefinitionManager.EditMaterial """ return self._conductivity @@ -1654,7 +1646,6 @@ def magnetic_loss_tangent(self): References ---------- - >>> oDefinitionManager.EditMaterial """ return self._magnetic_loss_tangent @@ -1674,7 +1665,6 @@ def thermal_conductivity(self): References ---------- - >>> oDefinitionManager.EditMaterial """ return self._thermal_conductivity @@ -1696,7 +1686,6 @@ def mass_density(self): References ---------- - >>> oDefinitionManager.EditMaterial """ return self._mass_density @@ -1716,7 +1705,6 @@ def specific_heat(self): References ---------- - >>> oDefinitionManager.EditMaterial """ return self._specific_heat @@ -1736,7 +1724,6 @@ def thermal_expansion_coefficient(self): References ---------- - >>> oDefinitionManager.EditMaterial """ return self._thermal_expansion_coefficient @@ -1756,7 +1743,6 @@ def youngs_modulus(self): References ---------- - >>> oDefinitionManager.EditMaterial """ return self._youngs_modulus @@ -1778,7 +1764,6 @@ def poissons_ratio(self): References ---------- - >>> oDefinitionManager.EditMaterial """ return self._poissons_ratio @@ -1800,7 +1785,6 @@ def diffusivity(self): References ---------- - >>> oDefinitionManager.EditMaterial """ return self._diffusivity @@ -1820,7 +1804,6 @@ def magnetic_coercivity(self): References ---------- - >>> oDefinitionManager.EditMaterial """ return self._magnetic_coercivity @@ -1842,7 +1825,6 @@ def molecular_mass(self): References ---------- - >>> oDefinitionManager.EditMaterial """ return self._molecular_mass @@ -1862,7 +1844,6 @@ def viscosity(self): References ---------- - >>> oDefinitionManager.EditMaterial """ return self._viscosity @@ -1882,7 +1863,6 @@ def stacking_type(self): References ---------- - >>> oDefinitionManager.EditMaterial """ return self._stacking_type @@ -1915,7 +1895,6 @@ def wire_type(self): References ---------- - >>> oDefinitionManager.EditMaterial """ return self._wire_type @@ -1940,7 +1919,6 @@ def wire_thickness_direction(self): References ---------- - >>> oDefinitionManager.EditMaterial """ return self._wire_thickness_direction @@ -1965,7 +1943,6 @@ def wire_width_direction(self): References ---------- - >>> oDefinitionManager.EditMaterial """ return self._wire_width_direction @@ -1990,7 +1967,6 @@ def strand_number(self): References ---------- - >>> oDefinitionManager.EditMaterial """ return self._strand_number @@ -2012,7 +1988,6 @@ def wire_thickness(self): References ---------- - >>> oDefinitionManager.EditMaterial """ return self._wire_thickness @@ -2034,7 +2009,6 @@ def wire_diameter(self): References ---------- - >>> oDefinitionManager.EditMaterial """ return self._wire_diameter @@ -2056,7 +2030,6 @@ def wire_width(self): References ---------- - >>> oDefinitionManager.EditMaterial """ return self._wire_width @@ -2078,7 +2051,6 @@ def stacking_factor(self): References ---------- - >>> oDefinitionManager.EditMaterial """ return self._stacking_factor @@ -2100,7 +2072,6 @@ def stacking_direction(self): References ---------- - >>> oDefinitionManager.EditMaterial """ return self._stacking_direction @@ -2324,7 +2295,6 @@ def set_coreloss_at_frequency( References ---------- - >>> oDefinitionManager.EditMaterial Examples @@ -2857,7 +2827,6 @@ def emissivity(self): References ---------- - >>> oDefinitionManager.EditSurfaceMaterial """ return self._surface_emissivity @@ -2879,7 +2848,6 @@ def surface_diffuse_absorptance(self): References ---------- - >>> oDefinitionManager.EditSurfaceMaterial """ return self._surface_diffuse_absorptance @@ -2901,7 +2869,6 @@ def surface_incident_absorptance(self): References ---------- - >>> oDefinitionManager.EditSurfaceMaterial """ return self._surface_incident_absorptance @@ -2923,7 +2890,6 @@ def surface_roughness(self): References ---------- - >>> oDefinitionManager.EditSurfaceMaterial """ return self._surface_roughness @@ -2945,7 +2911,6 @@ def update(self): References ---------- - >>> oDefinitionManager.DoesSurfaceMaterialExist >>> oDefinitionManager.AddSurfaceMaterial >>> oDefinitionManager.EditSurfaceMaterial diff --git a/src/ansys/aedt/core/modules/material_lib.py b/src/ansys/aedt/core/modules/material_lib.py index 1d72f91cf7d..88b15962000 100644 --- a/src/ansys/aedt/core/modules/material_lib.py +++ b/src/ansys/aedt/core/modules/material_lib.py @@ -257,7 +257,6 @@ def checkifmaterialexists(self, material): References ---------- - >>> oDefinitionManager.GetProjectMaterialNames >>> oMaterialManager.GetData """ @@ -283,7 +282,6 @@ def exists_material(self, material): References ---------- - >>> oDefinitionManager.GetProjectMaterialNames >>> oMaterialManager.GetData """ @@ -347,7 +345,6 @@ def add_material(self, name, properties=None): References ---------- - >>> oDefinitionManager.AddMaterial Examples @@ -399,7 +396,6 @@ def add_surface_material(self, name, emissivity=None): References ---------- - >>> oDefinitionManager.AddSurfaceMaterial Examples @@ -464,12 +460,10 @@ def add_material_sweep(self, assignment, name): References ---------- - >>> oDefinitionManager.AddMaterial Examples -------- - >>> from ansys.aedt.core import Hfss >>> hfss = Hfss() >>> hfss.materials.add_material("MyMaterial") @@ -527,7 +521,6 @@ def duplicate_material(self, material, name=None, properties=None): References ---------- - >>> oDefinitionManager.AddMaterial Examples @@ -602,7 +595,6 @@ def duplicate_surface_material(self, material, name): References ---------- - >>> oDefinitionManager.AddSurfaceMaterial Examples @@ -641,12 +633,10 @@ def remove_material(self, material, library="Project"): References ---------- - >>> oDefinitionManager.RemoveMaterial Examples -------- - >>> from ansys.aedt.core import Hfss >>> hfss = Hfss() >>> hfss.materials.add_material("MyMaterial") @@ -965,7 +955,6 @@ def get_used_project_material_names(self): References ---------- - >>> oDefinitionManager.GetInUseProjectMaterialNames """ return self.odefinition_manager.GetInUseProjectMaterialNames() diff --git a/src/ansys/aedt/core/modules/mesh.py b/src/ansys/aedt/core/modules/mesh.py index 19c54c21dca..7f79e5e4d37 100644 --- a/src/ansys/aedt/core/modules/mesh.py +++ b/src/ansys/aedt/core/modules/mesh.py @@ -386,7 +386,6 @@ def delete(self): References ---------- - >>> oModule.DeleteOp """ self._mesh.omeshmodule.DeleteOp([self.name]) @@ -522,7 +521,6 @@ def initial_mesh_settings(self): References ---------- - >>> oModule.InitialMeshSettings """ if not self._globalmesh: @@ -535,7 +533,6 @@ def omeshmodule(self): References ---------- - >>> oDesign.GetModule("MeshSetup") """ return self._app.omeshmodule @@ -604,7 +601,6 @@ def assign_surface_mesh(self, assignment, level, name=None): References ---------- - >>> oModule.AssignTrueSurfOp Examples @@ -669,7 +665,6 @@ def assign_surface_mesh_manual( References ---------- - >>> oModule.AssignTrueSurfOp Examples @@ -746,7 +741,6 @@ def assign_model_resolution(self, assignment, defeature_length=None, name=None): References ---------- - >>> oModule.AssignModelResolutionOp Examples @@ -841,7 +835,6 @@ def assign_initial_mesh_from_slider( References ---------- - >>> oModule.InitialMeshSettings """ if self._app.design_type in ["2D Extractor", "Maxwell 2D"]: @@ -937,7 +930,6 @@ def assign_initial_mesh( References ---------- - >>> oModule.InitialMeshSettings """ if self._app.design_type in ["2D Extractor", "Maxwell 2D"]: @@ -1017,7 +1009,6 @@ def assign_surf_priority_for_tau(self, assignment, surface_priority=0): References ---------- - >>> oModule.AssignSurfPriorityForTauOp """ meshop_name = generate_unique_name("SurfaceRepPriority") @@ -1043,7 +1034,6 @@ def generate_mesh(self, name): References ---------- - >>> oDesign.GenerateMesh Examples @@ -1125,7 +1115,6 @@ def assign_length_mesh(self, assignment, inside_selection=True, maximum_length=1 References ---------- - >>> oModule.AssignLengthOp """ assignment = self._modeler.convert_to_selections(assignment, True) @@ -1226,7 +1215,6 @@ def assign_skin_depth( References ---------- - >>> oModule.AssignSkinDepthOp """ assignment = self._modeler.convert_to_selections(assignment, True) @@ -1298,7 +1286,6 @@ def assign_curvilinear_elements(self, assignment, enable=True, name=None): References ---------- - >>> oModule.AssignApplyCurvlinearElementsOp """ assignment = self._modeler.convert_to_selections(assignment, True) @@ -1351,7 +1338,6 @@ def assign_curvature_extraction(self, assignment, disabled_for_faceted=True, nam References ---------- - >>> oModule.AssignCurvatureExtractionOp """ assignment = self._modeler.convert_to_selections(assignment, True) @@ -1405,7 +1391,6 @@ def assign_rotational_layer(self, assignment, layers_number=3, total_thickness=" References ---------- - >>> oModule.AssignRotationalLayerOp """ assignment = self._modeler.convert_to_selections(assignment, True) @@ -1454,7 +1439,6 @@ def assign_edge_cut(self, assignment, layer_thickness="1mm", name=None): References ---------- - >>> oModule.AssignRotationalLayerOp """ assignment = self._modeler.convert_to_selections(assignment, True) @@ -1506,7 +1490,6 @@ def assign_density_control( References ---------- - >>> oModule.AssignDensityControlOp """ assignment = self._modeler.convert_to_selections(assignment, True) @@ -1599,7 +1582,6 @@ def assign_cylindrical_gap( References ---------- - >>> oModule.AssignCylindricalGapOp """ try: diff --git a/src/ansys/aedt/core/modules/mesh_3d_layout.py b/src/ansys/aedt/core/modules/mesh_3d_layout.py index 0b3e2380f5f..0967cd81770 100644 --- a/src/ansys/aedt/core/modules/mesh_3d_layout.py +++ b/src/ansys/aedt/core/modules/mesh_3d_layout.py @@ -94,7 +94,6 @@ def create(self): References ---------- - >>> oModule.AddMeshOperation """ self._mesh3dlayout.omeshmodule.AddMeshOperation(self.hfss_setup_name, self._get_args()) @@ -111,7 +110,6 @@ def update(self, *args, **kwargs): References ---------- - >>> oModule.EditMeshOperation """ self._mesh3dlayout.omeshmodule.EditMeshOperation(self.hfss_setup_name, self.name, self._get_args()) @@ -128,7 +126,6 @@ def delete(self): References ---------- - >>> oModule.DeleteMeshOperation """ self._mesh3dlayout.omeshmodule.DeleteMeshOperation( @@ -180,7 +177,6 @@ def generate_mesh(self, name): References ---------- - >>> oDesign.GenerateMesh """ self._app.oanalysis.GenerateMesh([name]) @@ -192,7 +188,6 @@ def omeshmodule(self): References ---------- - >>> oDesign.GetModule("SolveSetups") """ return self._app.omeshmodule @@ -215,7 +210,6 @@ def delete_mesh_operations(self, setup, name): References ---------- - >>> oModule.DeleteMeshOperation """ for el in self.meshoperations: @@ -284,7 +278,6 @@ def assign_length_mesh(self, setup, layer, net, is_inside=True, maximum_length=1 References ---------- - >>> oModule.AddMeshOperation """ if name: @@ -388,7 +381,6 @@ def assign_skin_depth( References ---------- - >>> oModule.AddMeshOperation """ if name: diff --git a/src/ansys/aedt/core/modules/mesh_icepak.py b/src/ansys/aedt/core/modules/mesh_icepak.py index bc177343c9f..b719f12ba01 100644 --- a/src/ansys/aedt/core/modules/mesh_icepak.py +++ b/src/ansys/aedt/core/modules/mesh_icepak.py @@ -683,9 +683,7 @@ def __init__(self, app): @property def name(self): - """ - Mesh region name. - """ + """Mesh region name.""" return "Global" @pyaedt_function_handler @@ -828,7 +826,6 @@ def update(self): References ---------- - >>> oModule.EditMeshRegion """ args = ["NAME:" + self.name, "Enable:=", self.enable] @@ -852,7 +849,6 @@ def delete(self): References ---------- - >>> oModule.DeleteMeshRegions() """ self._app.omeshmodule.DeleteMeshRegions([self.name]) @@ -927,7 +923,6 @@ def create(self): References ---------- - >>> oModule.AssignMeshRegion """ if self.name == "Settings": @@ -1078,7 +1073,6 @@ def omeshmodule(self): References ---------- - >>> oDesign.GetModule("MeshRegion") """ return self._app.omeshmodule @@ -1191,7 +1185,6 @@ def assign_mesh_level(self, mesh_order, name=None): References ---------- - >>> oModule.AssignMeshOperation """ level_order = {} @@ -1232,7 +1225,6 @@ def assign_mesh_from_file(self, assignment, file_name, name=None): References ---------- - >>> oModule.AssignMeshOperation """ objs = self._app.modeler.convert_to_selections(assignment, True) @@ -1275,7 +1267,6 @@ def automatic_mesh_pcb(self, accuracy=2): References ---------- - >>> oModule.EditMeshOperation """ warnings.warn("This method was deprecated in version 8.14.", DeprecationWarning) @@ -1316,7 +1307,6 @@ def automatic_mesh_3D(self, accuracy, enable_stair_step=True): References ---------- - >>> oModule.EditMeshOperation """ xsize = self.boundingdimension[0] / (10 * accuracy * accuracy) @@ -1557,7 +1547,6 @@ def assign_mesh_region(self, assignment=None, level=5, name=None, **kwargs): References ---------- - >>> oModule.AssignMeshRegion """ if not name: @@ -1598,7 +1587,6 @@ def generate_mesh(self, name=None): References ---------- - >>> oDesign.GenerateMesh """ if name is None: @@ -1640,7 +1628,6 @@ def assign_mesh_level_to_group( References ---------- - >>> oModule.AssignMeshOperation """ if name: @@ -1683,7 +1670,6 @@ def assign_mesh_reuse(self, assignment, mesh_file, name=None): References ---------- - >>> oModule.AssignMeshOperation """ if not os.path.exists(mesh_file): diff --git a/src/ansys/aedt/core/modules/solve_setup.py b/src/ansys/aedt/core/modules/solve_setup.py index de9ec06d0ca..181edf207ad 100644 --- a/src/ansys/aedt/core/modules/solve_setup.py +++ b/src/ansys/aedt/core/modules/solve_setup.py @@ -189,7 +189,6 @@ def analyze( References ---------- - >>> oDesign.Analyze """ self._app.analyze( @@ -475,7 +474,6 @@ def create_report( References ---------- - >>> oModule.CreateReport Examples @@ -541,7 +539,6 @@ def create(self): References ---------- - >>> oModule.InsertSetup """ soltype = SetupKeys.SetupNames[self.setuptype] @@ -571,7 +568,6 @@ def update(self, properties=None): References ---------- - >>> oModule.EditSetup """ legacy_update = self.auto_update @@ -764,7 +760,6 @@ def enable_expression_cache( References ---------- - >>> oModule.EditSetup """ arg = ["NAME:" + self.name] @@ -797,7 +792,6 @@ def enable(self, name=None): References ---------- - >>> oModule.EditSetup """ if not name: @@ -822,7 +816,6 @@ def disable(self, name=None): References ---------- - >>> oModule.EditSetup """ if not name: @@ -878,7 +871,6 @@ def add_mesh_link( References ---------- - >>> oModule.EditSetup Examples @@ -1053,7 +1045,6 @@ def start_continue_from_previous_setup( References ---------- - >>> oModule.EditSetup Examples @@ -1151,7 +1142,6 @@ def create(self): References ---------- - >>> oModule.AddLinearNetworkAnalysis >>> oModule.AddDCAnalysis >>> oModule.AddTransient @@ -1220,7 +1210,6 @@ def update(self, properties=None): References ---------- - >>> oModule.EditLinearNetworkAnalysis >>> oModule.EditDCAnalysis >>> oModule.EditTransient @@ -1265,7 +1254,6 @@ def add_sweep_points(self, sweep_variable="Freq", sweep_points=1, units="GHz", o References ---------- - >>> oModule.EditLinearNetworkAnalysis >>> oModule.EditDCAnalysis >>> oModule.EditTransient @@ -1323,7 +1311,6 @@ def add_sweep_count( References ---------- - >>> oModule.EditLinearNetworkAnalysis >>> oModule.EditDCAnalysis >>> oModule.EditTransient @@ -1380,7 +1367,6 @@ def add_sweep_step( References ---------- - >>> oModule.EditLinearNetworkAnalysis >>> oModule.EditDCAnalysis >>> oModule.EditTransient @@ -1568,7 +1554,6 @@ def enable_expression_cache( References ---------- - >>> oModule.EditSetup """ arg = ["Name:SimSetup"] @@ -1596,7 +1581,6 @@ def enable(self, name=None): References ---------- - >>> oModule.EditSetup """ if not name: @@ -1620,7 +1604,6 @@ def disable(self, name=None): References ---------- - >>> oModule.EditSetup """ if not name: @@ -1696,7 +1679,6 @@ def get_solution_data( References ---------- - >>> oModule.GetSolutionDataPerVariation """ return self._app.post.get_solution_data( @@ -1770,7 +1752,6 @@ def create_report( References ---------- - >>> oModule.CreateReport """ return self._app.post.create_report( @@ -1912,7 +1893,6 @@ def create(self): References ---------- - >>> oModule.Add """ arg = ["NAME:" + self.name] @@ -1936,7 +1916,6 @@ def update(self, properties=None): References ---------- - >>> oModule.Edit """ if properties: @@ -1963,7 +1942,6 @@ def enable(self): References ---------- - >>> oModule.Edit """ self.props["Properties"]["Enable"] = "true" @@ -1986,7 +1964,6 @@ def disable(self): References ---------- - >>> oModule.Edit """ self.props["Properties"]["Enable"] = "false" @@ -2319,7 +2296,6 @@ def add_sweep(self, name=None, sweep_type="Interpolating"): References ---------- - >>> oModule.AddSweep """ if not name: @@ -2531,7 +2507,6 @@ def add_derivatives(self, derivative_list): References ---------- - >>> oModule.EditSetup """ if not isinstance(derivative_list, list): @@ -2649,7 +2624,6 @@ def create_frequency_sweep( References ---------- - >>> oModule.InsertFrequencySweep Examples @@ -2743,7 +2717,6 @@ def create_linear_step_sweep( References ---------- - >>> oModule.InsertFrequencySweep Examples @@ -2825,7 +2798,6 @@ def create_single_point_sweep( References ---------- - >>> oModule.InsertFrequencySweep Examples @@ -2903,7 +2875,6 @@ def add_sweep(self, name=None, sweep_type="Interpolating"): References ---------- - >>> oModule.InsertFrequencySweep """ if not name: @@ -2965,7 +2936,6 @@ def get_sweep_names(self): References ---------- - >>> oModules.GetSweeps Examples @@ -2993,7 +2963,6 @@ def delete_sweep(self, name): References ---------- - >>> oModule.DeleteSweep Examples @@ -3272,7 +3241,6 @@ def add_derivatives(self, derivative_list): References ---------- - >>> oModule.EditSetup """ if not isinstance(derivative_list, list): @@ -3895,7 +3863,6 @@ def create_linear_step_sweep( References ---------- - >>> oModule.InsertFrequencySweep Examples @@ -4053,7 +4020,6 @@ def add_sweep(self, name=None, sweep_type="Interpolating"): References ---------- - >>> oModule.InsertFrequencySweep """ if not name: @@ -4193,7 +4159,6 @@ def update(self, properties=None): References ---------- - >>> oModule.EditSetup """ legacy_update = self.auto_update diff --git a/src/ansys/aedt/core/q3d.py b/src/ansys/aedt/core/q3d.py index 5bfc1345acb..380b5f69080 100644 --- a/src/ansys/aedt/core/q3d.py +++ b/src/ansys/aedt/core/q3d.py @@ -188,7 +188,6 @@ def get_all_sources(self): References ---------- - >>> oModule.GetAllSources """ return self.sources(0, False) @@ -916,7 +915,6 @@ def export_equivalent_circuit( References ---------- - >>> oModule.ExportCircuit Examples @@ -1348,7 +1346,6 @@ def nets(self): References ---------- - >>> oModule.ListNets """ nets_data = list(self.oboundary.ListNets()) @@ -1478,7 +1475,6 @@ def auto_identify_nets(self): References ---------- - >>> oModule.AutoIdentifyNets """ original_nets = [i for i in self.nets] @@ -1527,7 +1523,6 @@ def assign_net(self, assignment, net_name=None, net_type="Signal"): References ---------- - >>> oModule.AssignSignalNet >>> oModule.AssignGroundNet >>> oModule.AssignFloatingNet @@ -1613,7 +1608,6 @@ def sink(self, assignment=None, direction=0, name=None, net_name=None, terminal_ References ---------- - >>> oModule.AssignSource """ return self._assign_source_or_sink(assignment, direction, name, net_name, terminal_type, "Sink") @@ -1689,7 +1683,6 @@ def assign_sink_to_objectface(self, assignment, direction=0, name=None, net_name References ---------- - >>> oModule.AssignSink """ warnings.warn( @@ -1744,7 +1737,6 @@ def assign_sink_to_sheet( References ---------- - >>> oModule.AssignSink """ warnings.warn( @@ -1819,7 +1811,6 @@ def create_frequency_sweep(self, setupname, units=None, freqstart=0, freqstop=1, References ---------- - >>> oModule.InsertSweep """ if sweepname is None: @@ -1896,7 +1887,6 @@ def create_discrete_sweep( References ---------- - >>> oModule.InsertSweep """ if sweepname is None: @@ -1983,7 +1973,6 @@ def create_setup(self, name="MySetupAuto", **kwargs): Parameters ---------- - name : str, optional Name of the setup. The default is "Setup1". **kwargs : dict, optional @@ -1997,7 +1986,6 @@ def create_setup(self, name="MySetupAuto", **kwargs): References ---------- - >>> oModule.InsertSetup Examples @@ -2368,7 +2356,6 @@ def create_rectangle(self, origin, sizes, name="", material=""): References ---------- - >>> oEditor.CreateRectangle """ return self.modeler.create_rectangle(origin=origin, sizes=sizes, name=name, material=material) @@ -2395,7 +2382,6 @@ def assign_single_signal_line(self, assignment, name="", solve_option="SolveInsi References ---------- - >>> oModule.AssignSingleSignalLine >>> oModule.AssignSingleReferenceGround """ @@ -2444,7 +2430,6 @@ def assign_single_conductor( References ---------- - >>> oModule.AssignSingleSignalLine >>> oModule.AssignSingleReferenceGround """ @@ -2497,7 +2482,6 @@ def assign_huray_finitecond_to_edges(self, assignment, radius, ratio, units="um" References ---------- - >>> oMdoule.AssignFiniteCond """ if not name: @@ -2720,7 +2704,6 @@ def create_setup(self, name="MySetupAuto", setup_type=None, **kwargs): References ---------- - >>> oModule.InsertSetup Examples diff --git a/src/ansys/aedt/core/rmxprt.py b/src/ansys/aedt/core/rmxprt.py index 9187023884d..c3938067512 100644 --- a/src/ansys/aedt/core/rmxprt.py +++ b/src/ansys/aedt/core/rmxprt.py @@ -304,7 +304,6 @@ def create_setup(self, name="MySetupAuto", setup_type=None, **kwargs): References ---------- - >>> oModule.InsertSetup Examples diff --git a/src/ansys/aedt/core/twinbuilder.py b/src/ansys/aedt/core/twinbuilder.py index 8677f744df1..79599b250a2 100644 --- a/src/ansys/aedt/core/twinbuilder.py +++ b/src/ansys/aedt/core/twinbuilder.py @@ -259,7 +259,6 @@ def set_end_time(self, expression): References ---------- - >>> oDesign.ChangeProperty """ self.set_sim_setup_parameter("Tend", expression) @@ -281,7 +280,6 @@ def set_hmin(self, expression): References ---------- - >>> oDesign.ChangeProperty """ self.set_sim_setup_parameter("Hmin", expression) @@ -303,7 +301,6 @@ def set_hmax(self, expression): References ---------- - >>> oDesign.ChangeProperty """ self.set_sim_setup_parameter("Hmax", expression) @@ -329,7 +326,6 @@ def set_sim_setup_parameter(self, variable, expression, analysis_name="TR"): References ---------- - >>> oDesign.ChangeProperty """ if isinstance(expression, Variable): @@ -452,7 +448,6 @@ def add_q3d_dynamic_component( References ---------- - >>> oComponentManager.AddDynamicNPortData Examples diff --git a/src/ansys/aedt/core/visualization/post/common.py b/src/ansys/aedt/core/visualization/post/common.py index f69b603b16b..808675537f2 100644 --- a/src/ansys/aedt/core/visualization/post/common.py +++ b/src/ansys/aedt/core/visualization/post/common.py @@ -103,7 +103,6 @@ def available_report_types(self): References ---------- - >>> oModule.GetAvailableReportTypes """ return list(self.oreportsetup.GetAvailableReportTypes()) @@ -527,7 +526,6 @@ def oreportsetup(self): References ---------- - >>> oDesign.GetModule("ReportSetup") """ return self._app.oreportsetup @@ -580,7 +578,6 @@ def all_report_names(self): References ---------- - >>> oModule.GetAllReportNames() """ return list(self.oreportsetup.GetAllReportNames()) @@ -603,7 +600,6 @@ def copy_report_data(self, plot_name, paste=True): References ---------- - >>> oModule.CopyReportsData >>> oModule.PasteReports """ @@ -677,7 +673,6 @@ def rename_report(self, plot_name, new_name): References ---------- - >>> oModule.RenameReport """ try: @@ -719,7 +714,6 @@ def get_solution_data_per_variation( References ---------- - >>> oModule.GetSolutionDataPerVariation """ if sweeps is None: @@ -754,7 +748,6 @@ def steal_focus_oneditor(self): References ---------- - >>> oDesktop.RestoreWindow """ self._desktop.RestoreWindow() @@ -821,7 +814,6 @@ def export_report_to_file( References ---------- - >>> oModule.ExportReportDataToFile >>> oModule.ExportUniformPointsToFile >>> oModule.ExportToFile @@ -894,7 +886,6 @@ def export_report_to_csv( References ---------- - >>> oModule.ExportReportDataToFile >>> oModule.ExportToFile >>> oModule.ExportUniformPointsToFile @@ -934,7 +925,6 @@ def export_report_to_jpg(self, project_path, plot_name, width=0, height=0, image References ---------- - >>> oModule.ExportImageToFile """ file_name = os.path.join(project_path, plot_name + "." + image_format) # name of the image file @@ -1170,7 +1160,6 @@ def create_report( References ---------- - >>> oModule.CreateReport Examples @@ -1408,7 +1397,6 @@ def get_solution_data( References ---------- - >>> oModule.GetSolutionDataPerVariation Examples diff --git a/src/ansys/aedt/core/visualization/post/field_data.py b/src/ansys/aedt/core/visualization/post/field_data.py index ba2f06c817d..a479fb8ebe3 100644 --- a/src/ansys/aedt/core/visualization/post/field_data.py +++ b/src/ansys/aedt/core/visualization/post/field_data.py @@ -847,9 +847,7 @@ def __init__( self._folder_name = folder_name def update(self): - """ - Update folder plot settings. - """ + """Update folder plot settings.""" out = [] _dict2arg(self.to_dict(), out) self._postprocessor.ofieldsreporter.SetPlotFolderSettings(self._folder_name, out[0]) diff --git a/src/ansys/aedt/core/visualization/post/monitor_icepak.py b/src/ansys/aedt/core/visualization/post/monitor_icepak.py index 9d299e997a2..ffae885db47 100644 --- a/src/ansys/aedt/core/visualization/post/monitor_icepak.py +++ b/src/ansys/aedt/core/visualization/post/monitor_icepak.py @@ -370,7 +370,6 @@ def assign_point_monitor_to_vertex(self, vertex_id, monitor_quantity="Temperatur References ---------- - >>> oModule.AssignPointMonitor """ @@ -417,7 +416,6 @@ def assign_surface_monitor(self, surface_name, monitor_quantity="Temperature", m References ---------- - >>> oModule.AssignFaceMonitor Examples @@ -472,7 +470,6 @@ def assign_face_monitor(self, face_id, monitor_quantity="Temperature", monitor_n References ---------- - >>> oModule.AssignFaceMonitor """ if isinstance(face_id, int): @@ -579,7 +576,6 @@ def delete_monitor(self, monitor_name): References ---------- - >>> oModule.DeleteMonitors """ diff --git a/src/ansys/aedt/core/visualization/post/post_3dlayout.py b/src/ansys/aedt/core/visualization/post/post_3dlayout.py index 31b08e0c9ec..09e814dd6a9 100644 --- a/src/ansys/aedt/core/visualization/post/post_3dlayout.py +++ b/src/ansys/aedt/core/visualization/post/post_3dlayout.py @@ -184,7 +184,7 @@ def compute_power_by_layer(self, layers=None, solution=None): @pyaedt_function_handler() def compute_power_by_net(self, nets=None, solution=None): - """Computes the power by nets. This applies only to SIwave DC Analysis. + """Compute the power by nets. This applies only to SIwave DC Analysis. Parameters ---------- diff --git a/src/ansys/aedt/core/visualization/post/post_common_3d.py b/src/ansys/aedt/core/visualization/post/post_common_3d.py index 2c487513871..54f24db386a 100644 --- a/src/ansys/aedt/core/visualization/post/post_common_3d.py +++ b/src/ansys/aedt/core/visualization/post/post_common_3d.py @@ -145,7 +145,6 @@ def ofieldsreporter(self): References ---------- - >>> oDesign.GetModule("FieldsReporter") """ return self._app.ofieldsreporter @@ -330,7 +329,6 @@ def volumetric_loss(self, assignment): References ---------- - >>> oModule.EnterQty >>> oModule.EnterVol >>> oModule.CalcOp @@ -364,7 +362,6 @@ def change_field_property(self, plot_name, property_name, property_value): References ---------- - >>> oDesign.ChangeProperty """ self._odesign.ChangeProperty( @@ -613,7 +610,6 @@ def export_field_file_on_grid( References ---------- - >>> oModule.EnterQty >>> oModule.CopyNamedExprToStack >>> oModule.CalcOp @@ -800,7 +796,6 @@ def export_field_file( References ---------- - >>> oModule.EnterQty >>> oModule.CopyNamedExprToStack >>> oModule.CalcOp @@ -994,7 +989,6 @@ def change_field_plot_scale( References ---------- - >>> oModule.SetPlotFolderSettings """ args = ["NAME:FieldsPlotSettings", "Real Time mode:=", True] @@ -1883,7 +1877,6 @@ def create_fieldplot_volume( References ---------- - >>> oModule.CreateFieldPlot """ assignment = self._app.modeler.convert_to_selections(assignment, True) @@ -2029,7 +2022,6 @@ def delete_field_plot(self, name): References ---------- - >>> oModule.DeleteFieldPlot """ self.ofieldsreporter.DeleteFieldPlot([name]) @@ -2087,7 +2079,6 @@ def export_model_picture( References ---------- - >>> oEditor.ExportModelImageToFile Examples @@ -2365,7 +2356,6 @@ def power_budget(self, units="W", temperature=22, output_type="component"): References ---------- - >>> oEditor.ChangeProperty """ available_bcs = self._app.boundaries @@ -2903,7 +2893,6 @@ def create_sbr_point_visual_ray_tracing( Parameters ---------- - max_frequency : str, optional Maximum Frequency. Default is ``1GHz``. ray_density : int, optional diff --git a/src/ansys/aedt/core/visualization/post/post_icepak.py b/src/ansys/aedt/core/visualization/post/post_icepak.py index 92a13db009c..34a6ca97256 100644 --- a/src/ansys/aedt/core/visualization/post/post_icepak.py +++ b/src/ansys/aedt/core/visualization/post/post_icepak.py @@ -205,7 +205,6 @@ def evaluate_faces_quantity( References ---------- - >>> oModule.ExportFieldsSummary """ if variations is None: @@ -267,7 +266,6 @@ def evaluate_boundary_quantity( References ---------- - >>> oModule.ExportFieldsSummary """ if variations is None: @@ -320,7 +318,6 @@ def evaluate_monitor_quantity( References ---------- - >>> oModule.ExportFieldsSummary """ if variations is None: @@ -386,7 +383,6 @@ def evaluate_object_quantity( References ---------- - >>> oModule.ExportFieldsSummary """ if variations is None: diff --git a/src/ansys/aedt/core/visualization/post/solution_data.py b/src/ansys/aedt/core/visualization/post/solution_data.py index 37019429b55..ef9e3a6e6de 100644 --- a/src/ansys/aedt/core/visualization/post/solution_data.py +++ b/src/ansys/aedt/core/visualization/post/solution_data.py @@ -306,7 +306,7 @@ def _init_solution_data_real(self): @pyaedt_function_handler() def _init_solution_data_imag(self): - """ """ + """Initialize the imaginary part of the solution data.""" sols_data = {} for expression in self.expressions: diff --git a/src/ansys/aedt/core/visualization/post/spisim.py b/src/ansys/aedt/core/visualization/post/spisim.py index a682af2c15b..295c4527b34 100644 --- a/src/ansys/aedt/core/visualization/post/spisim.py +++ b/src/ansys/aedt/core/visualization/post/spisim.py @@ -485,8 +485,7 @@ def __init__( self.axis = axis def __len__(self): - """ - Returns the length of the axis. + """Return the length of the axis. Returns ------- diff --git a/src/ansys/aedt/core/visualization/report/common.py b/src/ansys/aedt/core/visualization/report/common.py index 5386b6d3f1e..21f67485d8a 100644 --- a/src/ansys/aedt/core/visualization/report/common.py +++ b/src/ansys/aedt/core/visualization/report/common.py @@ -2597,7 +2597,6 @@ def apply_report_template(self, input_file, property_type="Graphical"): # pragm References ---------- - >>> oModule.ApplyReportTemplate """ if not os.path.exists(input_file): # pragma: no cover diff --git a/src/ansys/aedt/core/workflows/hfss/choke_designer.py b/src/ansys/aedt/core/workflows/hfss/choke_designer.py index 83488d92469..8998cc36e3e 100644 --- a/src/ansys/aedt/core/workflows/hfss/choke_designer.py +++ b/src/ansys/aedt/core/workflows/hfss/choke_designer.py @@ -169,9 +169,7 @@ def update_config(cat, selected_option_u): def create_parameter_inputs(parent, config, category): def update_config(cat, field, entry_widget): - """ - Update config_dict when the user changes an input. - """ + """Update config_dict when the user changes an input.""" try: # Save numeric values as floats, others as strings new_value = ( diff --git a/src/ansys/aedt/core/workflows/icepak/power_map_from_csv.py b/src/ansys/aedt/core/workflows/icepak/power_map_from_csv.py index 063b7d57205..0d0bb86b893 100644 --- a/src/ansys/aedt/core/workflows/icepak/power_map_from_csv.py +++ b/src/ansys/aedt/core/workflows/icepak/power_map_from_csv.py @@ -256,7 +256,7 @@ def create_powermaps_from_info(ipk, geometric_info, source_value_info, source_un def extract_info(csv_file): - """Extracts source and geometric information from an Icepak classic CSV file. + """Extract source and geometric information from an Icepak classic CSV file. Parameters ---------- diff --git a/tests/unit/conftest.py b/tests/unit/conftest.py index a794ae37bae..f172d934ac1 100644 --- a/tests/unit/conftest.py +++ b/tests/unit/conftest.py @@ -31,7 +31,6 @@ @pytest.fixture def maxwell_3d_setup(): """Fixture used to setup a Maxwell3d instance.""" - with patch("ansys.aedt.core.maxwell.FieldAnalysis3D") as mock_fiel_analysis_3d, patch( "ansys.aedt.core.maxwell.Maxwell" ) as mock_maxwell: