fhops 0.1.0a1__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 (331) hide show
  1. fhops-0.1.0a1/.github/workflows/analytics-notebooks.yml +168 -0
  2. fhops-0.1.0a1/.github/workflows/ci.yml +176 -0
  3. fhops-0.1.0a1/.github/workflows/release-build.yml +37 -0
  4. fhops-0.1.0a1/.gitignore +215 -0
  5. fhops-0.1.0a1/.pre-commit-config.yaml +31 -0
  6. fhops-0.1.0a1/.readthedocs.yaml +10 -0
  7. fhops-0.1.0a1/CHANGE_LOG.md +259 -0
  8. fhops-0.1.0a1/CODE_OF_CONDUCT.md +2 -0
  9. fhops-0.1.0a1/CODING_AGENT.md +57 -0
  10. fhops-0.1.0a1/CONTRIBUTING.md +10 -0
  11. fhops-0.1.0a1/FHOPS_ROADMAP.md +147 -0
  12. fhops-0.1.0a1/FHOPS_debug_workbench.ipynb +565 -0
  13. fhops-0.1.0a1/LICENSE +21 -0
  14. fhops-0.1.0a1/PKG-INFO +173 -0
  15. fhops-0.1.0a1/README.md +140 -0
  16. fhops-0.1.0a1/candidate-feature-imports.md +31 -0
  17. fhops-0.1.0a1/docs/_static/.gitkeep +0 -0
  18. fhops-0.1.0a1/docs/_static/benchmarks/objective_gap_vs_best_heuristic.png +0 -0
  19. fhops-0.1.0a1/docs/_static/benchmarks/runtime_ratio_vs_best_heuristic.png +0 -0
  20. fhops-0.1.0a1/docs/api/fhops.evaluation.rst +12 -0
  21. fhops-0.1.0a1/docs/api/fhops.optimization.rst +22 -0
  22. fhops-0.1.0a1/docs/api/fhops.rst +7 -0
  23. fhops-0.1.0a1/docs/api/fhops.scenario.rst +23 -0
  24. fhops-0.1.0a1/docs/api/fhops.scheduling.rst +23 -0
  25. fhops-0.1.0a1/docs/api/index.rst +14 -0
  26. fhops-0.1.0a1/docs/conf.py +43 -0
  27. fhops-0.1.0a1/docs/contributing.rst +17 -0
  28. fhops-0.1.0a1/docs/examples/__init__.py +13 -0
  29. fhops-0.1.0a1/docs/examples/analytics/__init__.py +5 -0
  30. fhops-0.1.0a1/docs/examples/analytics/benchmark_summary.ipynb +440 -0
  31. fhops-0.1.0a1/docs/examples/analytics/data/benchmark_summary.csv +5 -0
  32. fhops-0.1.0a1/docs/examples/analytics/data/minitoy_sa_assignments.csv +22 -0
  33. fhops-0.1.0a1/docs/examples/analytics/data/notebook_metadata.json +66 -0
  34. fhops-0.1.0a1/docs/examples/analytics/data/operator_sweep/summary.csv +4 -0
  35. fhops-0.1.0a1/docs/examples/analytics/data/operator_sweep/summary.json +113 -0
  36. fhops-0.1.0a1/docs/examples/analytics/data/operator_sweep/user-1/sa_assignments.csv +10 -0
  37. fhops-0.1.0a1/docs/examples/analytics/data/operator_sweep/user-1/sa_assignments_explore.csv +10 -0
  38. fhops-0.1.0a1/docs/examples/analytics/data/operator_sweep/user-1/sa_assignments_stabilise.csv +10 -0
  39. fhops-0.1.0a1/docs/examples/analytics/data/scaling_medium_sa_assignments.csv +10 -0
  40. fhops-0.1.0a1/docs/examples/analytics/data/synthetic_large_sa_assignments.csv +16 -0
  41. fhops-0.1.0a1/docs/examples/analytics/data/synthetic_medium_sa_assignments.csv +10 -0
  42. fhops-0.1.0a1/docs/examples/analytics/data/synthetic_small_sa_assignments.csv +4 -0
  43. fhops-0.1.0a1/docs/examples/analytics/data/telemetry_minitoy.jsonl +6 -0
  44. fhops-0.1.0a1/docs/examples/analytics/data/tuner_reports/demo_tuner_comparison.csv +4 -0
  45. fhops-0.1.0a1/docs/examples/analytics/data/tuner_reports/demo_tuner_comparison.md +5 -0
  46. fhops-0.1.0a1/docs/examples/analytics/data/tuner_reports/demo_tuner_report.csv +4 -0
  47. fhops-0.1.0a1/docs/examples/analytics/data/tuner_reports/demo_tuner_report.md +5 -0
  48. fhops-0.1.0a1/docs/examples/analytics/data/tuner_reports/history_summary.csv +5 -0
  49. fhops-0.1.0a1/docs/examples/analytics/data/tuner_reports/history_summary.html +46 -0
  50. fhops-0.1.0a1/docs/examples/analytics/data/tuner_reports/history_summary.md +6 -0
  51. fhops-0.1.0a1/docs/examples/analytics/data/tuner_reports/history_summary.png +0 -0
  52. fhops-0.1.0a1/docs/examples/analytics/ensemble_resilience.ipynb +392 -0
  53. fhops-0.1.0a1/docs/examples/analytics/index.rst +27 -0
  54. fhops-0.1.0a1/docs/examples/analytics/kpi_decomposition.ipynb +504 -0
  55. fhops-0.1.0a1/docs/examples/analytics/landing_congestion.ipynb +680 -0
  56. fhops-0.1.0a1/docs/examples/analytics/operator_sweep.ipynb +438 -0
  57. fhops-0.1.0a1/docs/examples/analytics/playback_walkthrough.ipynb +295 -0
  58. fhops-0.1.0a1/docs/examples/analytics/stochastic_robustness.ipynb +308 -0
  59. fhops-0.1.0a1/docs/examples/analytics/system_mix.ipynb +281 -0
  60. fhops-0.1.0a1/docs/examples/analytics/telemetry_diagnostics.ipynb +307 -0
  61. fhops-0.1.0a1/docs/examples/analytics/tuner_history_analysis.ipynb +184 -0
  62. fhops-0.1.0a1/docs/examples/analytics/tuner_report_analysis.ipynb +620 -0
  63. fhops-0.1.0a1/docs/examples/analytics/utils.py +195 -0
  64. fhops-0.1.0a1/docs/examples/analytics/what_if_analysis.ipynb +124 -0
  65. fhops-0.1.0a1/docs/examples/robustness.rst +106 -0
  66. fhops-0.1.0a1/docs/examples/synthetic_batch_custom.yaml +23 -0
  67. fhops-0.1.0a1/docs/examples/synthetic_batch_plan.yaml +25 -0
  68. fhops-0.1.0a1/docs/howto/benchmarks.rst +211 -0
  69. fhops-0.1.0a1/docs/howto/data_contract.rst +152 -0
  70. fhops-0.1.0a1/docs/howto/evaluation.rst +254 -0
  71. fhops-0.1.0a1/docs/howto/heuristic_presets.rst +122 -0
  72. fhops-0.1.0a1/docs/howto/ils.rst +51 -0
  73. fhops-0.1.0a1/docs/howto/mobilisation_geo.rst +59 -0
  74. fhops-0.1.0a1/docs/howto/parallel_heuristics.rst +33 -0
  75. fhops-0.1.0a1/docs/howto/quickstart.rst +72 -0
  76. fhops-0.1.0a1/docs/howto/synthetic_datasets.rst +190 -0
  77. fhops-0.1.0a1/docs/howto/system_sequencing.rst +107 -0
  78. fhops-0.1.0a1/docs/howto/tabu.rst +36 -0
  79. fhops-0.1.0a1/docs/howto/telemetry_tuning.rst +590 -0
  80. fhops-0.1.0a1/docs/index.rst +54 -0
  81. fhops-0.1.0a1/docs/overview.rst +56 -0
  82. fhops-0.1.0a1/docs/reference/cli.rst +67 -0
  83. fhops-0.1.0a1/docs/reference/dashboards.rst +64 -0
  84. fhops-0.1.0a1/docs/reference/harvest_systems.rst +82 -0
  85. fhops-0.1.0a1/docs/reference/playback_aggregates.rst +13 -0
  86. fhops-0.1.0a1/docs/reference/telemetry.rst +127 -0
  87. fhops-0.1.0a1/docs/references/bischl2023-hpo-review.pdf +0 -0
  88. fhops-0.1.0a1/docs/references/feurer2019-hpo-chapter.pdf +431 -0
  89. fhops-0.1.0a1/docs/references/golovin2017-vizier.pdf +1 -0
  90. fhops-0.1.0a1/docs/references/thornton2013-auto-weka.pdf +0 -0
  91. fhops-0.1.0a1/docs/releases/v0.1.0.md +47 -0
  92. fhops-0.1.0a1/docs/requirements.txt +19 -0
  93. fhops-0.1.0a1/docs/roadmap.rst +9 -0
  94. fhops-0.1.0a1/docs/templates/kpi_summary.csv +12 -0
  95. fhops-0.1.0a1/docs/templates/kpi_summary.md +28 -0
  96. fhops-0.1.0a1/examples/large84/README.md +12 -0
  97. fhops-0.1.0a1/examples/large84/data/blocks.csv +51 -0
  98. fhops-0.1.0a1/examples/large84/data/calendar.csv +1345 -0
  99. fhops-0.1.0a1/examples/large84/data/landings.csv +9 -0
  100. fhops-0.1.0a1/examples/large84/data/machines.csv +17 -0
  101. fhops-0.1.0a1/examples/large84/data/prod_rates.csv +801 -0
  102. fhops-0.1.0a1/examples/large84/large84_block_distances.csv +2501 -0
  103. fhops-0.1.0a1/examples/large84/out/mip_solution.csv +899 -0
  104. fhops-0.1.0a1/examples/large84/out/sa_solution.csv +640 -0
  105. fhops-0.1.0a1/examples/large84/scenario.yaml +97 -0
  106. fhops-0.1.0a1/examples/med42/README.md +12 -0
  107. fhops-0.1.0a1/examples/med42/data/blocks.csv +21 -0
  108. fhops-0.1.0a1/examples/med42/data/calendar.csv +337 -0
  109. fhops-0.1.0a1/examples/med42/data/landings.csv +5 -0
  110. fhops-0.1.0a1/examples/med42/data/machines.csv +9 -0
  111. fhops-0.1.0a1/examples/med42/data/prod_rates.csv +161 -0
  112. fhops-0.1.0a1/examples/med42/med42_block_distances.csv +13 -0
  113. fhops-0.1.0a1/examples/med42/med42_blocks.geojson +11 -0
  114. fhops-0.1.0a1/examples/med42/out/mip_solution.csv +233 -0
  115. fhops-0.1.0a1/examples/med42/out/sa_solution.csv +149 -0
  116. fhops-0.1.0a1/examples/med42/scenario.yaml +57 -0
  117. fhops-0.1.0a1/examples/minitoy/data/blocks.csv +4 -0
  118. fhops-0.1.0a1/examples/minitoy/data/calendar.csv +29 -0
  119. fhops-0.1.0a1/examples/minitoy/data/landings.csv +3 -0
  120. fhops-0.1.0a1/examples/minitoy/data/machines.csv +3 -0
  121. fhops-0.1.0a1/examples/minitoy/data/prod_rates.csv +7 -0
  122. fhops-0.1.0a1/examples/minitoy/minitoy_block_distances.csv +7 -0
  123. fhops-0.1.0a1/examples/minitoy/minitoy_blocks.geojson +10 -0
  124. fhops-0.1.0a1/examples/minitoy/scenario.yaml +27 -0
  125. fhops-0.1.0a1/examples/small21/README.md +5 -0
  126. fhops-0.1.0a1/examples/small21/data/blocks.csv +11 -0
  127. fhops-0.1.0a1/examples/small21/data/calendar.csv +116 -0
  128. fhops-0.1.0a1/examples/small21/data/landings.csv +5 -0
  129. fhops-0.1.0a1/examples/small21/data/machines.csv +5 -0
  130. fhops-0.1.0a1/examples/small21/data/prod_rates.csv +41 -0
  131. fhops-0.1.0a1/examples/small21/out/.gitkeep +0 -0
  132. fhops-0.1.0a1/examples/small21/scenario.yaml +35 -0
  133. fhops-0.1.0a1/examples/small21/small21_block_distances.csv +13 -0
  134. fhops-0.1.0a1/examples/small21/small21_blocks.geojson +144 -0
  135. fhops-0.1.0a1/examples/synthetic/README.md +48 -0
  136. fhops-0.1.0a1/examples/synthetic/large/data/blocks.csv +17 -0
  137. fhops-0.1.0a1/examples/synthetic/large/data/calendar.csv +109 -0
  138. fhops-0.1.0a1/examples/synthetic/large/data/crew_assignments.csv +7 -0
  139. fhops-0.1.0a1/examples/synthetic/large/data/landings.csv +4 -0
  140. fhops-0.1.0a1/examples/synthetic/large/data/machines.csv +7 -0
  141. fhops-0.1.0a1/examples/synthetic/large/data/prod_rates.csv +97 -0
  142. fhops-0.1.0a1/examples/synthetic/large/metadata.yaml +50 -0
  143. fhops-0.1.0a1/examples/synthetic/large/scenario.yaml +26 -0
  144. fhops-0.1.0a1/examples/synthetic/medium/data/blocks.csv +9 -0
  145. fhops-0.1.0a1/examples/synthetic/medium/data/calendar.csv +49 -0
  146. fhops-0.1.0a1/examples/synthetic/medium/data/crew_assignments.csv +5 -0
  147. fhops-0.1.0a1/examples/synthetic/medium/data/landings.csv +3 -0
  148. fhops-0.1.0a1/examples/synthetic/medium/data/machines.csv +5 -0
  149. fhops-0.1.0a1/examples/synthetic/medium/data/prod_rates.csv +33 -0
  150. fhops-0.1.0a1/examples/synthetic/medium/metadata.yaml +31 -0
  151. fhops-0.1.0a1/examples/synthetic/medium/scenario.yaml +17 -0
  152. fhops-0.1.0a1/examples/synthetic/metadata.yaml +110 -0
  153. fhops-0.1.0a1/examples/synthetic/small/data/blocks.csv +5 -0
  154. fhops-0.1.0a1/examples/synthetic/small/data/calendar.csv +13 -0
  155. fhops-0.1.0a1/examples/synthetic/small/data/crew_assignments.csv +3 -0
  156. fhops-0.1.0a1/examples/synthetic/small/data/landings.csv +2 -0
  157. fhops-0.1.0a1/examples/synthetic/small/data/machines.csv +3 -0
  158. fhops-0.1.0a1/examples/synthetic/small/data/prod_rates.csv +9 -0
  159. fhops-0.1.0a1/examples/synthetic/small/metadata.yaml +23 -0
  160. fhops-0.1.0a1/examples/synthetic/small/scenario.yaml +17 -0
  161. fhops-0.1.0a1/hatch.toml +24 -0
  162. fhops-0.1.0a1/notes/analytics_notebooks_plan.md +105 -0
  163. fhops-0.1.0a1/notes/ci_cd_expansion.md +23 -0
  164. fhops-0.1.0a1/notes/cli_docs_plan.md +27 -0
  165. fhops-0.1.0a1/notes/cli_profiles_plan.md +51 -0
  166. fhops-0.1.0a1/notes/data_contract_enhancements.md +38 -0
  167. fhops-0.1.0a1/notes/metaheuristic_hyperparam_tuning.md +401 -0
  168. fhops-0.1.0a1/notes/metaheuristic_roadmap.md +384 -0
  169. fhops-0.1.0a1/notes/mip_model_plan.md +47 -0
  170. fhops-0.1.0a1/notes/mobilisation_plan.md +33 -0
  171. fhops-0.1.0a1/notes/modular_reorg_plan.md +69 -0
  172. fhops-0.1.0a1/notes/release_candidate_prep.md +49 -0
  173. fhops-0.1.0a1/notes/release_notes_draft.md +28 -0
  174. fhops-0.1.0a1/notes/release_tuned_presets.json +647 -0
  175. fhops-0.1.0a1/notes/release_tuning_results.md +36 -0
  176. fhops-0.1.0a1/notes/scratch.md +41 -0
  177. fhops-0.1.0a1/notes/simulation_eval_plan.md +184 -0
  178. fhops-0.1.0a1/notes/synthetic_dataset_plan.md +138 -0
  179. fhops-0.1.0a1/notes/system_sequencing_plan.md +57 -0
  180. fhops-0.1.0a1/notes/tabu_rework_plan.md +87 -0
  181. fhops-0.1.0a1/notes/thesis_alignment.md +23 -0
  182. fhops-0.1.0a1/pyproject.toml +94 -0
  183. fhops-0.1.0a1/scripts/analyze_tuner_reports.py +1113 -0
  184. fhops-0.1.0a1/scripts/check_changelog.sh +18 -0
  185. fhops-0.1.0a1/scripts/ingest_mip_baselines.py +184 -0
  186. fhops-0.1.0a1/scripts/render_benchmark_plots.py +145 -0
  187. fhops-0.1.0a1/scripts/run_analytics_notebooks.py +153 -0
  188. fhops-0.1.0a1/scripts/run_tuning_benchmarks.py +1452 -0
  189. fhops-0.1.0a1/scripts/summarize_tuner_meta.py +125 -0
  190. fhops-0.1.0a1/src/fhops/__init__.py +5 -0
  191. fhops-0.1.0a1/src/fhops/cli/_utils.py +140 -0
  192. fhops-0.1.0a1/src/fhops/cli/benchmarks.py +797 -0
  193. fhops-0.1.0a1/src/fhops/cli/geospatial.py +32 -0
  194. fhops-0.1.0a1/src/fhops/cli/main.py +2162 -0
  195. fhops-0.1.0a1/src/fhops/cli/profiles.py +268 -0
  196. fhops-0.1.0a1/src/fhops/cli/synthetic.py +433 -0
  197. fhops-0.1.0a1/src/fhops/cli/telemetry.py +366 -0
  198. fhops-0.1.0a1/src/fhops/core/types.py +36 -0
  199. fhops-0.1.0a1/src/fhops/data/loaders.py +35 -0
  200. fhops-0.1.0a1/src/fhops/eval/kpis.py +15 -0
  201. fhops-0.1.0a1/src/fhops/evaluation/__init__.py +83 -0
  202. fhops-0.1.0a1/src/fhops/evaluation/metrics/__init__.py +1 -0
  203. fhops-0.1.0a1/src/fhops/evaluation/metrics/aggregates.py +117 -0
  204. fhops-0.1.0a1/src/fhops/evaluation/metrics/kpis.py +292 -0
  205. fhops-0.1.0a1/src/fhops/evaluation/playback/__init__.py +56 -0
  206. fhops-0.1.0a1/src/fhops/evaluation/playback/adapters.py +252 -0
  207. fhops-0.1.0a1/src/fhops/evaluation/playback/aggregates.py +153 -0
  208. fhops-0.1.0a1/src/fhops/evaluation/playback/core.py +327 -0
  209. fhops-0.1.0a1/src/fhops/evaluation/playback/events.py +102 -0
  210. fhops-0.1.0a1/src/fhops/evaluation/playback/exporters.py +132 -0
  211. fhops-0.1.0a1/src/fhops/evaluation/playback/stochastic.py +318 -0
  212. fhops-0.1.0a1/src/fhops/evaluation/reporting/__init__.py +1 -0
  213. fhops-0.1.0a1/src/fhops/model/pyomo_builder.py +15 -0
  214. fhops-0.1.0a1/src/fhops/optimization/__init__.py +6 -0
  215. fhops-0.1.0a1/src/fhops/optimization/constraints/__init__.py +1 -0
  216. fhops-0.1.0a1/src/fhops/optimization/heuristics/__init__.py +21 -0
  217. fhops-0.1.0a1/src/fhops/optimization/heuristics/ils.py +393 -0
  218. fhops-0.1.0a1/src/fhops/optimization/heuristics/multistart.py +217 -0
  219. fhops-0.1.0a1/src/fhops/optimization/heuristics/registry.py +422 -0
  220. fhops-0.1.0a1/src/fhops/optimization/heuristics/sa.py +650 -0
  221. fhops-0.1.0a1/src/fhops/optimization/heuristics/tabu.py +306 -0
  222. fhops-0.1.0a1/src/fhops/optimization/mip/__init__.py +6 -0
  223. fhops-0.1.0a1/src/fhops/optimization/mip/builder.py +258 -0
  224. fhops-0.1.0a1/src/fhops/optimization/mip/constraints/system_sequencing.py +96 -0
  225. fhops-0.1.0a1/src/fhops/optimization/mip/highs_driver.py +263 -0
  226. fhops-0.1.0a1/src/fhops/scenario/__init__.py +26 -0
  227. fhops-0.1.0a1/src/fhops/scenario/contract/__init__.py +25 -0
  228. fhops-0.1.0a1/src/fhops/scenario/contract/models.py +403 -0
  229. fhops-0.1.0a1/src/fhops/scenario/io/__init__.py +5 -0
  230. fhops-0.1.0a1/src/fhops/scenario/io/loaders.py +180 -0
  231. fhops-0.1.0a1/src/fhops/scenario/io/mobilisation.py +71 -0
  232. fhops-0.1.0a1/src/fhops/scenario/synthetic/__init__.py +25 -0
  233. fhops-0.1.0a1/src/fhops/scenario/synthetic/generator.py +805 -0
  234. fhops-0.1.0a1/src/fhops/scheduling/__init__.py +13 -0
  235. fhops-0.1.0a1/src/fhops/scheduling/geospatial.py +173 -0
  236. fhops-0.1.0a1/src/fhops/scheduling/mobilisation/__init__.py +15 -0
  237. fhops-0.1.0a1/src/fhops/scheduling/mobilisation/models.py +75 -0
  238. fhops-0.1.0a1/src/fhops/scheduling/systems/__init__.py +5 -0
  239. fhops-0.1.0a1/src/fhops/scheduling/systems/models.py +121 -0
  240. fhops-0.1.0a1/src/fhops/scheduling/timeline/__init__.py +5 -0
  241. fhops-0.1.0a1/src/fhops/scheduling/timeline/models.py +71 -0
  242. fhops-0.1.0a1/src/fhops/solve/heuristics/sa.py +15 -0
  243. fhops-0.1.0a1/src/fhops/solve/highs_mip.py +15 -0
  244. fhops-0.1.0a1/src/fhops/telemetry/__init__.py +6 -0
  245. fhops-0.1.0a1/src/fhops/telemetry/jsonl.py +60 -0
  246. fhops-0.1.0a1/src/fhops/telemetry/run_logger.py +222 -0
  247. fhops-0.1.0a1/src/fhops/telemetry/sqlite_store.py +227 -0
  248. fhops-0.1.0a1/tests/data/geo/blocks.geojson +30 -0
  249. fhops-0.1.0a1/tests/data/geo/invalid.geojson +1 -0
  250. fhops-0.1.0a1/tests/data/geo/landings.geojson +30 -0
  251. fhops-0.1.0a1/tests/data/invalid/blocks.csv +2 -0
  252. fhops-0.1.0a1/tests/data/invalid/calendar.csv +2 -0
  253. fhops-0.1.0a1/tests/data/invalid/landings.csv +2 -0
  254. fhops-0.1.0a1/tests/data/invalid/machines.csv +2 -0
  255. fhops-0.1.0a1/tests/data/invalid/mobilisation_distances.csv +2 -0
  256. fhops-0.1.0a1/tests/data/invalid/production_rates.csv +2 -0
  257. fhops-0.1.0a1/tests/data/invalid/scenario.yaml +11 -0
  258. fhops-0.1.0a1/tests/data/minimal/blocks.csv +2 -0
  259. fhops-0.1.0a1/tests/data/minimal/calendar.csv +2 -0
  260. fhops-0.1.0a1/tests/data/minimal/landings.csv +2 -0
  261. fhops-0.1.0a1/tests/data/minimal/machines.csv +2 -0
  262. fhops-0.1.0a1/tests/data/minimal/production_rates.csv +2 -0
  263. fhops-0.1.0a1/tests/data/minimal/scenario.yaml +9 -0
  264. fhops-0.1.0a1/tests/data/typical/blocks.csv +3 -0
  265. fhops-0.1.0a1/tests/data/typical/calendar.csv +5 -0
  266. fhops-0.1.0a1/tests/data/typical/crew_assignments.csv +3 -0
  267. fhops-0.1.0a1/tests/data/typical/geo.json +1 -0
  268. fhops-0.1.0a1/tests/data/typical/landings.csv +3 -0
  269. fhops-0.1.0a1/tests/data/typical/locked.yaml +16 -0
  270. fhops-0.1.0a1/tests/data/typical/machines.csv +3 -0
  271. fhops-0.1.0a1/tests/data/typical/mobilisation_distances.csv +5 -0
  272. fhops-0.1.0a1/tests/data/typical/production_rates.csv +5 -0
  273. fhops-0.1.0a1/tests/data/typical/scenario.yaml +24 -0
  274. fhops-0.1.0a1/tests/fixtures/benchmarks/minitoy_sa.json +21 -0
  275. fhops-0.1.0a1/tests/fixtures/kpi/deterministic.json +30 -0
  276. fhops-0.1.0a1/tests/fixtures/kpi/stochastic.json +19 -0
  277. fhops-0.1.0a1/tests/fixtures/playback/med42_assignments.csv +210 -0
  278. fhops-0.1.0a1/tests/fixtures/playback/med42_day.csv +37 -0
  279. fhops-0.1.0a1/tests/fixtures/playback/med42_day.parquet +0 -0
  280. fhops-0.1.0a1/tests/fixtures/playback/med42_shift.csv +210 -0
  281. fhops-0.1.0a1/tests/fixtures/playback/med42_shift.parquet +0 -0
  282. fhops-0.1.0a1/tests/fixtures/playback/minitoy_assignments.csv +22 -0
  283. fhops-0.1.0a1/tests/fixtures/playback/minitoy_day.csv +15 -0
  284. fhops-0.1.0a1/tests/fixtures/playback/minitoy_day.parquet +0 -0
  285. fhops-0.1.0a1/tests/fixtures/playback/minitoy_shift.csv +22 -0
  286. fhops-0.1.0a1/tests/fixtures/playback/minitoy_shift.parquet +0 -0
  287. fhops-0.1.0a1/tests/fixtures/regression/baseline.yaml +17 -0
  288. fhops-0.1.0a1/tests/fixtures/regression/blocks.csv +3 -0
  289. fhops-0.1.0a1/tests/fixtures/regression/calendar.csv +9 -0
  290. fhops-0.1.0a1/tests/fixtures/regression/landings.csv +2 -0
  291. fhops-0.1.0a1/tests/fixtures/regression/machines.csv +3 -0
  292. fhops-0.1.0a1/tests/fixtures/regression/mobilisation_distances.csv +5 -0
  293. fhops-0.1.0a1/tests/fixtures/regression/production_rates.csv +5 -0
  294. fhops-0.1.0a1/tests/fixtures/regression/regression.yaml +9 -0
  295. fhops-0.1.0a1/tests/heuristics/__init__.py +0 -0
  296. fhops-0.1.0a1/tests/heuristics/test_ils.py +105 -0
  297. fhops-0.1.0a1/tests/heuristics/test_ils_tabu.py +75 -0
  298. fhops-0.1.0a1/tests/heuristics/test_multistart.py +121 -0
  299. fhops-0.1.0a1/tests/heuristics/test_operators.py +300 -0
  300. fhops-0.1.0a1/tests/heuristics/test_registry.py +75 -0
  301. fhops-0.1.0a1/tests/heuristics/test_sa_batch.py +117 -0
  302. fhops-0.1.0a1/tests/heuristics/test_tabu.py +72 -0
  303. fhops-0.1.0a1/tests/test_analyze_tuner_reports.py +244 -0
  304. fhops-0.1.0a1/tests/test_benchmark_harness.py +189 -0
  305. fhops-0.1.0a1/tests/test_cli_playback.py +307 -0
  306. fhops-0.1.0a1/tests/test_cli_playback_exports.py +142 -0
  307. fhops-0.1.0a1/tests/test_cli_profiles.py +119 -0
  308. fhops-0.1.0a1/tests/test_cli_synth.py +141 -0
  309. fhops-0.1.0a1/tests/test_cli_telemetry.py +101 -0
  310. fhops-0.1.0a1/tests/test_cli_telemetry_report.py +101 -0
  311. fhops-0.1.0a1/tests/test_cli_tune.py +221 -0
  312. fhops-0.1.0a1/tests/test_cli_utils.py +70 -0
  313. fhops-0.1.0a1/tests/test_contract_edge_cases.py +221 -0
  314. fhops-0.1.0a1/tests/test_contract_validations.py +104 -0
  315. fhops-0.1.0a1/tests/test_geospatial_distances.py +27 -0
  316. fhops-0.1.0a1/tests/test_import.py +4 -0
  317. fhops-0.1.0a1/tests/test_kpi_regressions.py +116 -0
  318. fhops-0.1.0a1/tests/test_mobilisation.py +188 -0
  319. fhops-0.1.0a1/tests/test_playback.py +170 -0
  320. fhops-0.1.0a1/tests/test_playback_aggregates.py +357 -0
  321. fhops-0.1.0a1/tests/test_regression_integration.py +167 -0
  322. fhops-0.1.0a1/tests/test_run_tuning_benchmarks.py +201 -0
  323. fhops-0.1.0a1/tests/test_scenario_fixtures.py +34 -0
  324. fhops-0.1.0a1/tests/test_schedule_locking.py +256 -0
  325. fhops-0.1.0a1/tests/test_shift_calendar_loader.py +71 -0
  326. fhops-0.1.0a1/tests/test_stochastic_playback.py +114 -0
  327. fhops-0.1.0a1/tests/test_synthetic.py +39 -0
  328. fhops-0.1.0a1/tests/test_synthetic_dataset.py +254 -0
  329. fhops-0.1.0a1/tests/test_synthetic_validation.py +59 -0
  330. fhops-0.1.0a1/tests/test_system_roles.py +455 -0
  331. fhops-0.1.0a1/tests/test_telemetry_logging.py +20 -0
