handoverlab 2.3.0__tar.gz → 2.4.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (293) hide show
  1. handoverlab-2.4.1/.zenodo.json +39 -0
  2. {handoverlab-2.3.0 → handoverlab-2.4.1}/CHANGELOG.md +78 -1
  3. {handoverlab-2.3.0 → handoverlab-2.4.1}/CITATION.cff +12 -6
  4. {handoverlab-2.3.0 → handoverlab-2.4.1}/PKG-INFO +76 -15
  5. {handoverlab-2.3.0 → handoverlab-2.4.1}/README.md +75 -14
  6. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/calibration-3gpp.md +56 -2
  7. handoverlab-2.4.1/docs/comparison.md +199 -0
  8. handoverlab-2.4.1/docs/guides/ai-mobility.md +182 -0
  9. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/guides/scheduler.md +5 -3
  10. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/guides/suburban-o2i.md +3 -2
  11. handoverlab-2.4.1/docs/guides/ue-beams.md +93 -0
  12. handoverlab-2.4.1/docs/images/ai-mobility.png +0 -0
  13. handoverlab-2.4.1/docs/images/calibration_7ghz.png +0 -0
  14. handoverlab-2.4.1/docs/images/new-scenarios.png +0 -0
  15. handoverlab-2.4.1/docs/images/report-comparison.png +0 -0
  16. handoverlab-2.4.1/docs/images/report-tuning.png +0 -0
  17. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/index.md +1 -1
  18. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/performance.md +41 -0
  19. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/standard-compliance.md +47 -2
  20. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/tutorials/first-run.md +13 -8
  21. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/tutorials/reading-the-report.md +25 -23
  22. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/tutorials/tuning-study.md +43 -25
  23. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/user_guide.md +2 -2
  24. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/verification.md +2 -1
  25. {handoverlab-2.3.0 → handoverlab-2.4.1}/examples/study_smoke.yaml +1 -1
  26. {handoverlab-2.3.0 → handoverlab-2.4.1}/mkdocs.yml +3 -0
  27. {handoverlab-2.3.0 → handoverlab-2.4.1}/pyproject.toml +1 -1
  28. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/__init__.py +1 -1
  29. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/channel/antenna.py +50 -3
  30. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/channel/extended.py +114 -4
  31. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/config.py +63 -3
  32. handoverlab-2.4.1/src/handoverlab/engine/_kernels.py +238 -0
  33. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/engine/core.py +3 -0
  34. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/engine/extended.py +57 -5
  35. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/engine/scheduler.py +125 -0
  36. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/rules/__init__.py +6 -4
  37. handoverlab-2.4.1/src/handoverlab/rules/predict.py +588 -0
  38. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/seeds.py +13 -11
  39. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/standard.py +1 -0
  40. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/verify/__init__.py +5 -3
  41. handoverlab-2.4.1/src/handoverlab/verify/aimobility.py +56 -0
  42. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/verify/calibration.py +171 -14
  43. handoverlab-2.4.1/src/handoverlab/verify/data/r1_2506406.csv +607 -0
  44. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/verify/learning.py +5 -0
  45. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab.egg-info/PKG-INFO +76 -15
  46. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab.egg-info/SOURCES.txt +15 -0
  47. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/data/public_api.json +1 -0
  48. handoverlab-2.4.1/tests/test_ai_mobility.py +123 -0
  49. handoverlab-2.4.1/tests/test_calibration.py +167 -0
  50. handoverlab-2.4.1/tests/test_sched_kernel.py +130 -0
  51. handoverlab-2.4.1/tests/test_ue_beams.py +162 -0
  52. handoverlab-2.4.1/tools/make_ai_mobility_figure.py +111 -0
  53. handoverlab-2.4.1/tools/make_calibration_7ghz_figure.py +90 -0
  54. handoverlab-2.4.1/tools/make_scenarios_figure.py +136 -0
  55. handoverlab-2.3.0/.zenodo.json +0 -34
  56. handoverlab-2.3.0/docs/images/report-comparison.png +0 -0
  57. handoverlab-2.3.0/docs/images/report-tuning.png +0 -0
  58. handoverlab-2.3.0/src/handoverlab/engine/_kernels.py +0 -78
  59. handoverlab-2.3.0/tests/test_calibration.py +0 -81
  60. {handoverlab-2.3.0 → handoverlab-2.4.1}/CODE_OF_CONDUCT.md +0 -0
  61. {handoverlab-2.3.0 → handoverlab-2.4.1}/CONTRIBUTING.md +0 -0
  62. {handoverlab-2.3.0 → handoverlab-2.4.1}/LICENSE +0 -0
  63. {handoverlab-2.3.0 → handoverlab-2.4.1}/MANIFEST.in +0 -0
  64. {handoverlab-2.3.0 → handoverlab-2.4.1}/SECURITY.md +0 -0
  65. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/RELEASING.md +0 -0
  66. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/calibration.md +0 -0
  67. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/guides/add-scenario.md +0 -0
  68. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/guides/beams-layers.md +0 -0
  69. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/guides/buffers.md +0 -0
  70. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/guides/daps-ltm.md +0 -0
  71. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/guides/dashboard.md +0 -0
  72. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/guides/dual-connectivity.md +0 -0
  73. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/guides/export-event-logs.md +0 -0
  74. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/guides/fading.md +0 -0
  75. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/guides/high-speed-train.md +0 -0
  76. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/guides/highway.md +0 -0
  77. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/guides/indoor-rural.md +0 -0
  78. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/guides/learning-rule.md +0 -0
  79. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/guides/many-cores.md +0 -0
  80. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/guides/mro.md +0 -0
  81. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/guides/ntn.md +0 -0
  82. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/guides/radio-maps.md +0 -0
  83. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/guides/reproduce.md +0 -0
  84. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/guides/upper-mid-band.md +0 -0
  85. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/images/calibration_38901.png +0 -0
  86. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/images/dashboard-charts.png +0 -0
  87. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/images/dashboard-compare.png +0 -0
  88. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/images/dashboard-where.png +0 -0
  89. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/images/dashboard.png +0 -0
  90. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/images/ntn-beams.png +0 -0
  91. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/images/radio-map.png +0 -0
  92. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/images/ssb-beams.png +0 -0
  93. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/migration-2.0.md +0 -0
  94. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/reference/api/config.md +0 -0
  95. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/reference/api/engine.md +0 -0
  96. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/reference/api/eventlog.md +0 -0
  97. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/reference/api/gui.md +0 -0
  98. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/reference/api/index.md +0 -0
  99. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/reference/api/mapfile.md +0 -0
  100. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/reference/api/ntn.md +0 -0
  101. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/reference/api/rules.md +0 -0
  102. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/reference/api/scenarios.md +0 -0
  103. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/reference/api/simulate.md +0 -0
  104. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/reference/api/stability.md +0 -0
  105. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/reference/api/stats.md +0 -0
  106. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/reference/api/studies.md +0 -0
  107. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/reference/api/testing.md +0 -0
  108. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/reference/api/verify.md +0 -0
  109. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/reference/cli.md +0 -0
  110. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/reference/metrics.md +0 -0
  111. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/reference-study.md +0 -0
  112. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/scenarios/dense-urban-2layer.md +0 -0
  113. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/scenarios/dense-urban-2layer.svg +0 -0
  114. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/scenarios/fr3-urban-15ghz.md +0 -0
  115. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/scenarios/fr3-urban-15ghz.svg +0 -0
  116. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/scenarios/highway-tr37885-30ghz.md +0 -0
  117. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/scenarios/highway-tr37885-30ghz.svg +0 -0
  118. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/scenarios/highway-tr37885-4ghz.md +0 -0
  119. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/scenarios/highway-tr37885-4ghz.svg +0 -0
  120. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/scenarios/hst-fr2-28ghz.md +0 -0
  121. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/scenarios/hst-fr2-28ghz.svg +0 -0
  122. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/scenarios/indoor-office-4ghz.md +0 -0
  123. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/scenarios/indoor-office-4ghz.svg +0 -0
  124. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/scenarios/ns3-urban-3.5ghz.md +0 -0
  125. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/scenarios/ns3-urban-3.5ghz.svg +0 -0
  126. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/scenarios/ntn-leo600-2ghz.md +0 -0
  127. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/scenarios/ntn-leo600-2ghz.svg +0 -0
  128. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/scenarios/open-area-10ghz.md +0 -0
  129. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/scenarios/open-area-10ghz.svg +0 -0
  130. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/scenarios/rural-700mhz.md +0 -0
  131. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/scenarios/rural-700mhz.svg +0 -0
  132. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/scenarios/smoke.md +0 -0
  133. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/scenarios/smoke.svg +0 -0
  134. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/scenarios/suburban-sma-7ghz.md +0 -0
  135. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/scenarios/suburban-sma-7ghz.svg +0 -0
  136. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/scenarios/urban-grid-10ghz.md +0 -0
  137. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/scenarios/urban-grid-10ghz.svg +0 -0
  138. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/scenarios/urban-grid-28ghz-beams.md +0 -0
  139. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/scenarios/urban-grid-28ghz-beams.svg +0 -0
  140. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/scenarios/urban-macro-tr37885-4ghz.md +0 -0
  141. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/scenarios/urban-macro-tr37885-4ghz.svg +0 -0
  142. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/stability.md +0 -0
  143. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/time-step.md +0 -0
  144. {handoverlab-2.3.0 → handoverlab-2.4.1}/docs/tutorials/own-rule.md +0 -0
  145. {handoverlab-2.3.0 → handoverlab-2.4.1}/examples/compare_a3_cho.py +0 -0
  146. {handoverlab-2.3.0 → handoverlab-2.4.1}/examples/open_area.toml +0 -0
  147. {handoverlab-2.3.0 → handoverlab-2.4.1}/examples/radio_map.py +0 -0
  148. {handoverlab-2.3.0 → handoverlab-2.4.1}/examples/smoke.yaml +0 -0
  149. {handoverlab-2.3.0 → handoverlab-2.4.1}/examples/speed_rule.py +0 -0
  150. {handoverlab-2.3.0 → handoverlab-2.4.1}/examples/street_grid.yaml +0 -0
  151. {handoverlab-2.3.0 → handoverlab-2.4.1}/examples/study_reference.yaml +0 -0
  152. {handoverlab-2.3.0 → handoverlab-2.4.1}/examples/study_reference_explore.yaml +0 -0
  153. {handoverlab-2.3.0 → handoverlab-2.4.1}/examples/traffic_models.py +0 -0
  154. {handoverlab-2.3.0 → handoverlab-2.4.1}/setup.cfg +0 -0
  155. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/__main__.py +0 -0
  156. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/channel/__init__.py +0 -0
  157. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/channel/fading.py +0 -0
  158. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/channel/l2s.py +0 -0
  159. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/channel/ntn.py +0 -0
  160. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/channel/pathloss.py +0 -0
  161. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/channel/radiomap.py +0 -0
  162. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/channel/source.py +0 -0
  163. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/cli.py +0 -0
  164. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/engine/__init__.py +0 -0
  165. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/engine/batch.py +0 -0
  166. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/engine/buffers.py +0 -0
  167. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/engine/dual.py +0 -0
  168. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/engine/invariants.py +0 -0
  169. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/engine/metrics.py +0 -0
  170. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/engine/procedures.py +0 -0
  171. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/eventlog.py +0 -0
  172. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/gui/__init__.py +0 -0
  173. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/gui/app.py +0 -0
  174. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/gui/logic.py +0 -0
  175. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/io.py +0 -0
  176. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/layout.py +0 -0
  177. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/linklevel.py +0 -0
  178. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/mapfile.py +0 -0
  179. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/measurement.py +0 -0
  180. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/mobility.py +0 -0
  181. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/py.typed +0 -0
  182. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/requirements.py +0 -0
  183. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/rules/base.py +0 -0
  184. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/rules/builtin.py +0 -0
  185. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/rules/dqn.py +0 -0
  186. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/rules/mro.py +0 -0
  187. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/scenarios/__init__.py +0 -0
  188. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/scenarios/cards/dense-urban-2layer.yaml +0 -0
  189. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/scenarios/cards/fr3-urban-15ghz.yaml +0 -0
  190. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/scenarios/cards/highway-tr37885-30ghz.yaml +0 -0
  191. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/scenarios/cards/highway-tr37885-4ghz.yaml +0 -0
  192. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/scenarios/cards/hst-fr2-28ghz.yaml +0 -0
  193. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/scenarios/cards/indoor-office-4ghz.yaml +0 -0
  194. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/scenarios/cards/ns3-urban-3.5ghz.yaml +0 -0
  195. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/scenarios/cards/ntn-leo600-2ghz.yaml +0 -0
  196. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/scenarios/cards/open-area-10ghz.yaml +0 -0
  197. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/scenarios/cards/rural-700mhz.yaml +0 -0
  198. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/scenarios/cards/smoke.yaml +0 -0
  199. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/scenarios/cards/suburban-sma-7ghz.yaml +0 -0
  200. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/scenarios/cards/urban-grid-10ghz.yaml +0 -0
  201. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/scenarios/cards/urban-grid-28ghz-beams.yaml +0 -0
  202. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/scenarios/cards/urban-macro-tr37885-4ghz.yaml +0 -0
  203. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/simulate.py +0 -0
  204. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/stability.py +0 -0
  205. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/stats.py +0 -0
  206. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/studies/__init__.py +0 -0
  207. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/studies/config.py +0 -0
  208. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/studies/report.py +0 -0
  209. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/studies/runner.py +0 -0
  210. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/studies/status.py +0 -0
  211. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/studies/store.py +0 -0
  212. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/studies/study.py +0 -0
  213. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/studies/tuning.py +0 -0
  214. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/testing.py +0 -0
  215. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/traffic.py +0 -0
  216. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/verify/data/golden.json +0 -0
  217. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/verify/data/golden_1x.json +0 -0
  218. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/verify/data/ns3_urban_a3.json +0 -0
  219. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/verify/data/r1_165974.csv +0 -0
  220. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/verify/engine_checks.py +0 -0
  221. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/verify/extended.py +0 -0
  222. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/verify/fading.py +0 -0
  223. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/verify/golden.py +0 -0
  224. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/verify/highway.py +0 -0
  225. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/verify/ns3.py +0 -0
  226. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/verify/ntn.py +0 -0
  227. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/verify/radio.py +0 -0
  228. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/verify/report.py +0 -0
  229. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/verify/scenarios.py +0 -0
  230. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/verify/stored.py +0 -0
  231. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/verify/values.py +0 -0
  232. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab/world.py +0 -0
  233. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab.egg-info/dependency_links.txt +0 -0
  234. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab.egg-info/entry_points.txt +0 -0
  235. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab.egg-info/requires.txt +0 -0
  236. {handoverlab-2.3.0 → handoverlab-2.4.1}/src/handoverlab.egg-info/top_level.txt +0 -0
  237. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/conftest.py +0 -0
  238. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/data/bh6_reference.json +0 -0
  239. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/data/bh6_wide.json +0 -0
  240. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/data/make_bh6_reference.py +0 -0
  241. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/data/make_bh6_wide.py +0 -0
  242. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/helpers.py +0 -0
  243. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_batch.py +0 -0
  244. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_beams_layers.py +0 -0
  245. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_buffers.py +0 -0
  246. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_channel_detail.py +0 -0
  247. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_cltm.py +0 -0
  248. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_config_cli.py +0 -0
  249. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_contract.py +0 -0
  250. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_determinism.py +0 -0
  251. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_dqn.py +0 -0
  252. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_engine_triggers.py +0 -0
  253. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_eventlog.py +0 -0
  254. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_fading.py +0 -0
  255. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_gui.py +0 -0
  256. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_highway.py +0 -0
  257. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_highway_tr37885.py +0 -0
  258. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_hst_dc.py +0 -0
  259. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_indoor_rural.py +0 -0
  260. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_invariants.py +0 -0
  261. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_levels_status_extend.py +0 -0
  262. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_lm_model.py +0 -0
  263. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_mapfile.py +0 -0
  264. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_measurement.py +0 -0
  265. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_mro.py +0 -0
  266. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_ntn.py +0 -0
  267. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_pathloss.py +0 -0
  268. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_protocol_3gpp.py +0 -0
  269. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_readme_boundaries.py +0 -0
  270. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_regression_bh6.py +0 -0
  271. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_regression_bh6_wide.py +0 -0
  272. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_rrc_detail.py +0 -0
  273. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_rules_rc2.py +0 -0
  274. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_scenarios.py +0 -0
  275. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_scenarios_230.py +0 -0
  276. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_scheduler.py +0 -0
  277. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_signalling_energy.py +0 -0
  278. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_stability.py +0 -0
  279. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_stats.py +0 -0
  280. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_study.py +0 -0
  281. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_tools.py +0 -0
  282. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_traffic.py +0 -0
  283. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_tuning.py +0 -0
  284. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_v111.py +0 -0
  285. {handoverlab-2.3.0 → handoverlab-2.4.1}/tests/test_verify.py +0 -0
  286. {handoverlab-2.3.0 → handoverlab-2.4.1}/tools/compare_fingerprints.py +0 -0
  287. {handoverlab-2.3.0 → handoverlab-2.4.1}/tools/make_beam_figure.py +0 -0
  288. {handoverlab-2.3.0 → handoverlab-2.4.1}/tools/make_calibration_figure.py +0 -0
  289. {handoverlab-2.3.0 → handoverlab-2.4.1}/tools/make_ntn_figure.py +0 -0
  290. {handoverlab-2.3.0 → handoverlab-2.4.1}/tools/make_radiomap_figure.py +0 -0
  291. {handoverlab-2.3.0 → handoverlab-2.4.1}/tools/make_readme_images.py +0 -0
  292. {handoverlab-2.3.0 → handoverlab-2.4.1}/tools/mkdocs_hooks.py +0 -0
  293. {handoverlab-2.3.0 → handoverlab-2.4.1}/tools/release_check.py +0 -0
