DOC: Add Q2D Q3D examples (#88)

* DOC: Avoid running examples twice

* CI: Add ON_CI environment variable

* DOC: Only keep doctree to shorten CI/CD

* CI: Use env var SPHINXBUILD_KEEP_DOCTREEDIR

* ADD: All examples from pyaedt repo.

* Update: 04-Static_ROM_Creation_And_Visualization.py

* Update: Fix code style errors.

* Update: Fix code style errors.

* Update: Fix code style errors.

* Update: Fix code style errors.

* Update: Fix code style errors.

* Update: Fix code style errors.

* DELETE: intereference_gui.py\07-EMIT

* FIX: typo in EDB_in_3DLayout.py

* MAINT: Update pre-commit codespell version

Note: Previous version was triggering a false positive in an
example.

* FIX: Use pyedb to instanciate EDB

* MAINT: Update codespell configuration

* FIX: New codespell catches

* FIX: Put back exclude css files

* FIX: Use EDB_VERSION and AEDT_VERSION

* FIX: HFSS3DLayout example

Note: When trying to access the loop resistance, an error happens and
AEDT crashes which makes the example non ending.

* ADD: 05-Q3D

Refactor folder 05-Q3D to enable example editing and creation using Notebooks.

* checking that the examples run

* remove comments

* q2d instance

* fix q2d instance

* armoured cable fixes

* clean q2d cpwg

* fix typos in Maxwell and clean q3d ones

* changed Q2D_Example_Stripline.py design to an actual stripline instead of CPWG; minor style changes

* improve q2d stripline

* improve q2d stripline

* improve q3d dcir

* improve q3d busbar

* improve q3d examples

* update toml

* Apply suggestions from code review

Co-authored-by: Devin <[email protected]>

* Update Q3D_DC_IR.py

* update toml + fix DC IR example

* fix maxwell 2d

* fix hfss example

* TO BE REVERTED: remove other examples

* Revert "TO BE REVERTED: remove other examples"

This reverts commit f198e36.

* Update examples/index.rst

---------

Co-authored-by: Sebastien Morais <[email protected]>
Co-authored-by: Devin <[email protected]>
Co-authored-by: Devin <[email protected]>
Co-authored-by: Giulia Malinverno <[email protected]>
Co-authored-by: marcoglasses <[email protected]>
Co-authored-by: gmalinve <[email protected]>
Co-authored-by: Sébastien Morais <[email protected]>

doc/source/conf.py

@@ -13,8 +13,6 @@
 import sys
 import warnings
 
-from ansys.pyaedt.examples import __version__
-
 # from sphinx_gallery.sorting import FileNameSortKey
 from ansys_sphinx_theme import (
     ansys_favicon,

examples/03-Maxwell/Maxwell2D_DCConduction.py

@@ -274,7 +274,7 @@
 
 # ## Release AEDT and clean up temporary directory
 #
-# Release AEDT and remove both the project and temporary directories.
+# Release AEDT and remove both the project and temporary directory.
 
 m2d.release_desktop()
 temp_dir.cleanup()

examples/03-Maxwell/Maxwell2D_Electrostatic.py

@@ -195,12 +195,6 @@
     plot_name="LineTracesTest", output_dir=m2d.toolkit_directory, file_format="fldplt"
 )
 
-# ## Export a field plot to an image file
-#
-# Export the flux lines plot to an image file using PyVista Python package.
-
-m2d.post.plot_field_from_fieldplot(plot.name, show=False)
-
 # ## Export the mesh field plot
 #
 # Export the mesh in ``aedtplt`` format.

examples/03-Maxwell/Maxwell2D_Transient.py

@@ -153,7 +153,7 @@
 
 # ## Release AEDT and clean up temporary directory
 #
-# Release AEDT and remove both the project and temporary directories.
+# Release AEDT and remove both the project and temporary directory.
 
 m2d.release_desktop()
 temp_dir.cleanup()

examples/03-Maxwell/Maxwell3DTeam7.py

@@ -496,7 +496,7 @@
 
 # ## Release AEDT and clean up temporary directory
 #
-# Release AEDT and remove both the project and temporary directories.
+# Release AEDT and remove both the project and temporary directory.
 
 m3d.release_desktop(True, True)
 temp_dir.cleanup()

examples/03-Maxwell/Maxwell3D_Choke.py

@@ -241,7 +241,7 @@
 
 # ## Release AEDT and clean up temporary directory
 #
-# Release AEDT and remove both the project and temporary directories.
+# Release AEDT and remove both the project and temporary directory.
 
 m3d.release_desktop()
 temp_dir.cleanup()

examples/03-Maxwell/Maxwell3D_Segmentation.py

@@ -102,7 +102,7 @@
 
 # ## Release AEDT and clean up temporary directory
 #
-# Release AEDT and remove both the project and temporary directories.
+# Release AEDT and remove both the project and temporary directory.
 
 m3d.release_desktop()
 temp_dir.cleanup()

examples/03-Maxwell/Maxwell3D_Team3_bath_plate.py

@@ -245,7 +245,7 @@
 
 # ## Release AEDT
 #
-# Release AEDT from the script engine, leaving both AEDT and the project open.
+# Release AEDT and remove both the project and temporary directory.
 
 m3d.release_desktop(True, True)
 temp_dir.cleanup()

examples/03-Maxwell/Maxwell_Control_Program.py

@@ -87,7 +87,7 @@
 
 # ## Release AEDT and clean up temporary directory
 #
-# Release AEDT and remove both the project and temporary directories.
+# Release AEDT and remove both the project and temporary directory.
 
 m2d.release_desktop()
 temp_dir.cleanup()

examples/03-Maxwell/Maxwell_Magnet.py

@@ -116,7 +116,7 @@
 
 # ## Release AEDT and clean up temporary directory
 #
-# Release AEDT and remove both the project and temporary directories.
+# Release AEDT and remove both the project and temporary directory.
 
 m3d.release_desktop(close_projects=True, close_desktop=True)
 temp_dir.cleanup()

examples/03-Maxwell/Maxwell_Transformer_Coreloss.py

@@ -106,7 +106,7 @@
 
 # ## Release AEDT and clean up temporary directory
 #
-# Release AEDT and remove both the project and temporary directories.
+# Release AEDT and remove both the project and temporary directory.
 
 m3d.release_desktop()
 temp_dir.cleanup()

examples/05-Q3D/Q2D_Armoured_Cable.py

@@ -0,0 +1,257 @@
+# # Q2D: Cable parameter identification
+
+# This example shows how you can use PyAEDT to perform these tasks:
+#
+#  - Create a Q2D design using the Modeler primitives and importing part of the geometry.
+#  - Set up the entire simulation.
+#  - Link the solution to a Simplorer design.
+#
+# For cable information, see `4 Core Armoured Power Cable
+# <https://www.luxingcable.com/low-voltage-cables/4-core-armoured-power-cable.html>`_
+
+# ## Perform required imports
+#
+
+# +
+import math
+
+from ansys.pyaedt.examples.constants import AEDT_VERSION
+import pyaedt
+
+# -
+
+# ## Initialize core strand dimensions and positions
+#
+# Initialize cable sizing - radii in mm.
+
+c_strand_radius = 2.575
+cable_n_cores = 4
+core_n_strands = 6
+core_xlpe_ins_thickness = 0.5
+core_xy_coord = math.ceil(3 * c_strand_radius + 2 * core_xlpe_ins_thickness)
+
+# ## Initialize filling and sheath dimensions
+#
+# Initialize radii of further structures incrementally adding thicknesses.
+
+filling_radius = 1.4142 * (core_xy_coord + 3 * c_strand_radius + core_xlpe_ins_thickness + 0.5)
+inner_sheath_radius = filling_radius + 0.75
+armour_thickness = 3
+armour_radius = inner_sheath_radius + armour_thickness
+outer_sheath_radius = armour_radius + 2
+
+# ## Initialize armature strand dimensions
+#
+# Initialize radii.
+
+armour_centre_pos = inner_sheath_radius + armour_thickness / 2.0
+arm_strand_rad = armour_thickness / 2.0 - 0.2
+n_arm_strands = 30
+
+# ## Initialize dictionaries
+#
+# Initialize dictionaries that contain all the definitions for the design
+# variables and output variables.
+
+core_params = {
+    "n_cores": str(cable_n_cores),
+    "n_strands_core": str(core_n_strands),
+    "c_strand_radius": str(c_strand_radius) + "mm",
+    "c_strand_xy_coord": str(core_xy_coord) + "mm",
+}
+outer_params = {
+    "filling_radius": str(filling_radius) + "mm",
+    "inner_sheath_radius": str(inner_sheath_radius) + "mm",
+    "armour_radius": str(armour_radius) + "mm",
+    "outer_sheath_radius": str(outer_sheath_radius) + "mm",
+}
+armour_params = {
+    "armour_centre_pos": str(armour_centre_pos) + "mm",
+    "arm_strand_rad": str(arm_strand_rad) + "mm",
+    "n_arm_strands": str(n_arm_strands),
+}
+
+# ## Initialize Q2D
+#
+# Initialize Q2D, providing the version, path to the project, and the design
+# name and type.
+
+desktop_version = AEDT_VERSION
+project_name = "Q2D_ArmouredCableExample"
+q2d_design_name = "2D_Extractor_Cable"
+setup_name = "MySetupAuto"
+sweep_name = "sweep1"
+tb_design_name = "CableSystem"
+q2d = pyaedt.Q2d(
+    projectname=project_name, designname=q2d_design_name, specified_version=desktop_version
+)
+
+# ## Define variables from dictionaries
+#
+# Define design variables from the created dictionaries.
+
+for k, v in core_params.items():
+    q2d[k] = v
+for k, v in outer_params.items():
+    q2d[k] = v
+for k, v in armour_params.items():
+    q2d[k] = v
+
+# ## Set model units
+
+q2d.modeler.model_units = "mm"
+
+# ## Initialize required material properties
+#
+# Cable insulators require the definition of specific materials since they are not
+# included in the Sys Library.
+# Plastic, PE (cross-linked, wire, and cable grade)
+
+mat_pe_cable_grade = q2d.materials.add_material("plastic_pe_cable_grade")
+mat_pe_cable_grade.conductivity = "1.40573e-16"
+mat_pe_cable_grade.permittivity = "2.09762"
+mat_pe_cable_grade.dielectric_loss_tangent = "0.000264575"
+mat_pe_cable_grade.update()
+
+# Plastic, PP (10% carbon fiber)
+
+mat_pp = q2d.materials.add_material("plastic_pp_carbon_fiber")
+mat_pp.conductivity = "0.0003161"
+mat_pp.update()
+
+# ## Create geometry for core strands, filling, and XLPE insulation
+
+# +
+q2d.modeler.create_coordinate_system(
+    origin=["c_strand_xy_coord", "c_strand_xy_coord", "0mm"], name="CS_c_strand_1"
+)
+q2d.modeler.set_working_coordinate_system("CS_c_strand_1")
+c1_id = q2d.modeler.create_circle(
+    ["0mm", "0mm", "0mm"], "c_strand_radius", name="c_strand_1", matname="copper"
+)
+c2_id = c1_id.duplicate_along_line(vector=["0mm", "2.0*c_strand_radius", "0mm"], nclones=2)
+q2d.modeler.duplicate_around_axis(c2_id, cs_axis="Z", angle=360 / core_n_strands, nclones=6)
+c_unite_name = q2d.modeler.unite(q2d.get_all_conductors_names())
+
+fill_id = q2d.modeler.create_circle(
+    ["0mm", "0mm", "0mm"],
+    "3*c_strand_radius",
+    name="c_strand_fill",
+    matname="plastic_pp_carbon_fiber",
+)
+fill_id.color = (255, 255, 0)
+xlpe_id = q2d.modeler.create_circle(
+    ["0mm", "0mm", "0mm"],
+    "3*c_strand_radius+" + str(core_xlpe_ins_thickness) + "mm",
+    name="c_strand_xlpe",
+    matname="plastic_pe_cable_grade",
+)
+xlpe_id.color = (0, 128, 128)
+
+q2d.modeler.set_working_coordinate_system("Global")
+all_obj_names = q2d.get_all_conductors_names() + q2d.get_all_dielectrics_names()
+q2d.modeler.duplicate_around_axis(all_obj_names, cs_axis="Z", angle=360 / cable_n_cores, nclones=4)
+cond_names = q2d.get_all_conductors_names()
+# -
+
+# ## Create geometry for filling object
+
+filling_id = q2d.modeler.create_circle(
+    ["0mm", "0mm", "0mm"], "filling_radius", name="Filling", matname="plastic_pp_carbon_fiber"
+)
+filling_id.color = (255, 255, 180)
+
+# ## Create geometry for inner sheath object
+
+inner_sheath_id = q2d.modeler.create_circle(
+    ["0mm", "0mm", "0mm"], "inner_sheath_radius", name="InnerSheath", matname="PVC plastic"
+)
+inner_sheath_id.color = (0, 0, 0)
+
+# ## Create geometry for armature fill
+
+arm_fill_id = q2d.modeler.create_circle(
+    ["0mm", "0mm", "0mm"], "armour_radius", name="ArmourFilling", matname="plastic_pp_carbon_fiber"
+)
+arm_fill_id.color = (255, 255, 255)
+
+# ## Create geometry for outer sheath
+
+outer_sheath_id = q2d.modeler.create_circle(
+    ["0mm", "0mm", "0mm"], "outer_sheath_radius", name="OuterSheath", matname="PVC plastic"
+)
+outer_sheath_id.color = (0, 0, 0)
+
+# ## Create geometry for armature steel strands
+
+arm_strand_1_id = q2d.modeler.create_circle(
+    ["0mm", "armour_centre_pos", "0mm"], "1.1mm", name="arm_strand_1", matname="steel_stainless"
+)
+arm_strand_1_id.color = (128, 128, 64)
+arm_strand_1_id.duplicate_around_axis("Z", "360deg/n_arm_strands", nclones="n_arm_strands")
+arm_strand_names = q2d.modeler.get_objects_w_string("arm_strand")
+
+# ## Create region
+
+region = q2d.modeler.create_region([500, 500, 500, 500])
+region.material_name = "vacuum"
+
+# ## Assign conductors and reference ground
+
+obj = [q2d.modeler.get_object_from_name(i) for i in cond_names]
+[
+    q2d.assign_single_conductor(
+        name="C1" + str(obj.index(i) + 1), target_objects=i, conductor_type="SignalLine"
+    )
+    for i in obj
+]
+obj = [q2d.modeler.get_object_from_name(i) for i in arm_strand_names]
+q2d.assign_single_conductor(name="gnd", target_objects=obj, conductor_type="ReferenceGround")
+q2d.modeler.fit_all()
+
+# ## Assign design settings
+
+lumped_length = "100m"
+q2d_des_settings = q2d.design_settings()
+q2d_des_settings["LumpedLength"] = lumped_length
+q2d.change_design_settings(q2d_des_settings)
+
+# ## Insert setup and frequency sweep
+
+q2d_setup = q2d.create_setup(setupname=setup_name)
+q2d_sweep = q2d_setup.add_sweep(sweepname=sweep_name)
+q2d_sweep.add_subrange("LogScale", 0, 3, 10, "MHz")
+q2d_sweep.props["RangeType"] = "LogScale"
+q2d_sweep.props["RangeStart"] = "0Hz"
+q2d_sweep.props["RangeEnd"] = "3MHz"
+q2d_sweep.props["RangeCount"] = 10
+q2d_sweep.props["RangeSamples"] = 1
+q2d_sweep.update()
+
+# ## Analyze setup
+
+# Uncomment line to analyze the model
+
+# +
+# q2d.analyze(setup_name=setup_name)
+# -
+
+# ## Add a Simplorer/Twin Builder design and the Q3D dynamic component
+
+tb = pyaedt.TwinBuilder(designname=tb_design_name)
+
+# ## Add a Q3D dynamic component
+
+tb.add_q3d_dynamic_component(
+    project_name,
+    q2d_design_name,
+    setup_name,
+    sweep_name,
+    model_depth=lumped_length,
+    coupling_matrix_name="Original",
+)
+
+# ## Save project and release desktop
+
+tb.save_project()
+tb.release_desktop(True, True)