.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "examples\07-EMIT\ComputeProtectionLevels.py"
.. LINE NUMBERS ARE GIVEN BELOW.
.. only:: html
.. note::
:class: sphx-glr-download-link-note
:ref:`Go to the end <sphx_glr_download_examples_07-EMIT_ComputeProtectionLevels.py>`
to download the full example code.
.. rst-class:: sphx-glr-example-title
.. _sphx_glr_examples_07-EMIT_ComputeProtectionLevels.py:
EMIT: Compute receiver protection levels
----------------------------------------
This example shows how you can use PyAEDT to open an AEDT project with
an EMIT design and analyze the results to determine if the received
power at the input to each receiver exceeds the specified protection
levels.
.. GENERATED FROM PYTHON SOURCE LINES 10-15
Perform required imports
~~~~~~~~~~~~~~~~~~~~~~~~
Perform required imports.
sphinx_gallery_thumbnail_path = "Resources/emit_protection_levels.png"
.. GENERATED FROM PYTHON SOURCE LINES 15-39
.. code-block:: Python
import os
import sys
import subprocess
import pyaedt
from pyaedt import Emit
from pyaedt.emit_core.emit_constants import TxRxMode, ResultType, InterfererType
# Check to see which Python libraries have been installed
reqs = subprocess.check_output([sys.executable, '-m', 'pip', 'freeze'])
installed_packages = [r.decode().split('==')[0] for r in reqs.split()]
# Install required packages if they are not installed
def install(package):
subprocess.check_call([sys.executable, '-m', 'pip', 'install', package])
# Install any missing libraries
required_packages = ['plotly']
for package in required_packages:
if package not in installed_packages:
install(package)
# Import required modules
import plotly.graph_objects as go
.. GENERATED FROM PYTHON SOURCE LINES 40-43
Set AEDT version
~~~~~~~~~~~~~~~~
Set AEDT version.
.. GENERATED FROM PYTHON SOURCE LINES 43-46
.. code-block:: Python
aedt_version = "2024.1"
.. GENERATED FROM PYTHON SOURCE LINES 47-54
Set non-graphical mode
~~~~~~~~~~~~~~~~~~~~~~
Set non-graphical mode. ``"PYAEDT_NON_GRAPHICAL"``` is needed to generate
documentation only.
You can set ``non_graphical`` either to ``True`` or ``False``.
The ``new_thread`` Boolean variable defines whether to create a new instance
of AEDT or try to connect to existing instance of it if one is available.
.. GENERATED FROM PYTHON SOURCE LINES 54-58
.. code-block:: Python
non_graphical = False
new_thread = True
.. GENERATED FROM PYTHON SOURCE LINES 59-63
Launch AEDT with EMIT
~~~~~~~~~~~~~~~~~~~~~
Launch AEDT with EMIT. The ``Desktop`` class initializes AEDT and starts it
on the specified version and in the specified graphical mode.
.. GENERATED FROM PYTHON SOURCE LINES 63-71
.. code-block:: Python
if aedt_version <= "2023.1":
print("Warning: this example requires AEDT 2023.2 or later.")
sys.exit()
d = pyaedt.launch_desktop(aedt_version, non_graphical, new_thread)
emitapp = Emit(pyaedt.generate_unique_project_name())
.. rst-class:: sphx-glr-script-out
.. code-block:: none
C:\actions-runner\_work\_tool\Python\3.10.9\x64\lib\subprocess.py:1072: ResourceWarning: subprocess 6084 is still running
_warn("subprocess %s is still running" % self.pid,
C:\actions-runner\_work\pyaedt\pyaedt\.venv\lib\site-packages\pyaedt\generic\settings.py:383: ResourceWarning: unclosed file <_io.TextIOWrapper name='D:\\Temp\\pyaedt_ansys.log' mode='a' encoding='cp1252'>
self._logger = val
.. GENERATED FROM PYTHON SOURCE LINES 72-82
Specify the protection levels
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The protection levels are specified in dBm.
If the damage threshold is exceeded, permanent damage to the receiver front
end may occur.
Exceeding the overload threshold severely densensitizes the receiver.
Exceeding the intermod threshold can drive the victim receiver into non-
linear operation, where it operates as a mixer.
Exceeding the desense threshold reduces the signal-to-noise ratio and can
reduce the maximum range, maximum bandwidth, and/or the overall link quality.
.. GENERATED FROM PYTHON SOURCE LINES 82-91
.. code-block:: Python
header_color = 'grey'
damage_threshold = 30
overload_threshold = -4
intermod_threshold = -30
desense_threshold = -104
protection_levels = [damage_threshold, overload_threshold, intermod_threshold, desense_threshold]
.. GENERATED FROM PYTHON SOURCE LINES 92-95
Create and connect EMIT components
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Set up the scenario with radios connected to antennas.
.. GENERATED FROM PYTHON SOURCE LINES 95-100
.. code-block:: Python
bluetooth, blue_ant = emitapp.modeler.components.create_radio_antenna("Bluetooth Low Energy (LE)", "Bluetooth")
gps, gps_ant = emitapp.modeler.components.create_radio_antenna("GPS Receiver", "GPS")
wifi, wifi_ant = emitapp.modeler.components.create_radio_antenna("WiFi - 802.11-2012", "WiFi")
.. GENERATED FROM PYTHON SOURCE LINES 101-105
Configure the radios
~~~~~~~~~~~~~~~~~~~~
Enable the HR-DSSS bands for the Wi-Fi radio and set the power level
for all transmit bands to -20 dBm.
.. GENERATED FROM PYTHON SOURCE LINES 105-141
.. code-block:: Python
bands = wifi.bands()
for band in bands:
if "HR-DSSS" in band.node_name:
if "Ch 1-13" in band.node_name:
band.enabled=True
band.set_band_power_level(-20)
# Reduce the bluetooth transmit power
bands = bluetooth.bands()
for band in bands:
band.set_band_power_level(-20)
def get_radio_node(radio_name):
"""Get the radio node that matches the
given radio name.
Arguments:
radio_name: String name of the radio.
Returns: Instance of the radio.
"""
if gps.name == radio_name:
radio = gps
elif bluetooth.name == radio_name:
radio = bluetooth
else:
radio = wifi
return radio
bands = gps.bands()
for band in bands:
for child in band.children:
if "L2 P(Y)" in band.node_name:
band.enabled=True
else:
band.enabled=False
.. GENERATED FROM PYTHON SOURCE LINES 142-145
Load the results set
~~~~~~~~~~~~~~~~~~~~
Create a results revision and load it for analysis.
.. GENERATED FROM PYTHON SOURCE LINES 145-148
.. code-block:: Python
rev = emitapp.results.analyze()
.. GENERATED FROM PYTHON SOURCE LINES 149-153
Generate a legend
~~~~~~~~~~~~~~~~~
Define the thresholds and colors used to display the results of
the protection level analysis.
.. GENERATED FROM PYTHON SOURCE LINES 153-186
.. code-block:: Python
def create_legend_table():
"""Create a table showing the defined protection levels."""
protectionLevels = ['>{} dBm'.format(damage_threshold), '>{} dBm'.format(overload_threshold),
'>{} dBm'.format(intermod_threshold), '>{} dBm'.format(desense_threshold)]
fig = go.Figure(data=[go.Table(
header=dict(
values=['<b>Interference</b>','<b>Power Level Threshold</b>'],
line_color='darkslategray',
fill_color=header_color,
align=['left','center'],
font=dict(color='white',size=16)
),
cells=dict(
values=[['Damage','Overload','Intermodulation','Clear'], protectionLevels],
line_color='darkslategray',
fill_color=['white',['red','orange','yellow','green']],
align = ['left', 'center'],
font = dict(
color = ['darkslategray','black'],
size = 15)
)
)])
fig.update_layout(
title=dict(
text='Protection Levels (dBm)',
font=dict(color='darkslategray',size=20),
x = 0.5
),
width = 600
)
fig.show()
.. GENERATED FROM PYTHON SOURCE LINES 187-193
Create a scenario matrix view
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Create a scenario matrix view with the transmitters defined across the top
and receivers down the left-most column. The power at the input to each
receiver is shown in each cell of the matrix and color-coded based on the
protection level thresholds defined.
.. GENERATED FROM PYTHON SOURCE LINES 193-230
.. code-block:: Python
def create_scenario_view(emis, colors, tx_radios, rx_radios):
"""Create a scenario matrix-like table with the higher received
power for each Tx-Rx radio combination. The colors
used for the scenario matrix view are based on the highest
protection level that the received power exceeds."""
fig = go.Figure(data=[go.Table(
header=dict(
values=['<b>Tx/Rx</b>','<b>{}</b>'.format(tx_radios[0]),'<b>{}</b>'.format(tx_radios[1])],
line_color='darkslategray',
fill_color=header_color,
align=['left','center'],
font=dict(color='white',size=16)
),
cells=dict(
values=[
rx_radios,
emis[0],
emis[1]],
line_color='darkslategray',
fill_color=['white',colors[0], colors[1]],
align = ['left', 'center'],
font = dict(
color = ['darkslategray','black'],
size = 15)
)
)])
fig.update_layout(
title=dict(
text='Protection Levels (dBm)',
font=dict(color='darkslategray',size=20),
x = 0.5
),
width = 600
)
fig.show()
.. GENERATED FROM PYTHON SOURCE LINES 231-234
Get all the radios in the project
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Get lists of all transmitters and receivers in the project.
.. GENERATED FROM PYTHON SOURCE LINES 234-240
.. code-block:: Python
if os.getenv("PYAEDT_DOC_GENERATION", "False") != "1":
rev = emitapp.results.current_revision
rx_radios = rev.get_receiver_names()
tx_radios = rev.get_interferer_names(InterfererType.TRANSMITTERS)
domain = emitapp.results.interaction_domain()
.. GENERATED FROM PYTHON SOURCE LINES 241-246
Classify the results
~~~~~~~~~~~~~~~~~~~~
Iterate over all the transmitters and receivers and compute the power
at the input to each receiver due to each of the transmitters. Computes
which, if any, protection levels are exceeded by these power levels.
.. GENERATED FROM PYTHON SOURCE LINES 246-258
.. code-block:: Python
if os.getenv("PYAEDT_DOC_GENERATION", "False") != "1":
power_matrix=[]
all_colors=[]
all_colors, power_matrix = rev.protection_level_classification(domain, global_levels = protection_levels)
# Create a scenario matrix-like view for the protection levels
create_scenario_view(power_matrix, all_colors, tx_radios, rx_radios)
# Create a legend for the protection levels
create_legend_table()
.. GENERATED FROM PYTHON SOURCE LINES 259-264
Save project and close AEDT
~~~~~~~~~~~~~~~~~~~~~~~~~~~
After the simulation completes, you can close AEDT or release it using the
:func:`pyaedt.Desktop.force_close_desktop` method.
All methods provide for saving the project before closing.
.. GENERATED FROM PYTHON SOURCE LINES 264-267
.. code-block:: Python
emitapp.save_project()
emitapp.release_desktop(close_projects=True, close_desktop=True)
.. rst-class:: sphx-glr-script-out
.. code-block:: none
True
.. rst-class:: sphx-glr-timing
**Total running time of the script:** (0 minutes 39.690 seconds)
.. _sphx_glr_download_examples_07-EMIT_ComputeProtectionLevels.py:
.. only:: html
.. container:: sphx-glr-footer sphx-glr-footer-example
.. container:: sphx-glr-download sphx-glr-download-jupyter
:download:`Download Jupyter notebook: ComputeProtectionLevels.ipynb <ComputeProtectionLevels.ipynb>`
.. container:: sphx-glr-download sphx-glr-download-python
:download:`Download Python source code: ComputeProtectionLevels.py <ComputeProtectionLevels.py>`
.. only:: html
.. rst-class:: sphx-glr-signature
`Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_