@@ -0,0 +1,39 @@
1
+ {
2
+ "title": "HandoverLab: system-level handover simulator for 5G-Advanced and beyond-5G research",
3
+ "description": "HandoverLab is an open-source, system-level simulator of 3GPP mobility procedures (baseline handover with Event A3, Release-16 conditional and DAPS handover, Release-18 L1/L2-triggered mobility, conditional handover with the location events of Release 18, dual connectivity) for many users in dense 5G-Advanced and beyond-5G networks, on a street grid, in an open area, along a highway or a high-speed railway, in an indoor office, in suburban and rural macro cells or under the earth-moving beams of a LEO satellite. It provides a TR 38.901 received-power radio model (TR 38.811 for the satellite) with optional TDL fast fading, SSB and UE receive beams and several carriers, an optional slot scheduler with MCS, TBS and HARQ and user-plane buffers at handover, an L3-filtered measurement chain, a radio-link failure model, an outcome label for every handover attempt, a plug-in interface for handover rules (including a measurement-prediction rule after TR 38.744), equal-budget tuning studies with paired statistics, and verification against hand-computed values, golden event-log fingerprints, the 3GPP large-scale calibration and ns-3 / 5G-LENA.",
4
+ "upload_type": "software",
5
+ "access_right": "open",
6
+ "license": "MIT",
7
+ "creators": [
8
+ {
9
+ "name": "Jalili Sanjarani, Mostafa"
10
+ },
11
+ {
12
+ "name": "Elmi Sola, Yasser"
13
+ }
14
+ ],
15
+ "keywords": [
16
+ "handover",
17
+ "conditional handover",
18
+ "mobility",
19
+ "mobility robustness",
20
+ "radio-link failure",
21
+ "system-level simulation",
22
+ "5G",
23
+ "beyond 5G",
24
+ "3GPP",
25
+ "Python",
26
+ "dual connectivity",
27
+ "fast fading",
28
+ "beam management",
29
+ "NTN",
30
+ "AI/ML mobility"
31
+ ],
32
+ "related_identifiers": [
33
+ {
34
+ "identifier": "https://github.com/mjs19971997/handoverlab",
35
+ "relation": "isSupplementTo",
36
+ "scheme": "url"
37
+ }
38
+ ]
39
+ }
@@ -7,6 +7,81 @@ All notable changes to this project are documented in this file. The format foll
7
7
 
