FIX: Filtersolutions distributed example

doc/source/conf.py

@@ -286,6 +286,7 @@ def convert_examples_into_notebooks(app):
         "electrothermal.py",
         # GitHub CI/CD Pipeline fails to run lumped_element.py but it runs locally.
         "lumped_element.py",
+        "distributed_filter.py",
         # TODO: Remove once EMIT examples are moved into extensions.
         "interference_type.py",
         "interference.py",

examples/high_frequency/radiofrequency_mmwave/distributed_filter.py

@@ -0,0 +1,124 @@
+# # Distributed filter design
+#
+# This example demonstrates using PyAEDT and the ``FilterSolutions`` module to design a low-pass Chebyshev-I filter, 
+# visualize its frequency response, and export the distributed model to HFSS.
+#
+# Keywords: **filter solutions**
+
+# ## Perform imports and define constants
+#
+# Perform required imports.
+
+
+import ansys.aedt.core
+import ansys.aedt.core.filtersolutions
+import matplotlib.pyplot as plt
+from ansys.aedt.core.filtersolutions_core.attributes import FilterClass, FilterType
+from ansys.aedt.core.filtersolutions_core.export_to_aedt import ExportFormat
+from ansys.aedt.core.filtersolutions_core.ideal_response import (
+    SParametersResponseColumn,
+)
+from ansys.aedt.core.filtersolutions_core.distributed_topology import TopologyType
+from ansys.aedt.core.filtersolutions_core.distributed_substrate import SubstrateType, SubstrateEr, SubstrateResistivity
+
+# Define constants.
+
+AEDT_VERSION = "2025.2"
+
+# ## Define function used for plotting
+#
+# Define formal plot function.
+
+
+def format_plot():
+    plt.xlabel("Frequency (Hz)")
+    plt.ylabel("Magnitude S21 (dB)")
+    plt.title("Frequency Response")
+    plt.xscale("log")
+    plt.legend()
+    plt.grid()
+
+
+# ## Create distributed filter design
+#
+# Create a distributed filter design and assign the class, type, frequency, and order.
+
+distributed_design = ansys.aedt.core.filtersolutions.DistributedDesign(version=AEDT_VERSION,)
+distributed_design.attributes.filter_class = FilterClass.LOW_PASS
+distributed_design.attributes.filter_type = FilterType.CHEBYSHEV_I
+distributed_design.attributes.pass_band_center_frequency = "2 GHz"
+distributed_design.attributes.filter_order = 7
+
+# ## Define minimum and maximum analysis frequencies
+#
+# Specify the frequency range for the analysis, from 200 MHz to 4 GHz.
+# This range sets the bandwidth over which the filter response will be evaluated.
+
+
+distributed_design.graph_setup.minimum_frequency = "200 MHz"
+distributed_design.graph_setup.maximum_frequency = "4 GHz"
+
+# ## Define topology and substrate parameters
+#
+# Specify the filter topology, substrate type, dielectric constant, and substrate resistivity.
+# In this example, the topology is set to stepped impedance, the substrate type to microstrip,
+# the conductor material to silver, and the substrate material to alumina.
+
+distributed_design.topology.topology_type = TopologyType.STEPPED_IMPEDANCE
+distributed_design.substrate.substrate_type = SubstrateType.MICROSTRIP
+distributed_design.substrate.substrate_er = SubstrateEr.ALUMINA
+distributed_design.substrate.substrate_resistivity = SubstrateResistivity.SILVER
+distributed_design.substrate.substrate_conductor_thickness = "2um"
+distributed_design.substrate.substrate_dielectric_height = "200 um"
+
+# ## Plot frequency response of the filter
+#
+# Plot the synthesized frequency response to visualize the transmission and reflection
+# characteristics of filter over the defined frequency range.
+
+freq, s11_db = distributed_design.ideal_response.s_parameters(SParametersResponseColumn.S11_DB)
+freq, s21_db = distributed_design.ideal_response.s_parameters(SParametersResponseColumn.S21_DB)
+plt.plot(freq, s11_db, linewidth=2.0, label="Synthesized S11")
+plt.plot(freq, s21_db, linewidth=2.0, label="Synthesized S21")
+format_plot()
+plt.show()
+
+# <img src="_static/distributed_filter_response.png" width="400">
+
+# ## Export distributed model of the filter to HFSS 3D Layout and simulate
+#
+# Export the designed filter as a distributed model to Ansys HFSS 3D Layout,
+# and perform the simulation using the defined export parameters.
+# Set the schematic name, enable the required reports.
+
+distributed_design.export_to_aedt.schematic_name = "DistributedFilter"
+distributed_design.export_to_aedt.simulate_after_export_enabled = True
+distributed_design.export_to_aedt.optimitrics_enabled = False
+distributed_design.export_to_aedt.include_forward_transfer_s21_enabled  = True
+distributed_design.export_to_aedt.include_return_loss_s11_enabled = True
+distributed_design.export_to_aedt.insert_hfss_3dl_design = True
+hfss3dl = distributed_design.export_to_aedt.export_design(export_format=ExportFormat.DIRECT_TO_AEDT)
+
+# <img src="_static/desktop_results_distributed.png" width="400">
+
+# ## Plot the simulated design
+#
+# Get the scattering parameter data from the AEDT HFSS 3D Layout simulation and create a plot.
+
+hfss3dl.analyze()
+solutions = hfss3dl.post.get_solution_data(
+    expressions=hfss3dl.get_traces_for_plot(category="S"),
+    report_category="Standard",
+)
+sim_freq = solutions.primary_sweep_values
+sim_freq_ghz = [i * 1e9 for i in sim_freq]
+sim_s11_db = solutions.get_expression_data("S(Port1,Port1)", "dB20")[1]
+sim_s21_db = solutions.get_expression_data("S(Port2,Port1)", "dB20")[1]
+plt.plot(freq, s11_db, linewidth=2.0, label="Synthesized S11")
+plt.plot(freq, s21_db, linewidth=2.0, label="Synthesized S21")
+plt.plot(sim_freq_ghz, sim_s11_db, linewidth=2.0, label="Simulated S11")
+plt.plot(sim_freq_ghz, sim_s21_db, linewidth=2.0, label="Simulated S21")
+format_plot()
+plt.show()
+
+# <img src="_static/simulated_distributed_filter.png" width="400">

examples/high_frequency/radiofrequency_mmwave/index.rst

@@ -73,6 +73,22 @@ These examples use PyAEDT to show some radio frequency and millimeter wave appli
       This example shows how to use PyAEDT to use the FilterSolutions module to design and visualize the frequency
       response of a band-pass Butterworth filter and export the lumped element model to AEDT Circuit.
 
+
+   .. grid-item-card:: Distributed filter design
+      :padding: 2 2 2 2
+      :link: distributed_filter
+      :link-type: doc
+
+      .. image:: _static/distributed_filter.png
+         :alt: Distributed filter
+         :width: 250px
+         :height: 200px
+         :align: center
+
+      This example demonstrates using PyAEDT and the FilterSolutions module to design a low-pass Chebyshev-I filter, 
+      visualize its frequency response, and export the distributed model to HFSS.
+
+
    .. grid-item-card:: Flex cable CPWG
       :padding: 2 2 2 2
       :link: ../emc/flex_cable