Added Pre-Defined Scenarios and Example Scripts

- Created 4 pre-defined radar plotting scenarios
- Added  example
- Added  example with radar plot
- All scenarios use consistent data format

Author: osyounis

examples/animated_plot.py

@@ -0,0 +1,32 @@
+"""
+Plotting Example: Displays a radar plot solution. with matplotlib
+
+Author: Omar Younis
+Date: 30/10/2025    [dd/mm/yyyy]
+"""
+
+from radar_plotter.models import RadarPoint, RadarProblem
+from radar_plotter.solver import solver_radar_problem
+from radar_plotter.plotting.radar_plot import plot_radar_solution
+
+
+def main():
+    # Defines a problem
+    problem = RadarProblem (
+        our_course=0.0,
+        our_speed=10.0,
+        maneuver_dist=5.0,
+        new_cpa_dist=2.5,
+        r_point=RadarPoint(45.0, 11.5, "14:00"),
+        m_point=RadarPoint(43.0, 9.0, "14:06")
+    )
+
+    # Solution to the problem
+    solution = solver_radar_problem(problem)
+
+    # Plot the solution (this will display the plot with the vector arrows)
+    plot_radar_solution(problem, solution, show=True)
+
+
+if __name__ == "__main__":
+    main()

examples/basic_calculation.py

@@ -0,0 +1,39 @@
+"""
+Basic example: Calculate a radar plotting solution.
+
+Author: Omar Younis
+Date: 30/10/2025    [dd/mm/yyyy]
+"""
+
+from radar_plotter.models import RadarPoint, RadarProblem
+from radar_plotter.solver import solver_radar_problem
+
+
+def main():
+    # Define the problem to solve
+    problem = RadarProblem(
+        our_course=0.0,
+        our_speed=10.0,
+        maneuver_dist=5.0,
+        new_cpa_dist=2.5,
+        r_point=RadarPoint(45.0, 11.5, "14:00"),
+        m_point=RadarPoint(43.0, 9.0, "14:06")
+    )
+
+    # Solve the problem
+    solution = solver_radar_problem(problem)
+
+    # Print results
+    print("===== Collision Avoidance Radar Plot Solution =====\n")
+    print(f"CPA: {solution.cpa_range:.1f} NM at bearing {solution.cpa_bearing:06.2f}°")
+    print(f"Time to CPA: {solution.cpa_time.strftime('%H:%M')}")
+    print("\nRelative Motion:")
+    print(f"    SRM: {solution.srm:.1f} kts")
+    print(f"    DRM: {solution.drm:06.2f}°")
+    print("\nRecommended Maneuver:")
+    print(f"    New Course: {solution.new_course:06.2f}°")
+    print(f"    New Speed: {solution.new_speed:.1f} kts")
+
+
+if __name__ == "__main__":
+    main()

src/radar_plotter/scenarios.py

@@ -0,0 +1,52 @@
+"""
+Pre-defined radar plotting scenarios for testing and examples.
+
+Author: Omar Younis
+Date: 30/10/2025    [dd/mm/yyyy]
+"""
+
+from .models import RadarProblem, RadarPoint
+
+
+# Example scenario from the default values from the Streamlit app
+SCENARIO_1 = RadarProblem(
+    our_course=0.0,
+    our_speed=10.0,
+    maneuver_dist=5.0,
+    new_cpa_dist=5.0,
+    r_point=RadarPoint(45.0, 11.5, "14:00"),
+    m_point=RadarPoint(43.0, 9.0, "14:06")
+)
+
+# Another scenario
+SCENARIO_2 = RadarProblem(
+    our_course=90.0,
+    our_speed=15.0,
+    maneuver_dist=6.0,
+    new_cpa_dist=3.0,
+    r_point=RadarPoint(45.0, 12.0, "10:00"),
+    m_point=RadarPoint(42.0, 9.5, "10:08")
+)
+
+# Head-on scenario
+SCENARIO_3 = RadarProblem(
+    our_course=0.0,
+    our_speed=18.0,
+    maneuver_dist=4.0,
+    new_cpa_dist=2.5,
+    r_point=RadarPoint(0.0, 10.0, "08:00"),
+    m_point=RadarPoint(358.0, 7.5, "08:05")
+)
+
+# Crossing bow scenario
+SCENARIO_4 = RadarProblem(
+    our_course=270.0,
+    our_speed=12.0,
+    maneuver_dist=5.5,
+    new_cpa_dist=3.0,
+    r_point=RadarPoint(315.0, 8.0, "16:00"),
+    m_point=RadarPoint(320.0, 6.0, "16:10")
+)
+
+# List of all scenarios
+ALL_SCENARIOS = [SCENARIO_1, SCENARIO_2, SCENARIO_3, SCENARIO_4]