8
8
  ## [Unreleased]
9
9
 
10
+ ## [2.4.1] - 2026-10-22
11
+
12
+ No change of results.
13
+
14
+ ### Fixed
15
+
16
+ - `examples/study_smoke.yaml`: up to four grid extensions (`max_extensions: 4`); with two the example study
17
+ stopped at the `grid_edge` gate under the 3GPP defaults of 2.x.
18
+
19
+ ### Documentation
20
+
21
+ - README: pictures of the 7 GHz calibration, the new scenario cards and predicted measurements; what is new
22
+ in 2.1.0-2.4.0, the roadmap, the lower-layer options; the citation with the DOI of 2.4.0 and a BibTeX entry.
23
+ - `CITATION.cff` and `.zenodo.json`: description and keywords of the current features.
24
+ - Tutorials 1, 3 and 4 and the report pictures rerun with 2.4.0; status lines name the current release.
25
+
26
+ ## [2.4.0] - 2026-10-22
27
+
28
+ ### Added
29
+
30
+ - 7 GHz large-scale calibration (TR 38.901 V19.5.0 clause 7.8.1, Table 7.8-1A) in the `verify` group
31
+ `calibration`: UMa and UMi at 7 GHz, UMa and UMi at 6 GHz with the updated model, and SMa with ISD 1299 m and
32
+ 1732 m (35 m sites with a mechanical downtilt of 95 / 92 deg through Eqs. 7.1-7 and 7.1-8, 20 % of the users
33
+ in cars with the car penetration loss, 80 % in residential and commercial buildings over their floors with the
34
+ low-loss A model), compared with the companies of 3GPP R1-2506406 (RAN1 #122; mean and range in
35
+ `verify/data/r1_2506406.csv`). Pre-registered result (30 000 users, seed 1): every percentile 5-95 % lies
36
+ inside the company range (18 of 18 case-metric pairs pass, 342 of 342 percentiles); the largest distance from
37
+ the company mean is 1.65-2.88 dB, so the second criterion (at most 1.5 dB) fails for all six cases. It is
38
+ reported as a note. The checks against R1-165974 are unchanged. `simulate_drops` takes the IRR-glass loss of
39
+ the case's reference when `irr_glass` is not given (unchanged for the old cases).
40
+ - Compiled slot scheduler: with `run.backend: numba` (`pip install handoverlab[fast]`) the slots of
41
+ `protocol.scheduler` are played by a compiled loop (`handoverlab.engine._kernels.sched_slots`). The MCS
42
+ look-ups, logarithms and block error probabilities still come from the NumPy functions of the reference loop
43
+ (per-interval tables), and the loop uses only basic arithmetic in the reference order, so every result is
44
+ bit-identical to the NumPy loop (`tests/test_sched_kernel.py`, which also runs the loop's logic as plain Python
45
+ without Numba). On the ns-3 card the engine time with the scheduler drops by a factor of 8 to 60 (case and machine load) (about 3 times the rate model instead of 50-80 times; see `docs/performance.md`). The NumPy loop stays the reference and the default and runs in debug mode.
46
+ - UE receive beams as an option of the beam model (`radio.beams.ue_panels` 1, 2 or 4, off by default): UE panels
47
+ of TR 38.802 V14.2.0 Table A.2.1-4 (Config 1: two panels 180 deg apart, Config 2: four at 90 deg; `ue_panel`
48
+ [M, N] = [2, 4] at half a wavelength, one polarisation) with the element of Table A.2.1-8 (model 1, 5 dBi;
49
+ = ITU-R M.2412-0 Table 11), `ue_beams` DFT receive beams per panel over `ue_beam_span_deg`, bearing uniform
50
+ per UE (`ue_orientation: random`) or along the direction of travel (`heading`). Measurements use the best
51
+ receive beam of the best panel (`ue_rx: best`; TS 38.215 5.1.1 receiver branches) or a sweep over the beams,
52
+ one per L1 instant, with the highest of the last samples reported (`sweep`); data, RLM, beam failure
53
+ detection and recovery and the interference use the serving receive beam. The FR2 time scaling of the sweep
54
+ was already in `protocol.meas_periods: ts38133` (Mmeas_period_w/o_gaps = 24, TS 38.133 V19.6.0 9.2.5.1) and is
55
+ not applied twice; `sweep` is refused with `ts38133`. New random stream `ue_beams`. Not combined with
56
+ `protocol.dc`. With the option off every result is unchanged. Guide: `docs/guides/ue-beams.md`.
57
+ - AI/ML-based mobility after 3GPP TR 38.744 V19.0.1 (Release 19) as an optional rule, `a3_pred` (NumPy only, off
58
+ unless a run names it): prediction of the L3 cell-level RSRP of a cell from its own past L3 results (RRM
59
+ sub-use case 2), in case A (prediction window ahead; handover on the predicted Event A3, handover model
60
+ option 2 with the preparation started at the report) and case B (measurement skipping with MRRT =
61
+ skip / (skip + 1), L3 filtering options 1-3, Event A3 on the measured-and-predicted series, option 3).
62
+ Predictors: sample and hold (the non-AI baseline of TR 38.744 clause 5.1) and a ridge-regression
63
+ autoregressive model trained on runs of training seeds (`handoverlab.rules.predict.fit_predictor`,
64
+ `collect`, JSON weights), or a user object. Statistics after a run (`PredA3.stats`, `Recorder`): prediction
65
+ accuracy per horizon against the fully measured L3 result, MRRT, and the counters n1, n2, n3 and F1 score of
66
+ the indirect A3 event prediction (clause 5.3.1). With `act: false` and in case B without skipping the rule
67
+ gives the event log of `a3`. `handoverlab verify --only learning` gained four checks (P1-P4). Guide
68
+ `docs/guides/ai-mobility.md` with the evaluation against TR 38.744 and what is not modelled (RLF
69
+ prediction, frequency- and spatial-domain prediction, beam-level prediction, option 1, LCM); compliance rows
70
+ in `docs/standard-compliance.md`. Pre-registered evaluation (FR1 case B, FR2 case A): ridge more accurate
71
+ than sample and hold, errors rising with speed, PW and MRRT as TR 38.744 observes; MRRT 50 % costs
72
+ +0.7-0.9 percentage points of HOF rate; option 2 cuts the HOF rate from 2.4 % to 0.3 % but with 55 % more
73
+ attempts and three times the ping-pongs, and sample and hold does the same; generalization criterion G2
74
+ failed. Every existing result is unchanged.
75
+
76
+ ### Documentation
77
+
78
+ - `docs/comparison.md`: HandoverLab next to ns-3 with 5G-LENA and the mmWave module, Simu5G, the Vienna 5G System
79
+ Level Simulator, the MATLAB 5G Toolbox, OpenAirInterface and Sionna on the points that matter for handover
80
+ studies (A3, CHO, DAPS, LTM, radio-link failure, dual connectivity, NTN, beams, fast fading and link-to-system
81
+ mapping, scheduler, speed and scale, licence, language, last release, validation against 3GPP). Every cell
82
+ about another tool cites its official documentation, repository or paper (accessed 2026-10-22); facts not
83
+ found are marked "not stated"; a section lists where the other tools are stronger.
84
+
10
85
  ## [2.3.0] - 2026-10-22
11
86
 
12
87
  ### Added
@@ -1005,7 +1080,9 @@ First alpha release (stage 1: the core simulator).
1005
1080
  - Documentation: README, user guide, contribution guide, citation file; CI on Linux, Windows and
1006
1081
  macOS with Python 3.9-3.12.
1007
1082
 
1008
- [Unreleased]: https://github.com/mjs19971997/handoverlab/compare/v2.3.0...HEAD
1083
+ [Unreleased]: https://github.com/mjs19971997/handoverlab/compare/v2.4.1...HEAD
1084
+ [2.4.1]: https://github.com/mjs19971997/handoverlab/compare/v2.4.0...v2.4.1
1085
+ [2.4.0]: https://github.com/mjs19971997/handoverlab/compare/v2.3.0...v2.4.0
1009
1086
  [2.3.0]: https://github.com/mjs19971997/handoverlab/compare/v2.2.0...v2.3.0
1010
1087
  [2.2.0]: https://github.com/mjs19971997/handoverlab/compare/v2.1.0...v2.2.0
1011
1088
  [2.1.0]: https://github.com/mjs19971997/handoverlab/compare/v2.0.0...v2.1.0
