docs: add missile-test-interference by apratilas · Pull Request #1051 · ansys/pystk

apratilas · 2026-07-13T15:34:55Z

New pySTK example. This example is based off of this tutorial.

New pySTK example.

- Path updates to work on Windows + Linux - examples.rst file update

jwinkle8

Thanks for your contributions @apratilas! I've left some comments to clean the example up a bit. Let me know if you have any questions. Thanks!

jwinkle8 · 2026-07-16T19:29:08Z

@@ -0,0 +1,658 @@
+# # CommRadar_MissileTest_Interference


The example title should describe the example's focus and be in title case. Can you adapt the STK tutorial title to make it more concise?

Let's also update the example file name accordingly when we make this change (make sure to update the path in examples.rst when you do this).

jwinkle8 · 2026-07-16T19:34:37Z

@@ -0,0 +1,658 @@
+# # CommRadar_MissileTest_Interference
+


Other PySTK examples derived from STK tutorials link to the corresponding tutorial page before the problem statement (example). We should add the same here.

jwinkle8 · 2026-07-16T19:39:25Z

+root = stk.new_object_root()
+root.new_scenario("CommRadar_MissileTest_Interference_SCRIPT")
+# from ansys.stk.core.stkdesktop import STKDesktop
+# stk = STKDesktop.start_application(visible=True)


Remove unused references to STKDesktop

jwinkle8 · 2026-07-16T19:40:02Z

+
+# +
+# root = stk.root
+# root.new_scenario("CommRadar_MissileTest_Interference_SCRIPT")


Remove commented code

jwinkle8 · 2026-07-16T19:43:50Z

+
+# -
+
+# +


Let's annotate this code block with a short blurb like this.

Same comment for the 2D map widget block too.

jwinkle8 · 2026-07-16T20:33:05Z

+globe_widget.show()
+# -
+
+# ## Analyzing the telemetry downlink's link budget (2)


Suggested change

# ## Analyzing the telemetry downlink's link budget (2)

# ## Analyzing the telemetry downlink's link budget

jwinkle8 · 2026-07-16T20:33:28Z

+interference.emitters.add(sxm_10_transmitter.path)
+# -
+
+# Determining the impact of interference with a Link Budget - Interference report (3)


Suggested change

# Determining the impact of interference with a Link Budget - Interference report (3)

# Determining the impact of interference with a Link Budget - Interference report

jwinkle8 · 2026-07-16T20:33:57Z

+access.compute_access()
+# -
+
+# ## Creating a custom report (5)


Suggested change

# ## Creating a custom report (5)

# ## Creating a custom report

jwinkle8 · 2026-07-16T20:34:26Z

+ship_receiver_filter.order = 4  # Unit
+# -
+
+# Recomputing the Link Budget - Interference report (4)


Suggested change

# Recomputing the Link Budget - Interference report (4)

# Recomputing the Link Budget - Interference report

jwinkle8 · 2026-07-16T20:39:54Z

+    scenario.start_time, scenario.stop_time, time_step
+).data_sets.to_pandas_dataframe()
+link_budget_report[["ber"]]
+root.save_scenario()


Remove save scenario commands from example

- Rename file to missile-interference-test for clarity - Rename file in examples.rst - Various code fixes

codecov-commenter · 2026-07-17T20:26:25Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.58%. Comparing base (0df29dd) to head (a34a673).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1051   +/-   ##
=======================================
  Coverage   89.58%   89.58%           
=======================================
  Files          67       67           
  Lines      190995   190995           
  Branches     1428     1428           
=======================================
+ Hits       171106   171108    +2     
+ Misses      19474    19472    -2     
  Partials      415      415

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

- Code narration + comments. - Couple of code fixes.

Link fix.

- Camera positioning coordinates - variable rename - link fix - removal of one globe_widget

Tutorial link fix.

MaxJPRey · 2026-07-23T12:58:01Z

+
+# ## Check for interference
+
+# There are several methods through which you can determine the impact of interference on a system. or less complex systems, like the one in this scenario, you can compute interference effects directly in a Receiver object.


Suggested change