@@ -0,0 +1,168 @@
1
+ name: Analytics Notebooks (Full)
2
+
3
+ on:
4
+ schedule:
5
+ # Mondays at 06:00 UTC
6
+ - cron: '0 6 * * 1'
7
+ workflow_dispatch:
8
+
9
+ permissions:
10
+ contents: read
11
+ pages: write
12
+ id-token: write
13
+
14
+ jobs:
15
+ run-notebooks:
16
+ runs-on: ubuntu-latest
17
+
18
+ steps:
19
+ - name: Checkout
20
+ uses: actions/checkout@v4
21
+
22
+ - name: Set up Python
23
+ uses: actions/setup-python@v5
24
+ with:
25
+ python-version: '3.11'
26
+
27
+ - name: Install dependencies
28
+ run: |
29
+ python -m pip install --upgrade pip
30
+ pip install -e .[dev]
31
+ pip install -r docs/requirements.txt
32
+
33
+ - name: Telemetry tuning smoke report
34
+ run: |
35
+ mkdir -p tmp/ci-telemetry
36
+ python scripts/run_tuning_benchmarks.py \
37
+ --plan baseline-smoke \
38
+ --out-dir tmp/ci-telemetry \
39
+ --random-runs 1 \
40
+ --random-iters 50 \
41
+ --grid-iters 50 \
42
+ --grid-batch-size 1 \
43
+ --grid-preset balanced \
44
+ --bayes-trials 1 \
45
+ --bayes-iters 50 \
46
+ --summary-label weekly-full-notebooks
47
+
48
+ - name: Archive telemetry history snapshot
49
+ run: |
50
+ snapshot_dir=tmp/ci-telemetry/history
51
+ mkdir -p "$snapshot_dir"
52
+ snapshot_name="$(date -u +"%Y-%m-%dT%H%M%SZ")"
53
+ cp tmp/ci-telemetry/tuner_report.csv "$snapshot_dir/$snapshot_name.csv"
54
+ cp tmp/ci-telemetry/tuner_report.md "$snapshot_dir/$snapshot_name.md"
55
+ cp tmp/ci-telemetry/telemetry/runs.sqlite "$snapshot_dir/$snapshot_name.sqlite"
56
+
57
+ - name: Generate telemetry history comparison
58
+ run: |
59
+ python scripts/analyze_tuner_reports.py \
60
+ --report latest=tmp/ci-telemetry/tuner_report.csv \
61
+ --history-dir tmp/ci-telemetry/history \
62
+ --out-history-csv tmp/ci-telemetry/history_summary.csv \
63
+ --out-history-markdown tmp/ci-telemetry/history_summary.md \
64
+ --out-history-chart tmp/ci-telemetry/history_summary.html \
65
+ --out-summary-csv tmp/ci-telemetry/history_summary_latest.csv \
66
+ --out-summary-markdown tmp/ci-telemetry/history_summary_latest.md \
67
+ --out-history-delta-csv tmp/ci-telemetry/history_delta.csv \
68
+ --out-history-delta-markdown tmp/ci-telemetry/history_delta.md
69
+
70
+ - name: Execute analytics notebooks (full)
71
+ run: |
72
+ python scripts/run_analytics_notebooks.py --timeout 900 --keep-going
73
+
74
+ - name: Collect notebook artefacts
75
+ run: |
76
+ timestamp="$(date -u +"%Y-%m-%dT%H%M%SZ")"
77
+ out_dir="tmp/analytics-notebooks"
78
+ history_root="$out_dir/history"
79
+ run_dir="$history_root/$timestamp"
80
+ mkdir -p "$run_dir"
81
+ cp docs/examples/analytics/data/notebook_metadata.json "$out_dir/notebook_metadata_latest.json"
82
+ cp docs/examples/analytics/data/notebook_metadata.json "$run_dir/notebook_metadata.json"
83
+ tar -czf "$run_dir/notebooks.tar.gz" docs/examples/analytics/*.ipynb
84
+ if [ -d "$history_root" ]; then
85
+ cd "$history_root"
86
+ ls -1 | sort | head -n -4 | xargs -r -d '\n' rm -rf
87
+ fi
88
+ ls -R "$out_dir"
89
+
90
+ - name: Upload full notebook artefacts
91
+ uses: actions/upload-artifact@v4
92
+ with:
93
+ name: analytics-notebooks-full
94
+ path: tmp/analytics-notebooks
95
+ retention-days: 28
96
+
97
+ - name: Install Pandoc
98
+ run: |
99
+ sudo apt-get update
100
+ sudo apt-get install -y pandoc
101
+
102
+ - name: Build documentation
103
+ run: sphinx-build -b html docs _build/html -W
104
+
105
+ - name: Prepare Pages bundle
106
+ run: |
107
+ site_dir=tmp/pages
108
+ rm -rf "$site_dir"
109
+ mkdir -p "$site_dir"
110
+ cp -R _build/html/* "$site_dir/"
111
+ touch "$site_dir/.nojekyll"
112
+
113
+ publish_dir="$site_dir/telemetry"
114
+ mkdir -p "$publish_dir"
115
+ cp tmp/ci-telemetry/history_summary.csv "$publish_dir/" || true
116
+ cp tmp/ci-telemetry/history_summary.md "$publish_dir/" || true
117
+ cp tmp/ci-telemetry/history_summary.html "$publish_dir/" || true
118
+ cp tmp/ci-telemetry/tuner_report.md "$publish_dir/latest_tuner_report.md"
119
+ cp tmp/ci-telemetry/tuner_summary.md "$publish_dir/latest_tuner_summary.md" || true
120
+ cp tmp/ci-telemetry/tuner_summary.csv "$publish_dir/latest_tuner_summary.csv" || true
121
+ cp tmp/ci-telemetry/history_summary_latest.md "$publish_dir/latest_history_summary.md" || true
122
+ cp tmp/ci-telemetry/history_summary_latest.csv "$publish_dir/latest_history_summary.csv" || true
123
+ cp tmp/ci-telemetry/tuner_comparison.md "$publish_dir/latest_tuner_comparison.md" || true
124
+ cp tmp/ci-telemetry/tuner_comparison.csv "$publish_dir/latest_tuner_comparison.csv" || true
125
+ cp tmp/ci-telemetry/tuner_leaderboard.md "$publish_dir/latest_tuner_leaderboard.md" || true
126
+ cp tmp/ci-telemetry/tuner_leaderboard.csv "$publish_dir/latest_tuner_leaderboard.csv" || true
127
+ cp tmp/ci-telemetry/tuner_difficulty.md "$publish_dir/tuner_difficulty.md" || true
128
+ cp tmp/ci-telemetry/tuner_difficulty.csv "$publish_dir/tuner_difficulty.csv" || true
129
+ cp tmp/ci-telemetry/history_delta.md "$publish_dir/history_delta.md" || true
130
+ cp tmp/ci-telemetry/history_delta.csv "$publish_dir/history_delta.csv" || true
131
+
132
+ notebooks_dir="$publish_dir/notebooks"
133
+ rm -rf "$notebooks_dir"
134
+ mkdir -p "$notebooks_dir"
135
+ cp docs/examples/analytics/data/notebook_metadata.json "$notebooks_dir/metadata_latest.json" || true
136
+ cp tmp/analytics-notebooks/notebook_metadata_latest.json "$notebooks_dir/notebook_metadata_latest.json" || true
137
+ if [ -d tmp/analytics-notebooks/history ]; then
138
+ cp -R tmp/analytics-notebooks/history "$notebooks_dir/"
139
+ fi
140
+
141
+ render_md_to_html() {
142
+ local source_file="$1"
143
+ local target_file="$2"
144
+ if [ -f "$source_file" ]; then
145
+ pandoc "$source_file" -f gfm -t html5 -s -o "$target_file"
146
+ fi
147
+ }
148
+
149
+ render_md_to_html "$publish_dir/latest_history_summary.md" "$publish_dir/latest_history_summary.html"
150
+ render_md_to_html "$publish_dir/latest_tuner_report.md" "$publish_dir/latest_tuner_report.html"
151
+ render_md_to_html "$publish_dir/latest_tuner_comparison.md" "$publish_dir/latest_tuner_comparison.html"
152
+ render_md_to_html "$publish_dir/latest_tuner_leaderboard.md" "$publish_dir/latest_tuner_leaderboard.html"
153
+ render_md_to_html "$publish_dir/tuner_difficulty.md" "$publish_dir/tuner_difficulty.html"
154
+ render_md_to_html "$publish_dir/history_delta.md" "$publish_dir/history_delta.html"
155
+
156
+ - name: Upload history pages artifact
157
+ uses: actions/upload-pages-artifact@v3
158
+ with:
159
+ path: tmp/pages
160
+
161
+ deploy:
162
+ needs: run-notebooks
163
+ runs-on: ubuntu-latest
164
+ environment:
165
+ name: github-pages
166
+ steps:
167
+ - name: Deploy to GitHub Pages
168
+ uses: actions/deploy-pages@v4
@@ -0,0 +1,176 @@
1
+ name: CI
2
+
3
+ on:
4
+ push:
5
+ branches:
6
+ - main
7
+ - 'feature/**'
8
+ pull_request:
9
+
10
+ permissions:
11
+ contents: read
12
+ pages: write
13
+ id-token: write
14
+
15
+ concurrency:
16
+ group: "pages"
17
+ cancel-in-progress: true
18
+
19
+ jobs:
20
+ lint-test-docs:
21
+ runs-on: ubuntu-latest
22
+
23
+ steps:
24
+ - name: Checkout
25
+ uses: actions/checkout@v4
26
+
27
+ - name: Set up Python
28
+ uses: actions/setup-python@v5
29
+ with:
30
+ python-version: '3.11'
31
+
32
+ - name: Restore telemetry history cache
33
+ uses: actions/cache@v3
34
+ with:
35
+ path: tmp/ci-telemetry/history
36
+ key: telemetry-history-${{ github.ref_name }}
37
+ restore-keys: |
38
+ telemetry-history-
39
+
40
+ - name: Install dependencies
41
+ run: |
42
+ python -m pip install --upgrade pip
43
+ pip install -e .[dev]
44
+ pip install -r docs/requirements.txt
45
+ pip install altair
46
+
47
+ - name: Ruff format check
48
+ run: ruff format --check src tests
49
+
50
+ - name: Ruff lint
51
+ run: ruff check src tests
52
+
53
+ - name: Mypy
54
+ run: mypy src
55
+
56
+ - name: Pytest
57
+ run: pytest
58
+
59
+ - name: Pre-commit hooks
60
+ run: pre-commit run --all-files
61
+
62
+ - name: Telemetry tuning smoke report
63
+ run: |
64
+ mkdir -p tmp/ci-telemetry
65
+ python scripts/run_tuning_benchmarks.py \
66
+ --plan baseline-smoke \
67
+ --out-dir tmp/ci-telemetry \
68
+ --random-runs 1 \
69
+ --random-iters 50 \
70
+ --grid-iters 50 \
71
+ --grid-batch-size 1 \
72
+ --grid-preset balanced \
73
+ --bayes-trials 1 \
74
+ --bayes-iters 50 \
75
+ --summary-label latest
76
+
77
+ - name: Archive telemetry history snapshot
78
+ run: |
79
+ snapshot_dir=tmp/ci-telemetry/history
80
+ mkdir -p "$snapshot_dir"
81
+ snapshot_name="$(date -u +"%Y-%m-%dT%H%M%SZ")"
82
+ cp tmp/ci-telemetry/tuner_report.csv "$snapshot_dir/$snapshot_name.csv"
83
+ cp tmp/ci-telemetry/tuner_report.md "$snapshot_dir/$snapshot_name.md"
84
+ cp tmp/ci-telemetry/telemetry/runs.sqlite "$snapshot_dir/$snapshot_name.sqlite"
85
+
86
+ - name: Generate telemetry history comparison
87
+ run: |
88
+ python scripts/analyze_tuner_reports.py \
89
+ --report latest=tmp/ci-telemetry/tuner_report.csv \
90
+ --history-dir tmp/ci-telemetry/history \
91
+ --out-history-csv tmp/ci-telemetry/history_summary.csv \
92
+ --out-history-markdown tmp/ci-telemetry/history_summary.md \
93
+ --out-history-chart tmp/ci-telemetry/history_summary.html \
94
+ --out-summary-csv tmp/ci-telemetry/history_summary_latest.csv \
95
+ --out-summary-markdown tmp/ci-telemetry/history_summary_latest.md \
96
+ --out-history-delta-csv tmp/ci-telemetry/history_delta.csv \
97
+ --out-history-delta-markdown tmp/ci-telemetry/history_delta.md
98
+
99
+ - name: Upload telemetry report artifact
100
+ uses: actions/upload-artifact@v4
101
+ with:
102
+ name: telemetry-report
103
+ path: tmp/ci-telemetry
104
+
105
+ - name: Analytics notebooks (light)
106
+ run: python scripts/run_analytics_notebooks.py --light --timeout 300
107
+
108
+ - name: Install Pandoc
109
+ run: |
110
+ sudo apt-get update
111
+ sudo apt-get install -y pandoc
112
+
113
+ - name: Build documentation
114
+ run: sphinx-build -b html docs _build/html -W
115
+
116
+ - name: Prepare Pages bundle
117
+ run: |
118
+ site_dir=tmp/pages
119
+ rm -rf "$site_dir"
120
+ mkdir -p "$site_dir"
121
+ cp -R _build/html/* "$site_dir/"
122
+ touch "$site_dir/.nojekyll"
123
+
124
+ publish_dir="$site_dir/telemetry"
125
+ mkdir -p "$publish_dir"
126
+ cp tmp/ci-telemetry/history_summary.csv "$publish_dir/" || true
127
+ cp tmp/ci-telemetry/history_summary.md "$publish_dir/" || true
128
+ cp tmp/ci-telemetry/history_summary.html "$publish_dir/" || true
129
+ cp tmp/ci-telemetry/tuner_report.md "$publish_dir/latest_tuner_report.md"
130
+ cp tmp/ci-telemetry/tuner_summary.md "$publish_dir/latest_tuner_summary.md" || true
131
+ cp tmp/ci-telemetry/tuner_summary.csv "$publish_dir/latest_tuner_summary.csv" || true
132
+ cp tmp/ci-telemetry/history_summary_latest.md "$publish_dir/latest_history_summary.md" || true
133
+ cp tmp/ci-telemetry/history_summary_latest.csv "$publish_dir/latest_history_summary.csv" || true
134
+ cp tmp/ci-telemetry/tuner_comparison.md "$publish_dir/latest_tuner_comparison.md" || true
135
+ cp tmp/ci-telemetry/tuner_comparison.csv "$publish_dir/latest_tuner_comparison.csv" || true
136
+ cp tmp/ci-telemetry/tuner_leaderboard.md "$publish_dir/latest_tuner_leaderboard.md" || true
137
+ cp tmp/ci-telemetry/tuner_leaderboard.csv "$publish_dir/latest_tuner_leaderboard.csv" || true
138
+ cp tmp/ci-telemetry/tuner_difficulty.md "$publish_dir/tuner_difficulty.md" || true
139
+ cp tmp/ci-telemetry/tuner_difficulty.csv "$publish_dir/tuner_difficulty.csv" || true
140
+ cp tmp/ci-telemetry/history_delta.md "$publish_dir/history_delta.md" || true
141
+ cp tmp/ci-telemetry/history_delta.csv "$publish_dir/history_delta.csv" || true
142
+
143
+ render_md_to_html() {
144
+ local source_file="$1"
145
+ local target_file="$2"
146
+ if [ -f "$source_file" ]; then
147
+ pandoc "$source_file" -f gfm -t html5 -s -o "$target_file"
148
+ fi
149
+ }
150
+
151
+ render_md_to_html "$publish_dir/latest_history_summary.md" "$publish_dir/latest_history_summary.html"
152
+ render_md_to_html "$publish_dir/latest_tuner_report.md" "$publish_dir/latest_tuner_report.html"
153
+ render_md_to_html "$publish_dir/latest_tuner_comparison.md" "$publish_dir/latest_tuner_comparison.html"
154
+ render_md_to_html "$publish_dir/latest_tuner_leaderboard.md" "$publish_dir/latest_tuner_leaderboard.html"
155
+ render_md_to_html "$publish_dir/tuner_difficulty.md" "$publish_dir/tuner_difficulty.html"
156
+ render_md_to_html "$publish_dir/history_delta.md" "$publish_dir/history_delta.html"
157
+
158
+ - name: Inspect publish bundle
159
+ run: |
160
+ echo "Contents of tmp/pages:" && ls -R tmp/pages || true
161
+
162
+ - name: Upload history pages artifact
163
+ uses: actions/upload-pages-artifact@v3
164
+ with:
165
+ path: tmp/pages
166
+
167
+ deploy-history:
168
+ needs: lint-test-docs
169
+ if: github.ref == 'refs/heads/main'
170
+ runs-on: ubuntu-latest
171
+ environment:
172
+ name: github-pages
173
+ steps:
174
+ - name: Deploy history to GitHub Pages
175
+ id: deployment
176
+ uses: actions/deploy-pages@v4
@@ -0,0 +1,37 @@
1
+ name: Release Build Verification
2
+
3
+ on:
4
+ push:
5
+ tags:
6
+ - 'v*'
7
+ workflow_dispatch:
8
+
9
+ # Note: this job only builds and uploads artifacts. Publishing to
10
+ # TestPyPI/PyPI remains a manual `twine upload` step documented in
11
+ # CODING_AGENT.md / notes/release_candidate_prep.md so maintainers
12
+ # can verify builds before pushing to production indexes.
13
+ jobs:
14
+ build:
15
+ runs-on: ubuntu-latest
16
+ steps:
17
+ - name: Checkout
18
+ uses: actions/checkout@v4
19
+
20
+ - name: Set up Python
21
+ uses: actions/setup-python@v5
22
+ with:
23
+ python-version: '3.11'
24
+
25
+ - name: Install Hatch
26
+ run: |
27
+ python -m pip install --upgrade pip
28
+ pip install hatch
29
+
30
+ - name: Build package
31
+ run: hatch run release:build
32
+
33
+ - name: Upload dist artifacts
34
+ uses: actions/upload-artifact@v4
35
+ with:
36
+ name: fhops-dist
37
+ path: dist
@@ -0,0 +1,215 @@
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[codz]
4
+ *$py.class
5
+
6
+ # C extensions
7
+ *.so
8
+
9
+ # Distribution / packaging
10
+ .Python
11
+ build/
12
+ develop-eggs/
13
+ dist/
14
+ downloads/
15
+ eggs/
16
+ .eggs/
17
+ lib/
18
+ lib64/
19
+ parts/
20
+ sdist/
21
+ var/
22
+ wheels/
23
+ share/python-wheels/
24
+ *.egg-info/
25
+ .installed.cfg
26
+ *.egg
27
+ MANIFEST
28
+
29
+ # PyInstaller
30
+ # Usually these files are written by a python script from a template
31
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
32
+ *.manifest
33
+ *.spec
34
+
35
+ # Installer logs
36
+ pip-log.txt
37
+ pip-delete-this-directory.txt
38
+
39
+ # Unit test / coverage reports
40
+ htmlcov/
41
+ .tox/
42
+ .nox/
43
+ .coverage
44
+ .coverage.*
45
+ .cache
46
+ nosetests.xml
47
+ coverage.xml
48
+ *.cover
49
+ *.py.cover
50
+ .hypothesis/
51
+ .pytest_cache/
52
+ cover/
53
+
54
+ # Translations
55
+ *.mo
56
+ *.pot
57
+
58
+ # Django stuff:
59
+ *.log
60
+ local_settings.py
61
+ db.sqlite3
62
+ db.sqlite3-journal
63
+
64
+ # Flask stuff:
65
+ instance/
66
+ .webassets-cache
67
+
68
+ # Scrapy stuff:
69
+ .scrapy
70
+
71
+ # Sphinx documentation
72
+ docs/_build/
73
+
74
+ # PyBuilder
75
+ .pybuilder/
76
+ target/
77
+
78
+ # Jupyter Notebook
79
+ .ipynb_checkpoints
80
+
81
+ # IPython
82
+ profile_default/
83
+ ipython_config.py
84
+
85
+ # pyenv
86
+ # For a library or package, you might want to ignore these files since the code is
87
+ # intended to run in multiple environments; otherwise, check them in:
88
+ # .python-version
89
+
90
+ # pipenv
91
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
93
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
94
+ # install all needed dependencies.
95
+ #Pipfile.lock
96
+
97
+ # UV
98
+ # Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
99
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
100
+ # commonly ignored for libraries.
101
+ #uv.lock
102
+
103
+ # poetry
104
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
105
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
106
+ # commonly ignored for libraries.
107
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
108
+ #poetry.lock
109
+ #poetry.toml
110
+
111
+ # pdm
112
+ # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
113
+ # pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
114
+ # https://pdm-project.org/en/latest/usage/project/#working-with-version-control
115
+ #pdm.lock
116
+ #pdm.toml
117
+ .pdm-python
118
+ .pdm-build/
119
+
120
+ # pixi
121
+ # Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
122
+ #pixi.lock
123
+ # Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
124
+ # in the .venv directory. It is recommended not to include this directory in version control.
125
+ .pixi
126
+
127
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
128
+ __pypackages__/
129
+
130
+ # Celery stuff
131
+ celerybeat-schedule
132
+ celerybeat.pid
133
+
134
+ # SageMath parsed files
135
+ *.sage.py
136
+
137
+ # Environments
138
+ .env
139
+ .envrc
140
+ .venv
141
+ env/
142
+ venv/
143
+ ENV/
144
+ env.bak/
145
+ venv.bak/
146
+
147
+ # Spyder project settings
148
+ .spyderproject
149
+ .spyproject
150
+
151
+ # Rope project settings
152
+ .ropeproject
153
+
154
+ # mkdocs documentation
155
+ /site
156
+
157
+ # mypy
158
+ .mypy_cache/
159
+ .dmypy.json
160
+ dmypy.json
161
+
162
+ # Pyre type checker
163
+ .pyre/
164
+
165
+ # pytype static type analyzer
166
+ .pytype/
167
+
168
+ # Cython debug symbols
169
+ cython_debug/
170
+
171
+ # PyCharm
172
+ # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
173
+ # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
174
+ # and can be added to the global gitignore or merged into this file. For a more nuclear
175
+ # option (not recommended) you can uncomment the following to ignore the entire idea folder.
176
+ #.idea/
177
+
178
+ # Abstra
179
+ # Abstra is an AI-powered process automation framework.
180
+ # Ignore directories containing user credentials, local state, and settings.
181
+ # Learn more at https://abstra.io/docs
182
+ .abstra/
183
+
184
+ # Visual Studio Code
185
+ # Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
186
+ # that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
187
+ # and can be added to the global gitignore or merged into this file. However, if you prefer,
188
+ # you could uncomment the following to ignore the entire vscode folder
189
+ # .vscode/
190
+
191
+ # Ruff stuff:
192
+ .ruff_cache/
193
+
194
+ # PyPI configuration file
195
+ .pypirc
196
+
197
+ # Cursor
198
+ # Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
199
+ # exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
200
+ # refer to https://docs.cursor.com/context/ignore-files
201
+ .cursorignore
202
+ .cursorindexingignore
203
+
204
+ # Marimo
205
+ marimo/_static/
206
+ marimo/_lsp/
207
+ __marimo__/
208
+
209
+ # example output files
210
+ examples/minitoy/out/
211
+
212
+ .vscode
213
+ .continue
214
+ tmp/
215
+ notes/coding-agent-conversation-log.md
@@ -0,0 +1,31 @@
1
+ repos:
2
+ - repo: https://github.com/astral-sh/ruff-pre-commit
3
+ rev: v0.14.5
4
+ hooks:
5
+ - id: ruff
6
+ args: ["--fix"]
7
+ - id: ruff-format
8
+ - repo: https://github.com/pre-commit/mirrors-mypy
9
+ rev: v1.18.2
10
+ hooks:
11
+ - id: mypy
12
+ args: ["src"]
13
+ pass_filenames: false
14
+ additional_dependencies: []
15
+ - repo: https://github.com/pre-commit/pre-commit-hooks
16
+ rev: v6.0.0
17
+ hooks:
18
+ - id: check-added-large-files
19
+ - id: check-merge-conflict
20
+ - id: end-of-file-fixer
21
+ exclude: "^\\.continue/"
22
+ - id: trailing-whitespace
23
+ exclude: "^\\.continue/"
24
+ - repo: local
25
+ hooks:
26
+ - id: require-changelog-update
27
+ name: Require changelog entry
28
+ entry: bash scripts/check_changelog.sh
29
+ language: system
30
+ always_run: true
31
+ pass_filenames: false
@@ -0,0 +1,10 @@
1
+ version: 2
2
+ build:
3
+ os: ubuntu-22.04
4
+ tools:
5
+ python: "3.11"
6
+ sphinx:
7
+ configuration: docs/conf.py
8
+ python:
9
+ install:
10
+ - requirements: docs/requirements.txt