@@ -6,12 +6,15 @@ abstract: >-
6
6
  handover with Event A3, Release-16 conditional and DAPS handover, Release-18 L1/L2-triggered
7
7
  mobility, conditional handover with the location events of Release 18) for many users in dense
8
8
  5G and beyond-5G networks, on a street grid, in an open area, along a highway, indoors, in rural
9
- cells or under the earth-moving beams of a LEO satellite. It provides a TR 38.901 received-power
10
- radio model (TR 38.811 for the satellite), an L3-filtered
11
- measurement chain, a radio-link failure model, an outcome label for every handover attempt,
12
- a plug-in interface for handover rules, equal-budget tuning studies with paired statistics,
13
- and verification against hand-computed values, golden event-log fingerprints and ns-3 / 5G-LENA.
14
- version: "2.3.0"
9
+ cells, along a high-speed railway or under the earth-moving beams of a LEO satellite. It provides a
10
+ TR 38.901 received-power radio model (TR 38.811 for the satellite) with optional TDL fast fading,
11
+ SSB and UE receive beams, several carriers and dual connectivity, an optional slot scheduler with
12
+ MCS, TBS and HARQ and user-plane buffers at handover, an L3-filtered measurement chain, a
13
+ radio-link failure model, an outcome label for every handover attempt, a plug-in interface for
14
+ handover rules (including a measurement-prediction rule after TR 38.744), equal-budget tuning
15
+ studies with paired statistics, and verification against hand-computed values, golden event-log
16
+ fingerprints, the 3GPP large-scale calibration and ns-3 / 5G-LENA.
17
+ version: "2.4.1"
15
18
  doi: 10.5281/zenodo.23409131
16
19
  identifiers:
17
20
  - type: doi
@@ -23,6 +26,9 @@ identifiers:
23
26
  - type: doi
24
27
  value: 10.5281/zenodo.23409402
25
28
  description: "Version 1.0.1 on Zenodo"
29
+ - type: doi
30
+ value: 10.5281/zenodo.23582521
31
+ description: "Version 2.4.0 on Zenodo"
26
32
  date-released: 2026-10-22
27
33
  license: MIT
28
34
  repository-code: "https://github.com/mjs19971997/handoverlab"
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: handoverlab
3
- Version: 2.3.0
3
+ Version: 2.4.1
4
4
  Summary: System-level handover simulator for 5G-Advanced and beyond-5G research
5
5
  Author: Mostafa Jalili Sanjarani, Yasser Elmi Sola
6
6
  License-Expression: MIT
@@ -70,7 +70,7 @@ received-power-level radio model from TR 38.901 (TR 38.811 for the satellite) (o
70
70
  and several carriers), an L3-filtered measurement chain, a radio-link failure model, and an
71
71
  outcome label for every handover attempt.
72
72
 