# There are several methods through which you can determine the impact of interference on a system. or less complex systems, like the one in this scenario, you can compute interference effects directly in a Receiver object.

# There are several methods through which you can determine the impact of interference on a system. For less complex systems, like the one in this scenario, you can compute interference effects directly in a Receiver object.

MaxJPRey · 2026-07-23T12:58:22Z

+)
+# -
+
+# We have to enable interfernece before we are able to edit the interference sources:


Suggested change

# We have to enable interfernece before we are able to edit the interference sources:

# We have to enable interference before we are able to edit the interference sources:

MaxJPRey · 2026-07-23T13:01:44Z

+# -
+
+# Generate the link information report.
+


There's a closing # - but no opening # +

Suggested change

# +

MaxJPRey · 2026-07-23T13:02:06Z

+radar_transmitter.frequency = 2.8
+# -
+
+# Set the power of the radar transmitter. This is does not depend on frequency or wavelength.


Suggested change

# Set the power of the radar transmitter. This is does not depend on frequency or wavelength.

# Set the power of the radar transmitter. This does not depend on frequency or wavelength.

MaxJPRey · 2026-07-23T14:12:35Z

+
+
+receiver_model.antenna_control.embedded_model_component_linking.set_component("Helix")
+helixModel = receiver_model.antenna_control.embedded_model_component_linking.component


Could we use snake_case to follow the usual variable naming convention?

Typo fixes.

Variable rename to follow convention.

apratilas added 2 commits July 6, 2026 11:36

docs: CommRadar Interference

bf9aec1

New pySTK example.

docs: add link to example in example gallery

e61b9e1

apratilas requested a review from a team as a code owner July 13, 2026 15:34

Merge branch 'main' into docs/comm-radar-missile-interference

33136c9

github-actions Bot added the docs:examples Related to documentation examples label Jul 13, 2026

pyansys-ci-bot and others added 2 commits July 13, 2026 15:37

chore: adding changelog file 1051.documentation.md [dependabot-skip]

20fc144

docs: missile-test-interference

b0ff9b2

- Path updates to work on Windows + Linux - examples.rst file update

jwinkle8 requested changes Jul 16, 2026

View reviewed changes

docs: Missile Interference Test

d9c797b

- Rename file to missile-interference-test for clarity - Rename file in examples.rst - Various code fixes

apratilas added 4 commits July 20, 2026 17:31

docs: missile-interference-test

614833b

- Code narration + comments. - Couple of code fixes.

docs: missile-interference-test

d7fbeca

Link fix.

docs: missile-interference-test

f08df14

- Camera positioning coordinates - variable rename - link fix - removal of one globe_widget

docs: missile-interference-test

4b6430c

Tutorial link fix.

MaxJPRey reviewed Jul 23, 2026

View reviewed changes

apratilas added 2 commits July 23, 2026 10:30

docs: missile-interference-test

3826d87

Typo fixes.

docs: missile-interference-test

a34a673

Variable rename to follow convention.

	# ## Analyzing the telemetry downlink's link budget (2)
	# ## Analyzing the telemetry downlink's link budget

	# Determining the impact of interference with a Link Budget - Interference report (3)
	# Determining the impact of interference with a Link Budget - Interference report

	# ## Creating a custom report (5)
	# ## Creating a custom report

	# Recomputing the Link Budget - Interference report (4)
	# Recomputing the Link Budget - Interference report


		# ## Check for interference

		# There are several methods through which you can determine the impact of interference on a system. or less complex systems, like the one in this scenario, you can compute interference effects directly in a Receiver object.

	# We have to enable interfernece before we are able to edit the interference sources:
	# We have to enable interference before we are able to edit the interference sources:

	# Set the power of the radar transmitter. This is does not depend on frequency or wavelength.
	# Set the power of the radar transmitter. This does not depend on frequency or wavelength.



		receiver_model.antenna_control.embedded_model_component_linking.set_component("Helix")
		helixModel = receiver_model.antenna_control.embedded_model_component_linking.component

Uh oh!

Conversation

apratilas commented Jul 13, 2026

Uh oh!

jwinkle8 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov-commenter commented Jul 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

codecov-commenter commented Jul 17, 2026 •

edited

Loading