73
- > **Status: 2.0.0** (`python -m pip install handoverlab`). The public surface (configuration and
73
+ > **Status: 2.4.1** (`python -m pip install handoverlab`). The public surface (configuration and
74
74
  > result formats with a schema version, the rule interface, metric names, commands and the
75
75
  > documented Python names) follows the [stability policy](https://github.com/mjs19971997/handoverlab/blob/main/docs/stability.md): within 2.x it only grows,
76
76
  > and anything removed is deprecated first. 2.0.0 makes the 3GPP values the defaults (the protocol profile,
@@ -137,6 +137,19 @@ event D2 of Release 18:
137
137
 
138
138
  ![The 19 beams on the ground at the start and end of a run, and the received power of each beam at one user](https://raw.githubusercontent.com/mjs19971997/handoverlab/main/docs/images/ntn-beams.png)
139
139
 
140
+ **New cards.** Since 2.3.0: the TR 37.885 urban grid with 35 macro sites 500 m apart (4 GHz), suburban
141
+ macro (SMa) at 7 GHz with 11 sites 1299 m apart and 80 % of the users indoors, and a high-speed train in FR2
142
+ (TR 38.854: 12 remote radio heads 700 m apart, 10 m from the track, 350 km/h):
143
+
144
+ ![Layouts of the cards urban-macro-tr37885-4ghz, suburban-sma-7ghz and hst-fr2-28ghz](https://raw.githubusercontent.com/mjs19971997/handoverlab/main/docs/images/new-scenarios.png)
145
+
146
+ **Predicted measurements.** Since 2.4.0 the rule `a3_pred` hands over on predicted L3 results, as studied
147
+ in TR 38.744. Trained on two seeds and tested on two others, the ridge predictor is about 0.5-0.6 dB more
148
+ accurate than sample and hold 400 ms ahead (1.84 / 2.66 / 3.14 dB against 2.38 / 3.26 / 3.74 dB at 30 / 60 /
149
+ 90 km/h):
150
+
151
+ ![Prediction error against horizon for the ridge predictor and sample and hold at 30, 60 and 90 km/h](https://raw.githubusercontent.com/mjs19971997/handoverlab/main/docs/images/ai-mobility.png)
152
+
140
153
  ## What it models
141
154
 
142
155
  - **Scenarios**: the TR 37.885 urban street grid (configurable number of blocks; 433 m x 250 m
@@ -155,7 +168,11 @@ event D2 of Release 18:
155
168
  - **Beams and carriers** (options, 1.10.0): sectors with SSB beams from the TR 38.901 antenna
156
169
  model, cell quality from the beams (TS 38.331 5.5.3.3), the serving beam from beam reports, beam
157
170
  failure detection and recovery (TS 38.321 5.17, TS 38.133 8.5), several carriers with the
158
- measurement periods and gaps of TS 38.133, Event A5 between carriers.
171
+ measurement periods and gaps of TS 38.133, Event A5 between carriers; UE receive beams (since 2.4.0) and
172
+ dual connectivity with a secondary cell group (since 2.3.0, TS 37.340).
173
+ - **Lower layers** (options, since 2.2.0): TDL fast fading of TR 38.901 with an effective SINR (MIESM) for
174
+ link monitoring and the rate; a slot scheduler with the MCS, TBS and HARQ of TS 38.214; user-plane buffers
175
+ at handover with data forwarding (since 2.3.0, TS 38.300, TS 38.322, TS 38.323).
159
176
  - **Mobility**: street-following users with turn probabilities, random waypoints in the open area,
160
177
  pedestrian and vehicular speed profiles (by default the urban vehicles of TR 37.885: 60 km/h in one of
161
178
  two lanes) or your own speed groups.
@@ -172,7 +189,8 @@ event D2 of Release 18:
172
189
  epsilon-greedy bandit (`a3_bandit`, checked against an exhaustive search) and a deep Q-network
173
190
  (`dqn`, optional PyTorch).
174
191
  - **Failure model**: Qout/Qin with windows, N310/N311/T310, T304, lost commands and configurations,
175
- execution failures, re-establishment after a fixed outage (1 s, an assumption), the handover command
192
+ execution failures, re-establishment after a fixed outage (1 s, inside the bounds of TS 38.133
193
+ 6.2.1.2.1), the handover command
176
194
  during T310 as TS 38.331 specifies and the restart of the link monitoring on a new cell as HandoverLab
177
195
  reads TS 38.133 8.1.2.2 (defaults since 2.0.0), with options for the link monitoring (own interferer load, ideal random access).
178
196
  - **Metrics**: outcome of every attempt (useful, unnecessary, too early, wrong cell, too late,
@@ -193,11 +211,11 @@ the clause-by-clause detail is in [standard compliance](https://github.com/mjs19
193
211
  |---|---|---|---|
194
212
  | Layouts | `street_grid` (TR 37.885 urban grid), `open_area`, `highway` (TR 37.885 / TR 36.885, wrap-around), `indoor` (TR 38.901 office), `ntn` (one LEO satellite, TR 38.821); explicit site lists | sites on the pavement with small cells (urban cards); the TR 37.885 urban macro grid without wrap-around (`urban-macro-tr37885-4ghz`) | several satellites |
195
213
  | Channel | TR 38.901 path loss and LOS (UMi, UMa, RMa, SMa, InH), LOS from buildings, spatially consistent LOS and shadowing, car and O2I building penetration loss, radio maps from a file (clause 8), TR 38.811 for the satellite | received power per site and step with a slow time-varying component; indoor users keep the LOS state and shadowing of their position; optional TDL fast fading with effective SINRs (clause 7.7.2, since 2.2.0) | CDL and the full fast-fading model of clause 7.5, MIMO |
196
- | Beams and carriers | SSB beams per sector, cell quality from beams, beam failure detection and recovery, several carriers with gaps and Event A5; dual connectivity (NR-DC: SN addition, PSCell change, SN release, SCG failure; option since 2.3.0) | the TR 38.901 antenna element and DFT beams; isotropic UE; the SCG as one PSCell with a full-buffer share | UE-side beamforming, conditional PSCell change, fast MCG recovery |
214
+ | Beams and carriers | SSB beams per sector, cell quality from beams, beam failure detection and recovery, several carriers with gaps and Event A5; dual connectivity (NR-DC: SN addition, PSCell change, SN release, SCG failure; option since 2.3.0) | the TR 38.901 antenna element and DFT beams; isotropic UE unless UE receive panels are set (option since 2.4.0); the SCG as one PSCell with a full-buffer share | UE transmit beams and polarisation, conditional PSCell change, fast MCG recovery |
197
215
  | Mobility | street-following vehicles (60 km/h, two lanes), highway lanes at 70/140 km/h, a train at 350 km/h (TR 38.854), random waypoints, pedestrians | constant speed per user | handheld rotation and body blockage |
198
216
  | Traffic and load | constant rates per 5QI, full buffer, periodic, FTP model 3; cell load drives interference | rate from SINR (Shannon-type mapping), no scheduler | slot scheduler, HARQ, RLC/PDCP, TCP and applications |
199
217
  | Measurements | L1 samples with error, TS 38.331 L3 filter, TS 38.133 measurement periods and gaps (option) | wideband RSRP; SS-RSRP per resource element with beams/carriers | RSRQ, CSI reporting |
200
- | Procedures | baseline (A3), CHO, DAPS, LTM, conditional LTM, CHO with D1/D2 for satellites, A3/A5 between carriers; rules `a3`, `a3a5`, `a3_mro`, `a3_bandit`, `dqn`, `cho`, `cho_d2`, `daps`, `ltm`, `cltm` | fixed preparation, command and execution delays; re-establishment always succeeds after a fixed outage | condEventT1, RACH-less NTN handover, Xn signalling in detail |
218
+ | Procedures | baseline (A3), CHO, DAPS, LTM, conditional LTM, CHO with D1/D2 for satellites, A3/A5 between carriers; rules `a3`, `a3a5`, `a3_mro`, `a3_bandit`, `dqn`, `a3_pred`, `cho`, `cho_d2`, `daps`, `ltm`, `cltm` | fixed preparation, command and execution delays; re-establishment always succeeds after a fixed outage | condEventT1, RACH-less NTN handover, Xn signalling in detail |
201
219
  | Failure model | Qout/Qin with windows, N310/N311/T310, T304, command received during T310, re-establishment, link-monitoring restart | Qout/Qin as SINR thresholds (TR 36.839 values) instead of the BLER of a hypothetical PDCCH | BLER-based link monitoring; absolute failure rates are not calibrated: compare rules with each other |
202
220
  | Time | 10 ms step by default (`protocol.step_s`); the effect of the step is measured in [time step](https://github.com/mjs19971997/handoverlab/blob/main/docs/time-step.md) | events rounded to the step | sub-slot timing |
203
221
 
@@ -218,7 +236,8 @@ networks with small cells 50-300 m apart. Three paths lead beyond 5G:
218
236
  - **Non-terrestrial networks**: a LEO satellite with earth-moving beams (TR 38.811, TR 38.821) and conditional
219
237
  handover with condEventD2 (TS 38.331 Release 18).
220
238
  - **Learning-based mobility**: the rule interface gives a rule every measurement and the outcome of every
221
- attempt; `a3_bandit` and `dqn` are examples, `a3_mro` the fair tuned baseline.
239
+ attempt; `a3_bandit` and `dqn` are examples, `a3_mro` the fair tuned baseline, and `a3_pred` follows the
240
+ RRM measurement prediction of TR 38.744 (Release 19).
222
241
 
223
242
  6G itself is at the stage of requirements: TR 38.914 V20.1.0 (Release 20, last changed at RAN #113 in September
224
243
  2026) sets scenarios and key performance requirements but specifies no handover procedure, timer or measurement
@@ -234,7 +253,11 @@ range of the 21 companies that reported their results in the 3GPP contribution R
234
253
  Ericsson, Nokia, Samsung, Qualcomm and others), for UMa, UMi and the indoor office at 6 and
235
254
  30 GHz. 325 of 342 compared percentiles are inside the range, none is more than about 1 dB from
236
255
  the industry mean, and `handoverlab verify` repeats the check
237
- ([details](https://github.com/mjs19971997/handoverlab/blob/main/docs/calibration-3gpp.md)).
256
+ ([details](https://github.com/mjs19971997/handoverlab/blob/main/docs/calibration-3gpp.md)). Since 2.4.0 the
257
+ same check runs at 7 GHz (Table 7.8-1A) against the companies of R1-2506406: all 342 percentiles lie inside
258
+ their range, but 1.65-2.88 dB from their mean, which misses the 1.5 dB criterion set before the run.
259
+
260
+ ![CDFs of coupling loss and geometry for UMa, UMi and SMa at 7 GHz, with the HandoverLab curve inside the company range of R1-2506406](https://raw.githubusercontent.com/mjs19971997/handoverlab/main/docs/images/calibration_7ghz.png)
238
261
 
239
262
  ![HandoverLab against the 21 companies of 3GPP R1-165974](https://raw.githubusercontent.com/mjs19971997/handoverlab/main/docs/images/calibration_38901.png)
240
263
 
@@ -279,6 +302,20 @@ L1/L2-triggered mobility.
279
302
 
280
303
  ## What's new
281
304
 
305
+ - **2.4.0**: UE receive beams (panels of TR 38.802, best beam or a sweep); a measurement-prediction rule after
306
+ TR 38.744 (`a3_pred`: predicted Event A3 or measurement skipping, sample and hold or a trained ridge
307
+ predictor); the slot scheduler as a compiled kernel (`run.backend: numba`, bit-identical, 8-60 times
308
+ faster); the 7 GHz large-scale calibration against the companies of R1-2506406 (every percentile inside the
309
+ range, the distance to the mean criterion missed); a [comparison with other simulators](https://github.com/mjs19971997/handoverlab/blob/main/docs/comparison.md).
310
+ - **2.3.0**: user-plane buffers at handover (PDCP / RLC, Xn data forwarding for baseline, conditional, DAPS and
311
+ L1/L2-triggered handover); the TR 37.885 urban macro grid, suburban macro (SMa) and O2I penetration of indoor
312
+ users; a high-speed train card from TR 38.854; dual connectivity (TS 37.340: SN addition, PSCell change, SN
313
+ release, SCG failure); a fresh held-out check of the failure model against new ns-3 runs, reported as it
314
+ came.
315
+ - **2.2.0**: TDL fast fading of TR 38.901 with an effective SINR for link monitoring and rate; a slot scheduler
316
+ with the MCS, TBS and HARQ of TS 38.214; checked against ns-3 runs with fading.
317
+ - **2.1.0**: a clause-by-clause audit against the full 3GPP texts (`protocol.rrc_detail`,
318
+ `radio.channel_detail`), value domains from the standards and a study gate that checks them.
282
319
  - **2.0.0**: satellites (non-terrestrial networks): one LEO satellite at 600 km with 19 earth-moving beams
283
320
  (TR 38.811 channel, TR 38.821 Set-1 S band), conditional handover with the location event D2 of TS 38.331
284
321
  Release 18 (`cho_d2`), checked against the link budgets of TR 38.821 (within 0.03 dB). The 3GPP values
@@ -434,6 +471,10 @@ the pages are plain Markdown in [docs/](https://github.com/mjs19971997/handoverl
434
471
  - [Scenario cards](https://github.com/mjs19971997/handoverlab/tree/main/docs/scenarios): the built-in scenarios with the source of every parameter.
435
472
  - [Verification](https://github.com/mjs19971997/handoverlab/blob/main/docs/verification.md), [failure-model calibration](https://github.com/mjs19971997/handoverlab/blob/main/docs/calibration.md) and
436
473
  [performance](https://github.com/mjs19971997/handoverlab/blob/main/docs/performance.md).
474
+ - [Comparison with other simulators](https://github.com/mjs19971997/handoverlab/blob/main/docs/comparison.md): ns-3 with 5G-LENA
475
+ and the mmWave module, Simu5G, the Vienna 5G System Level Simulator, the MATLAB 5G Toolbox, OpenAirInterface
476
+ and Sionna on handover procedures, failure model, NTN, beams, PHY abstraction, scheduler, scale and validation,
477
+ each cell with its source, including where the other tools are stronger.
437
478
  - [Changelog](https://github.com/mjs19971997/handoverlab/blob/main/CHANGELOG.md), [contribution guide](https://github.com/mjs19971997/handoverlab/blob/main/CONTRIBUTING.md) and [releasing](https://github.com/mjs19971997/handoverlab/blob/main/docs/RELEASING.md).
438
479
 
439
480
  ## Roadmap
@@ -475,19 +516,39 @@ the pages are plain Markdown in [docs/](https://github.com/mjs19971997/handoverl
475
516
  20. 1.11.0: the TR 37.885 highway, the card audit, the bandit against an exhaustive search, the
476
517
  `dqn` rule and the optional Numba kernel.
477
518
  21. 1.12.0: radio maps from ray tracing or measurements.
478
- 22. **2.0.0 (this release)**: a LEO satellite with earth-moving beams and conditional handover with
519
+ 22. 2.0.0: a LEO satellite with earth-moving beams and conditional handover with
479
520
  event D2; the 3GPP values as defaults, with a switch back to 1.x.
480
- 23. Later (planned, not done): the failure model checked on held-out measurements, the sensitivity of
481
- the results to the time step (LTM and beams), a reproducible benchmark package against
482
- ns-3 / 5G-LENA, a table of model boundaries, condEventT1 and earth-fixed beams.
521
+ 23. 2.1.0: the clause-by-clause standard audit; held-out validation of the failure model, the
522
+ time-step study, the ns-3 benchmark package and the table of model boundaries.
523
+ 24. 2.2.0: fast fading with link-to-system mapping; the slot scheduler with MCS, TBS and HARQ.
524
+ 25. 2.3.0: buffers at handover, urban macro, SMa and O2I, the high-speed train, dual connectivity.
525
+ 26. 2.4.0: UE receive beams, the TR 38.744 prediction rule, the compiled
526
+ scheduler, the 7 GHz calibration and the comparison with other simulators.
527
+ 27. **2.4.1 (this release)**: pictures, citation and tutorials brought up to date; the example study
528
+ completes again; no change of results.
529
+ 28. Later (planned, not done), staying a handover simulator: the effect of a handover on what the user
530
+ sees (simple TCP and application models on top of the buffers), MIMO as an SINR gain, hundreds of
531
+ users per run, and one scenario definition that also runs in ns-3; condEventT1 and earth-fixed beams.
483
532
 
484
533
  ## Citation
485
534
 
486
535
  If you use HandoverLab, please cite it as described in [CITATION.cff](https://github.com/mjs19971997/handoverlab/blob/main/CITATION.cff) (GitHub shows
487
- it under *Cite this repository*). The releases are archived on Zenodo:
536
+ it under *Cite this repository*). Every release is archived on Zenodo:
488
537
  [doi:10.5281/zenodo.23409131](https://doi.org/10.5281/zenodo.23409131) cites all versions (it resolves to
489
- the latest); version 1.0.0 is [doi:10.5281/zenodo.23409132](https://doi.org/10.5281/zenodo.23409132)
490
- and version 1.0.1 [doi:10.5281/zenodo.23409402](https://doi.org/10.5281/zenodo.23409402).
538
+ the latest). To cite the exact version you used, take its DOI from the version list on that page; version
539
+ 2.4.0 is [doi:10.5281/zenodo.23582521](https://doi.org/10.5281/zenodo.23582521).
540
+
541
+ ```bibtex
542
+ @software{handoverlab,
543
+ author = {Jalili Sanjarani, Mostafa and Elmi Sola, Yasser},
544
+ title = {{HandoverLab}: system-level handover simulator for 5G-Advanced and beyond-5G research},
545
+ year = {2026},
546
+ publisher = {Zenodo},
547
+ version = {2.4.0},
548
+ doi = {10.5281/zenodo.23582521},
549
+ url = {https://github.com/mjs19971997/handoverlab}
550
+ }
551
+ ```
491
552
 
492
553
  ## Licence
493
554
 
@@ -12,7 +12,7 @@ received-power-level radio model from TR 38.901 (TR 38.811 for the satellite) (o
12
12
  and several carriers), an L3-filtered measurement chain, a radio-link failure model, and an
13
13
  outcome label for every handover attempt.
14
14
 
15
- > **Status: 2.0.0** (`python -m pip install handoverlab`). The public surface (configuration and
15
+ > **Status: 2.4.1** (`python -m pip install handoverlab`). The public surface (configuration and
16
16
  > result formats with a schema version, the rule interface, metric names, commands and the
17
17
  > documented Python names) follows the [stability policy](https://github.com/mjs19971997/handoverlab/blob/main/docs/stability.md): within 2.x it only grows,
18
18
  > and anything removed is deprecated first. 2.0.0 makes the 3GPP values the defaults (the protocol profile,
@@ -79,6 +79,19 @@ event D2 of Release 18:
79
79
 
80
80
  ![The 19 beams on the ground at the start and end of a run, and the received power of each beam at one user](https://raw.githubusercontent.com/mjs19971997/handoverlab/main/docs/images/ntn-beams.png)
81
81
 
82
+ **New cards.** Since 2.3.0: the TR 37.885 urban grid with 35 macro sites 500 m apart (4 GHz), suburban
83
+ macro (SMa) at 7 GHz with 11 sites 1299 m apart and 80 % of the users indoors, and a high-speed train in FR2
84
+ (TR 38.854: 12 remote radio heads 700 m apart, 10 m from the track, 350 km/h):
85
+
86
+ ![Layouts of the cards urban-macro-tr37885-4ghz, suburban-sma-7ghz and hst-fr2-28ghz](https://raw.githubusercontent.com/mjs19971997/handoverlab/main/docs/images/new-scenarios.png)
87
+
88
+ **Predicted measurements.** Since 2.4.0 the rule `a3_pred` hands over on predicted L3 results, as studied
89
+ in TR 38.744. Trained on two seeds and tested on two others, the ridge predictor is about 0.5-0.6 dB more
90
+ accurate than sample and hold 400 ms ahead (1.84 / 2.66 / 3.14 dB against 2.38 / 3.26 / 3.74 dB at 30 / 60 /
91
+ 90 km/h):
92
+
93
+ ![Prediction error against horizon for the ridge predictor and sample and hold at 30, 60 and 90 km/h](https://raw.githubusercontent.com/mjs19971997/handoverlab/main/docs/images/ai-mobility.png)
94
+
82
95
  ## What it models
83
96
 
84
97
  - **Scenarios**: the TR 37.885 urban street grid (configurable number of blocks; 433 m x 250 m
@@ -97,7 +110,11 @@ event D2 of Release 18:
97
110
  - **Beams and carriers** (options, 1.10.0): sectors with SSB beams from the TR 38.901 antenna
98
111
  model, cell quality from the beams (TS 38.331 5.5.3.3), the serving beam from beam reports, beam
99
112
  failure detection and recovery (TS 38.321 5.17, TS 38.133 8.5), several carriers with the
100
- measurement periods and gaps of TS 38.133, Event A5 between carriers.
113
+ measurement periods and gaps of TS 38.133, Event A5 between carriers; UE receive beams (since 2.4.0) and
114
+ dual connectivity with a secondary cell group (since 2.3.0, TS 37.340).
115
+ - **Lower layers** (options, since 2.2.0): TDL fast fading of TR 38.901 with an effective SINR (MIESM) for
116
+ link monitoring and the rate; a slot scheduler with the MCS, TBS and HARQ of TS 38.214; user-plane buffers
117
+ at handover with data forwarding (since 2.3.0, TS 38.300, TS 38.322, TS 38.323).
101
118
  - **Mobility**: street-following users with turn probabilities, random waypoints in the open area,
102
119
  pedestrian and vehicular speed profiles (by default the urban vehicles of TR 37.885: 60 km/h in one of
103
120
  two lanes) or your own speed groups.
@@ -114,7 +131,8 @@ event D2 of Release 18:
114
131
  epsilon-greedy bandit (`a3_bandit`, checked against an exhaustive search) and a deep Q-network
115
132
  (`dqn`, optional PyTorch).
116
133
  - **Failure model**: Qout/Qin with windows, N310/N311/T310, T304, lost commands and configurations,
117
- execution failures, re-establishment after a fixed outage (1 s, an assumption), the handover command
134
+ execution failures, re-establishment after a fixed outage (1 s, inside the bounds of TS 38.133
135
+ 6.2.1.2.1), the handover command
118
136
  during T310 as TS 38.331 specifies and the restart of the link monitoring on a new cell as HandoverLab
119
137
  reads TS 38.133 8.1.2.2 (defaults since 2.0.0), with options for the link monitoring (own interferer load, ideal random access).
120
138
  - **Metrics**: outcome of every attempt (useful, unnecessary, too early, wrong cell, too late,
@@ -135,11 +153,11 @@ the clause-by-clause detail is in [standard compliance](https://github.com/mjs19
135
153
  |---|---|---|---|
136
154
  | Layouts | `street_grid` (TR 37.885 urban grid), `open_area`, `highway` (TR 37.885 / TR 36.885, wrap-around), `indoor` (TR 38.901 office), `ntn` (one LEO satellite, TR 38.821); explicit site lists | sites on the pavement with small cells (urban cards); the TR 37.885 urban macro grid without wrap-around (`urban-macro-tr37885-4ghz`) | several satellites |
137
155
  | Channel | TR 38.901 path loss and LOS (UMi, UMa, RMa, SMa, InH), LOS from buildings, spatially consistent LOS and shadowing, car and O2I building penetration loss, radio maps from a file (clause 8), TR 38.811 for the satellite | received power per site and step with a slow time-varying component; indoor users keep the LOS state and shadowing of their position; optional TDL fast fading with effective SINRs (clause 7.7.2, since 2.2.0) | CDL and the full fast-fading model of clause 7.5, MIMO |
138
- | Beams and carriers | SSB beams per sector, cell quality from beams, beam failure detection and recovery, several carriers with gaps and Event A5; dual connectivity (NR-DC: SN addition, PSCell change, SN release, SCG failure; option since 2.3.0) | the TR 38.901 antenna element and DFT beams; isotropic UE; the SCG as one PSCell with a full-buffer share | UE-side beamforming, conditional PSCell change, fast MCG recovery |
156
+ | Beams and carriers | SSB beams per sector, cell quality from beams, beam failure detection and recovery, several carriers with gaps and Event A5; dual connectivity (NR-DC: SN addition, PSCell change, SN release, SCG failure; option since 2.3.0) | the TR 38.901 antenna element and DFT beams; isotropic UE unless UE receive panels are set (option since 2.4.0); the SCG as one PSCell with a full-buffer share | UE transmit beams and polarisation, conditional PSCell change, fast MCG recovery |
139
157
  | Mobility | street-following vehicles (60 km/h, two lanes), highway lanes at 70/140 km/h, a train at 350 km/h (TR 38.854), random waypoints, pedestrians | constant speed per user | handheld rotation and body blockage |
140
158
  | Traffic and load | constant rates per 5QI, full buffer, periodic, FTP model 3; cell load drives interference | rate from SINR (Shannon-type mapping), no scheduler | slot scheduler, HARQ, RLC/PDCP, TCP and applications |
141
159
  | Measurements | L1 samples with error, TS 38.331 L3 filter, TS 38.133 measurement periods and gaps (option) | wideband RSRP; SS-RSRP per resource element with beams/carriers | RSRQ, CSI reporting |
142
- | Procedures | baseline (A3), CHO, DAPS, LTM, conditional LTM, CHO with D1/D2 for satellites, A3/A5 between carriers; rules `a3`, `a3a5`, `a3_mro`, `a3_bandit`, `dqn`, `cho`, `cho_d2`, `daps`, `ltm`, `cltm` | fixed preparation, command and execution delays; re-establishment always succeeds after a fixed outage | condEventT1, RACH-less NTN handover, Xn signalling in detail |
160
+ | Procedures | baseline (A3), CHO, DAPS, LTM, conditional LTM, CHO with D1/D2 for satellites, A3/A5 between carriers; rules `a3`, `a3a5`, `a3_mro`, `a3_bandit`, `dqn`, `a3_pred`, `cho`, `cho_d2`, `daps`, `ltm`, `cltm` | fixed preparation, command and execution delays; re-establishment always succeeds after a fixed outage | condEventT1, RACH-less NTN handover, Xn signalling in detail |
143
161
  | Failure model | Qout/Qin with windows, N310/N311/T310, T304, command received during T310, re-establishment, link-monitoring restart | Qout/Qin as SINR thresholds (TR 36.839 values) instead of the BLER of a hypothetical PDCCH | BLER-based link monitoring; absolute failure rates are not calibrated: compare rules with each other |
144
162
  | Time | 10 ms step by default (`protocol.step_s`); the effect of the step is measured in [time step](https://github.com/mjs19971997/handoverlab/blob/main/docs/time-step.md) | events rounded to the step | sub-slot timing |
145
163
 
@@ -160,7 +178,8 @@ networks with small cells 50-300 m apart. Three paths lead beyond 5G:
160
178
  - **Non-terrestrial networks**: a LEO satellite with earth-moving beams (TR 38.811, TR 38.821) and conditional
161
179
  handover with condEventD2 (TS 38.331 Release 18).
162
180
  - **Learning-based mobility**: the rule interface gives a rule every measurement and the outcome of every
163
- attempt; `a3_bandit` and `dqn` are examples, `a3_mro` the fair tuned baseline.
181
+ attempt; `a3_bandit` and `dqn` are examples, `a3_mro` the fair tuned baseline, and `a3_pred` follows the
182
+ RRM measurement prediction of TR 38.744 (Release 19).
164
183
 
165
184
  6G itself is at the stage of requirements: TR 38.914 V20.1.0 (Release 20, last changed at RAN #113 in September
166
185
  2026) sets scenarios and key performance requirements but specifies no handover procedure, timer or measurement
@@ -176,7 +195,11 @@ range of the 21 companies that reported their results in the 3GPP contribution R
176
195
  Ericsson, Nokia, Samsung, Qualcomm and others), for UMa, UMi and the indoor office at 6 and
177
196
  30 GHz. 325 of 342 compared percentiles are inside the range, none is more than about 1 dB from
178
197
  the industry mean, and `handoverlab verify` repeats the check
179
- ([details](https://github.com/mjs19971997/handoverlab/blob/main/docs/calibration-3gpp.md)).
198
+ ([details](https://github.com/mjs19971997/handoverlab/blob/main/docs/calibration-3gpp.md)). Since 2.4.0 the
199
+ same check runs at 7 GHz (Table 7.8-1A) against the companies of R1-2506406: all 342 percentiles lie inside
200
+ their range, but 1.65-2.88 dB from their mean, which misses the 1.5 dB criterion set before the run.
201
+
202
+ ![CDFs of coupling loss and geometry for UMa, UMi and SMa at 7 GHz, with the HandoverLab curve inside the company range of R1-2506406](https://raw.githubusercontent.com/mjs19971997/handoverlab/main/docs/images/calibration_7ghz.png)
180
203
 
181
204
  ![HandoverLab against the 21 companies of 3GPP R1-165974](https://raw.githubusercontent.com/mjs19971997/handoverlab/main/docs/images/calibration_38901.png)
182
205
 
@@ -221,6 +244,20 @@ L1/L2-triggered mobility.
221
244
 
222
245
  ## What's new
223
246
 
247
+ - **2.4.0**: UE receive beams (panels of TR 38.802, best beam or a sweep); a measurement-prediction rule after
248
+ TR 38.744 (`a3_pred`: predicted Event A3 or measurement skipping, sample and hold or a trained ridge
249
+ predictor); the slot scheduler as a compiled kernel (`run.backend: numba`, bit-identical, 8-60 times
250
+ faster); the 7 GHz large-scale calibration against the companies of R1-2506406 (every percentile inside the
251
+ range, the distance to the mean criterion missed); a [comparison with other simulators](https://github.com/mjs19971997/handoverlab/blob/main/docs/comparison.md).
252
+ - **2.3.0**: user-plane buffers at handover (PDCP / RLC, Xn data forwarding for baseline, conditional, DAPS and
253
+ L1/L2-triggered handover); the TR 37.885 urban macro grid, suburban macro (SMa) and O2I penetration of indoor
254
+ users; a high-speed train card from TR 38.854; dual connectivity (TS 37.340: SN addition, PSCell change, SN
255
+ release, SCG failure); a fresh held-out check of the failure model against new ns-3 runs, reported as it
256
+ came.
257
+ - **2.2.0**: TDL fast fading of TR 38.901 with an effective SINR for link monitoring and rate; a slot scheduler
258
+ with the MCS, TBS and HARQ of TS 38.214; checked against ns-3 runs with fading.
259
+ - **2.1.0**: a clause-by-clause audit against the full 3GPP texts (`protocol.rrc_detail`,
260
+ `radio.channel_detail`), value domains from the standards and a study gate that checks them.
224
261
  - **2.0.0**: satellites (non-terrestrial networks): one LEO satellite at 600 km with 19 earth-moving beams
225
262
  (TR 38.811 channel, TR 38.821 Set-1 S band), conditional handover with the location event D2 of TS 38.331
226
263
  Release 18 (`cho_d2`), checked against the link budgets of TR 38.821 (within 0.03 dB). The 3GPP values
@@ -376,6 +413,10 @@ the pages are plain Markdown in [docs/](https://github.com/mjs19971997/handoverl
376
413
  - [Scenario cards](https://github.com/mjs19971997/handoverlab/tree/main/docs/scenarios): the built-in scenarios with the source of every parameter.
377
414
  - [Verification](https://github.com/mjs19971997/handoverlab/blob/main/docs/verification.md), [failure-model calibration](https://github.com/mjs19971997/handoverlab/blob/main/docs/calibration.md) and
378
415
  [performance](https://github.com/mjs19971997/handoverlab/blob/main/docs/performance.md).
416
+ - [Comparison with other simulators](https://github.com/mjs19971997/handoverlab/blob/main/docs/comparison.md): ns-3 with 5G-LENA
417
+ and the mmWave module, Simu5G, the Vienna 5G System Level Simulator, the MATLAB 5G Toolbox, OpenAirInterface
418
+ and Sionna on handover procedures, failure model, NTN, beams, PHY abstraction, scheduler, scale and validation,
419
+ each cell with its source, including where the other tools are stronger.
379
420
  - [Changelog](https://github.com/mjs19971997/handoverlab/blob/main/CHANGELOG.md), [contribution guide](https://github.com/mjs19971997/handoverlab/blob/main/CONTRIBUTING.md) and [releasing](https://github.com/mjs19971997/handoverlab/blob/main/docs/RELEASING.md).
380
421
 
381
422
  ## Roadmap
@@ -417,19 +458,39 @@ the pages are plain Markdown in [docs/](https://github.com/mjs19971997/handoverl
417
458
  20. 1.11.0: the TR 37.885 highway, the card audit, the bandit against an exhaustive search, the
418
459
  `dqn` rule and the optional Numba kernel.
419
460
  21. 1.12.0: radio maps from ray tracing or measurements.
420
- 22. **2.0.0 (this release)**: a LEO satellite with earth-moving beams and conditional handover with
461
+ 22. 2.0.0: a LEO satellite with earth-moving beams and conditional handover with
421
462
  event D2; the 3GPP values as defaults, with a switch back to 1.x.
422
- 23. Later (planned, not done): the failure model checked on held-out measurements, the sensitivity of
423
- the results to the time step (LTM and beams), a reproducible benchmark package against
424
- ns-3 / 5G-LENA, a table of model boundaries, condEventT1 and earth-fixed beams.
463
+ 23. 2.1.0: the clause-by-clause standard audit; held-out validation of the failure model, the
464
+ time-step study, the ns-3 benchmark package and the table of model boundaries.
465
+ 24. 2.2.0: fast fading with link-to-system mapping; the slot scheduler with MCS, TBS and HARQ.
466
+ 25. 2.3.0: buffers at handover, urban macro, SMa and O2I, the high-speed train, dual connectivity.
467
+ 26. 2.4.0: UE receive beams, the TR 38.744 prediction rule, the compiled
468
+ scheduler, the 7 GHz calibration and the comparison with other simulators.
469
+ 27. **2.4.1 (this release)**: pictures, citation and tutorials brought up to date; the example study
470
+ completes again; no change of results.
471
+ 28. Later (planned, not done), staying a handover simulator: the effect of a handover on what the user
472
+ sees (simple TCP and application models on top of the buffers), MIMO as an SINR gain, hundreds of
473
+ users per run, and one scenario definition that also runs in ns-3; condEventT1 and earth-fixed beams.
425
474
 
426
475
  ## Citation
427
476
 
428
477
  If you use HandoverLab, please cite it as described in [CITATION.cff](https://github.com/mjs19971997/handoverlab/blob/main/CITATION.cff) (GitHub shows
429
- it under *Cite this repository*). The releases are archived on Zenodo:
478
+ it under *Cite this repository*). Every release is archived on Zenodo:
430
479
  [doi:10.5281/zenodo.23409131](https://doi.org/10.5281/zenodo.23409131) cites all versions (it resolves to
431
- the latest); version 1.0.0 is [doi:10.5281/zenodo.23409132](https://doi.org/10.5281/zenodo.23409132)
432
- and version 1.0.1 [doi:10.5281/zenodo.23409402](https://doi.org/10.5281/zenodo.23409402).
480
+ the latest). To cite the exact version you used, take its DOI from the version list on that page; version
481
+ 2.4.0 is [doi:10.5281/zenodo.23582521](https://doi.org/10.5281/zenodo.23582521).
482
+
483
+ ```bibtex
484
+ @software{handoverlab,
485
+ author = {Jalili Sanjarani, Mostafa and Elmi Sola, Yasser},
486
+ title = {{HandoverLab}: system-level handover simulator for 5G-Advanced and beyond-5G research},
487
+ year = {2026},
488
+ publisher = {Zenodo},
489
+ version = {2.4.0},
490
+ doi = {10.5281/zenodo.23582521},
491
+ url = {https://github.com/mjs19971997/handoverlab}
492
+ }
493
+ ```
433
494
 
434
495
  ## Licence
435
496
 
@@ -81,6 +81,58 @@ distribution, at most 0.12 dB below the smallest company value: the SIR of Hando
81
81
  0.5 dB below the industry mean there, which is on the conservative side. `handoverlab verify`
82
82
  passes a case when every percentile lies inside the company range widened by 0.5 dB.
83
83
 
84
+ ## 7 GHz: Table 7.8-1A against R1-2506406 (since 2.4.0)
85
+
86
+ **Summary.** TR 38.901 V19.5.0 adds Table 7.8-1A to clause 7.8.1: UMa, UMi-Street Canyon and suburban macro
87
+ (SMa, ISD 1299 m and 1732 m) at 7 GHz, plus UMa and UMi at 6 GHz again "with updated channel modeling". The
88
+ companies reported their CDFs in the 3GPP contribution **R1-2506406** (RAN1 #122, Bengaluru, August 2025,
89
+ InterDigital and ZTE, "Calibration Results for 7 - 24 GHz SI";
90
+ [3GPP server](https://www.3gpp.org/ftp/tsg_ran/WG1_RL1/TSGR1_122/Docs/R1-2506406.zip); large-scale workbook
91
+ `Calibration_LS_v35`, based on TR 38.901 V19.0.0). The criteria were fixed before the first run: every
92
+ percentile 5-95 % inside the company range widened by 0.5 dB (C1, the rule of the cases above), and the
93
+ largest distance from the company mean at most 1.5 dB per case (C2). Result, 30 000 users per case, seed 1:
94
+ **C1 passes for all 18 case-metric pairs (342 of 342 percentiles strictly inside the range); C2 fails for all
95
+ six cases (largest distance 1.65-2.88 dB).** `handoverlab verify` runs C1 as checks and C2 as notes in the
96
+ group `calibration`.
97
+
98
+ **The reference.** `src/handoverlab/verify/data/r1_2506406.csv` keeps, in the format of `r1_165974.csv`, the
99
+ mean, the smallest and the largest company value and the number of companies per case, metric and percentile;
100
+ the mean equals the workbook's own mean column. Companies with complete columns: 16 (coupling loss) / 15
101
+ (SINR, SIR) at 6 GHz; 17 / 16 for UMa and UMi at 7 GHz (Huawei, InterDigital, Samsung, ZTE, CATT, Lenovo,
102
+ Apple, Nokia, Ericsson, OPPO, MediaTek, Intel, Sharp, Spreadtrum, LGE, ETRI, Xiaomi; Spreadtrum gave the
103
+ coupling loss only); 17 / 16 for SMa 1299 m (with vivo, without ETRI); 13 / 12 for SMa 1732 m.
104
+
105
+ **The drop.** UMa and UMi as above (Table 7.8-1), with the IRR-glass loss of V19.5.0 (25.4 + 0.11 f dB) because
106
+ the companies worked with Release 19; at 7 GHz 49 dBm (UMa) and 44 dBm (UMi) with 20 MHz, the 6 GHz values of
107
+ Table 7.8-1, which Table 7.8-1A leaves unchanged for these two scenarios. SMa:
108
+
109
+ | Item | Setting | Source |
110
+ |---|---|---|
111
+ | Layout | 19 sites, 3 sectors, ISD 1299 m or 1732 m, BS 35 m, geographical wrap-around, minimum 2D distance 35 m (to d2D-out) | Tables 7.2-5, 7.8-1A |
112
+ | Antenna | element of Table 7.3-1 and 10 vertical elements (one port) without electrical tilt, the panel tilted mechanically to 95 deg (ISD 1299 m) or 92 deg (ISD 1732 m): the angles are taken into the antenna's local coordinates with Eqs. 7.1-7 and 7.1-8 | Tables 7.3-1, 7.8-1A; clause 7.1.3 |
113
+ | Users | 20 % outdoors (in cars, 1.5 m) with the car penetration loss N(9 dB, 5 dB) of non-metallic windows; 80 % indoors, 90 % of them in residential buildings (1.5 or 4.5 m), 10 % in commercial buildings (1.5 ... 13.5 m), uniform over the floors | Tables 7.2-5, 7.8-1A; clause 7.4.3.2 |
114
+ | O2I loss | low-loss A model (30 % glass, 70 % plywood, sigma_P 4.4 dB); d2D-in = minimum of two uniform variables up to 10 m (residential) or 25 m (commercial) | clause 7.4.3.1, Tables 7.4.3-1, 7.4.3-2 |
115
+ | Path loss, LOS, shadowing | the SMa models of `handoverlab.channel.pathloss` (Table 7.4.1-1; LOS probability of Table 7.4.2-1 without vegetation); shadowing 4 dB (LOS below d_BP), 6 dB (LOS beyond), 8 dB (NLOS), 8 dB for indoor users | Tables 7.4.1-1, 7.4.2-1, 7.5-6 Part-4 |
116
+ | Link budget | 49 dBm, 20 MHz, UT noise figure 9 dB, isotropic UT, attachment to the highest coupling gain | Tables 7.8-1, 7.8-1A |
117
+
118
+ Results (median HandoverLab / company mean; percentiles 5-95 % strictly inside the range; largest distance
119
+ from the mean):
120
+
121
+ | Case | Coupling loss [dB] | SINR [dB] | SIR [dB] | C1 | C2 (largest distance) |
122
+ |---|---|---|---|---|---|
123
+ | UMa-6 GHz | 119.9 / 121.0; 19/19; 1.65 | 5.5 / 5.6; 19/19; 1.34 | 8.0 / 8.0; 19/19; 0.17 | pass | fail (1.65) |
124
+ | UMi-6 GHz | 111.9 / 112.1; 19/19; 2.88 | 5.1 / 5.2; 19/19; 1.35 | 6.8 / 6.6; 19/19; 0.53 | pass | fail (2.88) |
125
+ | UMa-7 GHz | 121.7 / 122.4; 19/19; 1.78 | 5.0 / 5.0; 19/19; 0.90 | 7.9 / 7.9; 19/19; 0.29 | pass | fail (1.78) |
126
+ | UMi-7 GHz | 113.8 / 113.3; 19/19; 2.43 | 4.7 / 4.8; 19/19; 1.63 | 6.7 / 6.6; 19/19; 0.30 | pass | fail (2.43) |
127
+ | SMa-7 GHz, ISD 1299 m | 103.5 / 104.3; 19/19; 1.31 | 5.9 / 5.7; 19/19; 1.69 | 5.9 / 5.9; 19/19; 1.57 | pass | fail (1.69) |
128
+ | SMa-7 GHz, ISD 1732 m | 109.2 / 111.3; 19/19; 2.24 | 6.3 / 5.9; 19/19; 1.07 | 6.4 / 6.6; 19/19; 0.32 | pass | fail (2.24) |
129
+
130
+ Where the distance comes from: for UMa and UMi the coupling loss of the best users (75-95 %, close to a site)
131
+ is 1.6-2.9 dB lower than the company mean, and at UMi 7 GHz also at 5-10 %; the medians are within 1.1 dB.
132
+ For SMa 1732 m the coupling loss is about 2.1 dB lower than the mean over most of the distribution. The
133
+ company spread is large here (at the median, from 106.5 dB to 129.4 dB for SMa 1732 m), so the mean is a soft
134
+ target, but C2 was fixed before the run and is reported as it came. No parameter was changed after the run.
135
+
84
136
  ## What this calibration covers, and what it does not
85
137
 
86
138
  - It covers the **radio model**: the path-loss formulas, the LOS probabilities, the shadowing, the
@@ -98,8 +150,8 @@ passes a case when every percentile lies inside the company range widened by 0.5
98
150
  ## Repeat it
99
151
 
100
152
  ```bash
101
- handoverlab verify --only calibration # 10 000 users per case, a few seconds
102
- handoverlab verify --only calibration --full # 30 000 users per case, the table above
153
+ handoverlab verify --only calibration # 10 000 users per case, under a minute
154
+ handoverlab verify --only calibration --full # 30 000 users per case, the tables above
103
155
  python tools/make_calibration_figure.py # docs/images/calibration_38901.png
104
156
  ```
105
157
 
@@ -110,4 +162,6 @@ case = cal.CalScenario("UMa", 6.0)
110
162
  res = cal.simulate_drops(case, n_users=30000, seed=1)
111
163
  for c in cal.compare(case, res):
112
164
  print(c.metric, c.inside.sum(), "of", len(c.percentiles), "inside, largest distance", c.max_dev_db)
165
+
166
+ case = cal.CalScenario("SMa", 7.0, isd_m=1299.0, reference="R1-2506406") # compared with R1-2506406
113
167
  ```