solarwindpy 0.0.1.dev0__py3-none-any.whl โ†’ 0.1.1__py3-none-any.whl

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.

Potentially problematic release.


This version of solarwindpy might be problematic. Click here for more details.

Files changed (412) hide show
  1. plans/.velocity/metrics.json +96 -0
  2. plans/0-overview-template.md +268 -0
  3. plans/N-phase-template.md +106 -0
  4. plans/PLAN_AUDIT_SUMMARY.md +173 -0
  5. plans/TEMPLATE-USAGE-GUIDE.md +198 -0
  6. plans/__init__.py +1 -0
  7. plans/abandoned/compaction-agent-system/0-Overview.md +123 -0
  8. plans/abandoned/compaction-agent-system/agents-index-update-plan.md +109 -0
  9. plans/abandoned/compaction-agent-system/compacted_state.md +85 -0
  10. plans/abandoned/compaction-agent-system/implementation-plan.md +107 -0
  11. plans/abandoned/compaction-agent-system/system-validation-report.md +159 -0
  12. plans/abandoned/compaction-agent-system/usage-guide.md +210 -0
  13. plans/abandoned/hook-system-enhancement/0-Overview.md +214 -0
  14. plans/abandoned/hook-system-enhancement/1-Phase1-Core-Infrastructure.md +313 -0
  15. plans/abandoned/hook-system-enhancement/2-Phase2-Intelligent-Testing.md +385 -0
  16. plans/abandoned/hook-system-enhancement/3-Phase3-Physics-Validation.md +444 -0
  17. plans/abandoned/hook-system-enhancement/4-Phase4-Performance-Monitoring.md +458 -0
  18. plans/abandoned/hook-system-enhancement/5-Phase5-Developer-Experience.md +532 -0
  19. plans/abandoned/hook-system-enhancement/6-Implementation-Timeline.md +274 -0
  20. plans/abandoned/hook-system-enhancement/7-Risk-Management.md +376 -0
  21. plans/abandoned/hook-system-enhancement/8-Testing-Strategy.md +579 -0
  22. plans/abandoned/readthedocs-automation/0-Overview.md +247 -0
  23. plans/abandoned/readthedocs-automation/1-Emergency-Documentation-Fixes.md +270 -0
  24. plans/abandoned/readthedocs-automation/2-Template-System-Enhancement.md +811 -0
  25. plans/abandoned/readthedocs-automation/3-Quality-Audit-ReadTheDocs-Integration.md +844 -0
  26. plans/abandoned/readthedocs-automation/4-Plan-Consolidation-Cleanup.md +632 -0
  27. plans/abandoned/readthedocs-automation/9-Closeout.md +207 -0
  28. plans/abandoned/readthedocs-automation/ABANDONMENT_REASON.md +72 -0
  29. plans/cicd-architecture-redesign/0-Overview.md +193 -0
  30. plans/cicd-architecture-redesign/1-Workflow-Creation.md +103 -0
  31. plans/cicd-architecture-redesign/2-Version-Detection.md +123 -0
  32. plans/cicd-architecture-redesign/3-Deployment-Gates.md +169 -0
  33. plans/cicd-architecture-redesign/4-RC-Testing.md +194 -0
  34. plans/cicd-architecture-redesign/5-TestPyPI-Validation.md +264 -0
  35. plans/cicd-architecture-redesign/6-Production-Release.md +263 -0
  36. plans/cicd-architecture-redesign/7-Cleanup.md +243 -0
  37. plans/cicd-architecture-redesign/8-Documentation.md +285 -0
  38. plans/cicd-architecture-redesign/Closeout.md +225 -0
  39. plans/closeout-template.md +259 -0
  40. plans/completed/circular-import-audit/0-Overview.md +152 -0
  41. plans/completed/circular-import-audit/1-Static-Dependency-Analysis.md +62 -0
  42. plans/completed/circular-import-audit/2-Dynamic-Import-Testing.md +56 -0
  43. plans/completed/circular-import-audit/3-Performance-Impact-Assessment.md +56 -0
  44. plans/completed/circular-import-audit/4-Issue-Remediation.md +78 -0
  45. plans/completed/circular-import-audit/5-Preventive-Infrastructure.md +89 -0
  46. plans/completed/claude-settings-ecosystem-alignment/0-Overview.md +162 -0
  47. plans/completed/claude-settings-ecosystem-alignment/1-Security-Foundation.md +148 -0
  48. plans/completed/claude-settings-ecosystem-alignment/2-Hook-Integration.md +158 -0
  49. plans/completed/claude-settings-ecosystem-alignment/3-Agent-System-Integration.md +177 -0
  50. plans/completed/claude-settings-ecosystem-alignment/4-Enhanced-Workflow-Automation.md +159 -0
  51. plans/completed/claude-settings-ecosystem-alignment/5-Validation-Monitoring.md +181 -0
  52. plans/completed/claude-settings-ecosystem-alignment/compacted_session_state.md +290 -0
  53. plans/completed/combined_plan_with_checklist_documentation/1-Overview-and-Goals.md +51 -0
  54. plans/completed/combined_plan_with_checklist_documentation/2-Toolchain-and-Hosting.md +69 -0
  55. plans/completed/combined_plan_with_checklist_documentation/3-Repository-Structure.md +61 -0
  56. plans/completed/combined_plan_with_checklist_documentation/4-Configuration-and-Standards.md +70 -0
  57. plans/completed/combined_plan_with_checklist_documentation/5-Documentation-Content.md +62 -0
  58. plans/completed/combined_plan_with_checklist_documentation/6-CI-CD-and-Validation.md +58 -0
  59. plans/completed/combined_plan_with_checklist_documentation/7-Maintenance.md +55 -0
  60. plans/completed/combined_test_plan_with_checklist_fitfunctions/0-Overview.md +135 -0
  61. plans/completed/combined_test_plan_with_checklist_fitfunctions/1-Common-fixtures.md +59 -0
  62. plans/completed/combined_test_plan_with_checklist_fitfunctions/10-power_laws.md +56 -0
  63. plans/completed/combined_test_plan_with_checklist_fitfunctions/2-core.py-FitFunction.md +118 -0
  64. plans/completed/combined_test_plan_with_checklist_fitfunctions/3-gaussians.py-Gaussian-GaussianNormalized-GaussianLn.md +69 -0
  65. plans/completed/combined_test_plan_with_checklist_fitfunctions/4-trend_fits.py-TrendFit.md +99 -0
  66. plans/completed/combined_test_plan_with_checklist_fitfunctions/5-plots.py-FFPlot.md +98 -0
  67. plans/completed/combined_test_plan_with_checklist_fitfunctions/6-tex_info.py-TeXinfo.md +79 -0
  68. plans/completed/combined_test_plan_with_checklist_fitfunctions/7-Justification.md +49 -0
  69. plans/completed/combined_test_plan_with_checklist_fitfunctions/8-exponentials.md +64 -0
  70. plans/completed/combined_test_plan_with_checklist_fitfunctions/9-lines.md +58 -0
  71. plans/completed/combined_test_plan_with_checklist_plotting/0-Overview.md +142 -0
  72. plans/completed/combined_test_plan_with_checklist_plotting/1-base.py.md +90 -0
  73. plans/completed/combined_test_plan_with_checklist_plotting/10-labels-special.py.md +102 -0
  74. plans/completed/combined_test_plan_with_checklist_plotting/11-labels-chemistry.py.md +212 -0
  75. plans/completed/combined_test_plan_with_checklist_plotting/12-labels-composition.py.md +242 -0
  76. plans/completed/combined_test_plan_with_checklist_plotting/13-labels-datetime.py.md +247 -0
  77. plans/completed/combined_test_plan_with_checklist_plotting/14-labels-elemental_abundance.py.md +274 -0
  78. plans/completed/combined_test_plan_with_checklist_plotting/15-visual-validation.md +256 -0
  79. plans/completed/combined_test_plan_with_checklist_plotting/16-integration-testing.md +266 -0
  80. plans/completed/combined_test_plan_with_checklist_plotting/17-performance-benchmarks.md +267 -0
  81. plans/completed/combined_test_plan_with_checklist_plotting/18-Fixtures-and-Utilities.md +86 -0
  82. plans/completed/combined_test_plan_with_checklist_plotting/2-agg_plot.py.md +90 -0
  83. plans/completed/combined_test_plan_with_checklist_plotting/3-histograms.py.md +201 -0
  84. plans/completed/combined_test_plan_with_checklist_plotting/4-scatter.py.md +167 -0
  85. plans/completed/combined_test_plan_with_checklist_plotting/5-spiral.py.md +216 -0
  86. plans/completed/combined_test_plan_with_checklist_plotting/6-orbits.py.md +108 -0
  87. plans/completed/combined_test_plan_with_checklist_plotting/7-tools.py.md +86 -0
  88. plans/completed/combined_test_plan_with_checklist_plotting/8-select_data_from_figure.py.md +97 -0
  89. plans/completed/combined_test_plan_with_checklist_plotting/9-labels-base.py.md +88 -0
  90. plans/completed/combined_test_plan_with_checklist_solar_activity/.gitkeep +0 -0
  91. plans/completed/combined_test_plan_with_checklist_solar_activity/0-Overview.md +170 -0
  92. plans/completed/combined_test_plan_with_checklist_solar_activity/1-Package-Entry-Point-__init__.py.md +121 -0
  93. plans/completed/combined_test_plan_with_checklist_solar_activity/2-Core-Base-Classes-base.py.md +142 -0
  94. plans/completed/combined_test_plan_with_checklist_solar_activity/3-Plotting-Helpers-plots.py.md +123 -0
  95. plans/completed/combined_test_plan_with_checklist_solar_activity/4-LISIRD-Sub-package.md +119 -0
  96. plans/completed/combined_test_plan_with_checklist_solar_activity/5-Extrema-Calculator.md +103 -0
  97. plans/completed/combined_test_plan_with_checklist_solar_activity/6-Sunspot-Number-Sub-package.md +163 -0
  98. plans/completed/combined_test_plan_with_checklist_solar_activity/7-Sunspot-Number-Init.py.md +217 -0
  99. plans/completed/combined_test_plan_with_checklist_solar_activity/compacted_state.md +52 -0
  100. plans/completed/compaction-agent-modernization/0-Overview.md +156 -0
  101. plans/completed/compaction-agent-modernization/1-Architecture-Audit-Gap-Analysis.md +132 -0
  102. plans/completed/compaction-agent-modernization/2-Token-Baseline-Recalibration.md +153 -0
  103. plans/completed/compaction-agent-modernization/3-Agent-Reference-Updates.md +184 -0
  104. plans/completed/compaction-agent-modernization/4-Compression-Algorithm-Modernization.md +238 -0
  105. plans/completed/compaction-agent-modernization/5-Workflow-Integration-Streamlining.md +252 -0
  106. plans/completed/compaction-agent-modernization/6-Template-Structure-Optimization.md +240 -0
  107. plans/completed/compaction-agent-modernization/7-Integration-Testing-Validation.md +292 -0
  108. plans/completed/compaction-hook-enhancement/0-Overview.md +150 -0
  109. plans/completed/compaction-hook-enhancement/1-Token-Estimation-Enhancement.md +179 -0
  110. plans/completed/compaction-hook-enhancement/2-Compression-Intelligence.md +294 -0
  111. plans/completed/compaction-hook-enhancement/3-Git-Integration-Metadata.md +310 -0
  112. plans/completed/compaction-hook-enhancement/4-Session-Continuity-Features.md +358 -0
  113. plans/completed/compaction-hook-enhancement/5-Testing-Strategy.md +404 -0
  114. plans/completed/compaction-hook-enhancement/6-Integration-Roadmap.md +319 -0
  115. plans/completed/compaction-hook-enhancement/compacted_state.md +142 -0
  116. plans/completed/docstring-audit-enhancement/0-Overview.md +274 -0
  117. plans/completed/docstring-audit-enhancement/1-Infrastructure-Setup-and-Validation-Tools.md +206 -0
  118. plans/completed/docstring-audit-enhancement/2-Core-Physics-Modules-Enhancement.md +237 -0
  119. plans/completed/docstring-audit-enhancement/3-Fitfunctions-Mathematical-Modules-Enhancement.md +188 -0
  120. plans/completed/docstring-audit-enhancement/4-Plotting-Visualization-Modules-Enhancement.md +243 -0
  121. plans/completed/docstring-audit-enhancement/5-Specialized-Modules-Enhancement.md +216 -0
  122. plans/completed/docstring-audit-enhancement/6-Validation-and-Integration.md +216 -0
  123. plans/completed/fitfunctions-testing-implementation/0-Overview.md +130 -0
  124. plans/completed/fitfunctions-testing-implementation/1-Test-Infrastructure-Setup.md +79 -0
  125. plans/completed/fitfunctions-testing-implementation/2-Common-Fixtures-Test-Utilities.md +104 -0
  126. plans/completed/fitfunctions-testing-implementation/3-Core-FitFunction-Testing.md +168 -0
  127. plans/completed/fitfunctions-testing-implementation/4-Specialized-Function-Classes.md +210 -0
  128. plans/completed/fitfunctions-testing-implementation/5-Advanced-Classes-Testing.md +214 -0
  129. plans/completed/fitfunctions-testing-implementation/6-Plotting-Integration-Testing.md +231 -0
  130. plans/completed/fitfunctions-testing-implementation/7-Extended-Coverage-BONUS.md +184 -0
  131. plans/completed/numpy-docstring-conversion-plan/numpy-docstring-conversion-plan.md +118 -0
  132. plans/completed/pr-review-remediation/0-Overview.md +138 -0
  133. plans/completed/pr-review-remediation/1-Critical-Safety-Improvements.md +179 -0
  134. plans/completed/pr-review-remediation/2-Smart-Timeouts-Validation.md +399 -0
  135. plans/completed/pr-review-remediation/3-Enhanced-GitHub-Integration.md +258 -0
  136. plans/completed/pr-review-remediation/compacted_state.md +66 -0
  137. plans/completed/python-310-migration/0-Overview.md +390 -0
  138. plans/completed/python-310-migration/1-Planning-Setup.md +164 -0
  139. plans/completed/python-310-migration/2-Implementation.md +256 -0
  140. plans/completed/python-310-migration/3-Testing-Validation.md +335 -0
  141. plans/completed/python-310-migration/4-Documentation-Release.md +274 -0
  142. plans/completed/python-310-migration/5-Closeout.md +252 -0
  143. plans/completed/requirements-management-consolidation/0-Overview.md +118 -0
  144. plans/completed/requirements-management-consolidation/1-Documentation-Validation-Environment-Setup.md +116 -0
  145. plans/completed/requirements-management-consolidation/2-Requirements-Consolidation.md +161 -0
  146. plans/completed/requirements-management-consolidation/3-Workflow-Automation-Final-Integration.md +196 -0
  147. plans/completed/single-ecosystem-plan-implementation/0-Overview.md +83 -0
  148. plans/completed/single-ecosystem-plan-implementation/1-Plan-Preservation-Session-Management.md +38 -0
  149. plans/completed/single-ecosystem-plan-implementation/2-File-Structure-Optimization.md +43 -0
  150. plans/completed/single-ecosystem-plan-implementation/3-Plan-Migration-Archive-Setup.md +82 -0
  151. plans/completed/single-ecosystem-plan-implementation/4-Agent-System-Transformation.md +108 -0
  152. plans/completed/single-ecosystem-plan-implementation/5-Template-System-Enhancement.md +131 -0
  153. plans/completed/single-ecosystem-plan-implementation/6-Final-Validation-Testing.md +120 -0
  154. plans/completed/test-directory-consolidation/0-Overview.md +51 -0
  155. plans/completed/test-directory-consolidation/1-Structure-Preparation.md +82 -0
  156. plans/completed/test-directory-consolidation/2-File-Migration.md +100 -0
  157. plans/completed/test-directory-consolidation/3-Import-Transformation.md +117 -0
  158. plans/completed/test-directory-consolidation/4-Configuration-Consolidation.md +140 -0
  159. plans/completed/test-directory-consolidation/5-Validation.md +152 -0
  160. plans/completed/test-directory-consolidation/6-Cleanup.md +156 -0
  161. plans/completed/test-planning-agents-architecture/0-Overview.md +79 -0
  162. plans/completed/test-planning-agents-architecture/1-Branch-Isolation-Testing.md +49 -0
  163. plans/completed/test-planning-agents-architecture/2-Cross-Branch-Coordination.md +51 -0
  164. plans/completed/test-planning-agents-architecture/3-Merge-Workflow-Testing.md +48 -0
  165. plans/deployment-semver-pypi-rtd/0-Overview.md +463 -0
  166. plans/deployment-semver-pypi-rtd/1-Semantic-Versioning-Foundation.md +136 -0
  167. plans/deployment-semver-pypi-rtd/2-PyPI-Deployment-Infrastructure.md +168 -0
  168. plans/deployment-semver-pypi-rtd/3-Release-Automation.md +214 -0
  169. plans/deployment-semver-pypi-rtd/4-Plan-Closeout.md +543 -0
  170. plans/deployment-semver-pypi-rtd/compacted_session_state.md +172 -0
  171. plans/deployment-semver-pypi-rtd/compacted_state.md +131 -0
  172. plans/documentation-code-audit/0-Overview.md +393 -0
  173. plans/documentation-code-audit/1-Discovery-Inventory.md +183 -0
  174. plans/documentation-code-audit/2-Execution-Environment-Setup.md +263 -0
  175. plans/documentation-code-audit/3-Systematic-Validation.md +322 -0
  176. plans/documentation-code-audit/4-Code-Example-Remediation.md +358 -0
  177. plans/documentation-code-audit/5-Physics-MultiIndex-Compliance.md +464 -0
  178. plans/documentation-code-audit/6-Doctest-Integration.md +523 -0
  179. plans/documentation-code-audit/7-Reporting-Documentation.md +498 -0
  180. plans/documentation-code-audit/8-Closeout.md +456 -0
  181. plans/documentation-rebuild-session/compacted_state.md +109 -0
  182. plans/documentation-rendering-fixes/0-Overview.md +104 -0
  183. plans/documentation-rendering-fixes/1-Sphinx-Build-Diagnostics-Warning-Audit.md +101 -0
  184. plans/documentation-rendering-fixes/2-Configuration-Infrastructure-Fixes.md +113 -0
  185. plans/documentation-rendering-fixes/3-Docstring-Syntax-Audit-Repair.md +131 -0
  186. plans/documentation-rendering-fixes/4-HTML-Page-Rendering-Verification.md +113 -0
  187. plans/documentation-rendering-fixes/5-Advanced-Documentation-Quality-Assurance.md +119 -0
  188. plans/documentation-rendering-fixes/6-Documentation-Build-Optimization-Testing.md +129 -0
  189. plans/documentation-rendering-fixes/compacted_state.md +132 -0
  190. plans/documentation-template-fix/0-Overview.md +197 -0
  191. plans/documentation-template-fix/1-Template-System-Analysis.md +269 -0
  192. plans/documentation-template-fix/2-Template-Modification.md +609 -0
  193. plans/documentation-template-fix/3-Build-System-Integration.md +766 -0
  194. plans/documentation-template-fix/4-Testing-Validation.md +1399 -0
  195. plans/documentation-template-fix/5-Documentation-Training.md +602 -0
  196. plans/documentation-workflow-fix/0-Overview.md +222 -0
  197. plans/documentation-workflow-fix/1-Immediate-Fixes.md +238 -0
  198. plans/documentation-workflow-fix/2-Configuration-Setup.md +298 -0
  199. plans/documentation-workflow-fix/3-Pre-commit-Integration.md +382 -0
  200. plans/documentation-workflow-fix/4-Workflow-Improvements.md +446 -0
  201. plans/documentation-workflow-fix/5-Documentation-and-Training.md +527 -0
  202. plans/duplicate-object-warnings-fix-plan.md +130 -0
  203. plans/github-issues-migration/0-Overview.md +510 -0
  204. plans/github-issues-migration/1-Foundation-Label-System.md +180 -0
  205. plans/github-issues-migration/2-Migration-Tool-Rewrite.md +235 -0
  206. plans/github-issues-migration/3-CLI-Integration-Automation.md +169 -0
  207. plans/github-issues-migration/4-Validated-Migration.md +252 -0
  208. plans/github-issues-migration/5-Documentation-Training.md +171 -0
  209. plans/github-issues-migration/6-Closeout.md +179 -0
  210. plans/github-workflows-repair/repair-plan.md +299 -0
  211. plans/issues_from_plans.py +342 -0
  212. plans/pr-270-doc-validation-fixes/0-Overview.md +354 -0
  213. plans/pr-270-doc-validation-fixes/1-Critical-PR-Fixes.md +117 -0
  214. plans/pr-270-doc-validation-fixes/2-Framework-Right-Sizing.md +129 -0
  215. plans/pr-270-doc-validation-fixes/3-Sustainable-Documentation.md +126 -0
  216. plans/pr-270-doc-validation-fixes/4-Closeout-Migration.md +143 -0
  217. plans/pr-270-doc-validation-fixes/PLAN_COMPLETED.md +149 -0
  218. plans/python-310-migration/0-Overview.md +390 -0
  219. plans/python-310-migration/1-Planning-Setup.md +164 -0
  220. plans/python-310-migration/2-Implementation.md +256 -0
  221. plans/python-310-migration/3-Testing-Validation.md +335 -0
  222. plans/python-310-migration/4-Documentation-Release.md +274 -0
  223. plans/python-310-migration/5-Closeout.md +252 -0
  224. plans/readthedocs-simplified/0-Overview.md +243 -0
  225. plans/readthedocs-simplified/1-Immediate-Fixes.md +216 -0
  226. plans/readthedocs-simplified/2-Template-Simplification.md +278 -0
  227. plans/readthedocs-simplified/3-ReadTheDocs-Setup.md +298 -0
  228. plans/readthedocs-simplified/4-Testing-Validation.md +328 -0
  229. plans/readthedocs-simplified/5-Closeout.md +231 -0
  230. plans/readthedocs-simplified/compacted_state.md +127 -0
  231. plans/session-compaction-2025-08-12/compacted_state.md +114 -0
  232. plans/session-compaction-2025-08-13/compacted_state.md +145 -0
  233. plans/session-continuity-protocol/0-Overview.md +35 -0
  234. plans/session-continuity-protocol/1-Core-Principles-Framework.md +40 -0
  235. plans/session-continuity-protocol/2-Pre-Session-Validation-System.md +79 -0
  236. plans/session-continuity-protocol/3-Context-Switching-Prevention.md +87 -0
  237. plans/session-continuity-protocol/4-Progress-Tracking-Recovery.md +100 -0
  238. plans/sphinx-warnings-analysis.md +222 -0
  239. plans/systemprompt-optimization/0-Overview.md +447 -0
  240. plans/systemprompt-optimization/1-Deploy-SystemPrompt.md +114 -0
  241. plans/systemprompt-optimization/2-Documentation-Alignment.md +198 -0
  242. plans/systemprompt-optimization/3-Monitoring-Infrastructure.md +396 -0
  243. plans/systemprompt-optimization/4-Implementation-Script.md +450 -0
  244. plans/systemprompt-optimization/9-Closeout.md +165 -0
  245. plans/systemprompt-optimization/compacted_state.md +143 -0
  246. plans/template-value-propositions/0-Overview.md +357 -0
  247. plans/template-value-propositions/1-Value-Proposition-Framework-Design.md +144 -0
  248. plans/template-value-propositions/2-Plan-Template-Enhancement.md +178 -0
  249. plans/template-value-propositions/3-Value-Generator-Hook-Implementation.md +291 -0
  250. plans/template-value-propositions/4-Value-Validator-Hook-Implementation.md +274 -0
  251. plans/template-value-propositions/5-Documentation-Agent-Updates.md +219 -0
  252. plans/template-value-propositions/6-Integration-Testing-Validation.md +247 -0
  253. plans/tests-audit/0-Overview.md +410 -0
  254. plans/tests-audit/1-Discovery-Inventory.md +170 -0
  255. plans/tests-audit/2-Physics-Validation-Audit.md +195 -0
  256. plans/tests-audit/3-Architecture-Compliance.md +195 -0
  257. plans/tests-audit/4-Numerical-Stability-Analysis.md +203 -0
  258. plans/tests-audit/5-Documentation-Enhancement.md +220 -0
  259. plans/tests-audit/6-Audit-Deliverables.md +220 -0
  260. plans/tests-audit/7-Closeout.md +252 -0
  261. plans/tests-audit/artifacts/ARCHITECTURE_COMPLIANCE_REPORT.md +315 -0
  262. plans/tests-audit/artifacts/ARCHITECTURE_RECOMMENDATIONS.md +943 -0
  263. plans/tests-audit/artifacts/COMPREHENSIVE_AUDIT_REPORT.md +356 -0
  264. plans/tests-audit/artifacts/CONTRIBUTING_ENHANCED_TEMPLATE.md +419 -0
  265. plans/tests-audit/artifacts/COVERAGE_GAP_ANALYSIS.md +152 -0
  266. plans/tests-audit/artifacts/DOCUMENTATION_ENHANCEMENT_REPORT.md +502 -0
  267. plans/tests-audit/artifacts/EXECUTIVE_AUDIT_SUMMARY.md +129 -0
  268. plans/tests-audit/artifacts/IMPLEMENTATION_ROADMAP.md +647 -0
  269. plans/tests-audit/artifacts/NUMERICAL_RECOMMENDATIONS.md +739 -0
  270. plans/tests-audit/artifacts/NUMERICAL_STABILITY_GUIDE_TEMPLATE.rst +451 -0
  271. plans/tests-audit/artifacts/NUMERICAL_STABILITY_REPORT.md +301 -0
  272. plans/tests-audit/artifacts/PHASE_3_SUMMARY.md +280 -0
  273. plans/tests-audit/artifacts/PHASE_4_SUMMARY.md +229 -0
  274. plans/tests-audit/artifacts/PHASE_5_SUMMARY.md +292 -0
  275. plans/tests-audit/artifacts/PHASE_6_CLOSEOUT.md +278 -0
  276. plans/tests-audit/artifacts/PHYSICS_GUIDE_TEMPLATE.rst +268 -0
  277. plans/tests-audit/artifacts/PHYSICS_VALIDATION_REPORT.md +235 -0
  278. plans/tests-audit/artifacts/TECHNICAL_DELIVERABLES_PACKAGE.md +2502 -0
  279. plans/tests-audit/artifacts/TEST_INVENTORY.csv +1204 -0
  280. plans/tests-audit/artifacts/TEST_INVENTORY.md +135 -0
  281. plans/tests-audit/artifacts/test_discovery_analysis.py +231 -0
  282. plans/tests-audit/artifacts/test_parser.py +395 -0
  283. solarwindpy/README.md +3 -0
  284. solarwindpy/Untitled.ipynb +54 -0
  285. solarwindpy/__init__.py +74 -0
  286. solarwindpy/core/__init__.py +23 -0
  287. solarwindpy/core/alfvenic_turbulence.py +804 -0
  288. solarwindpy/core/base.py +267 -0
  289. solarwindpy/core/ions.py +309 -0
  290. solarwindpy/core/plasma.py +2133 -0
  291. solarwindpy/core/spacecraft.py +256 -0
  292. solarwindpy/core/tensor.py +90 -0
  293. solarwindpy/core/units_constants.py +199 -0
  294. solarwindpy/core/vector.py +328 -0
  295. solarwindpy/fitfunctions/__init__.py +20 -0
  296. solarwindpy/fitfunctions/core.py +734 -0
  297. solarwindpy/fitfunctions/exponentials.py +188 -0
  298. solarwindpy/fitfunctions/gaussians.py +264 -0
  299. solarwindpy/fitfunctions/lines.py +116 -0
  300. solarwindpy/fitfunctions/moyal.py +71 -0
  301. solarwindpy/fitfunctions/plots.py +751 -0
  302. solarwindpy/fitfunctions/power_laws.py +209 -0
  303. solarwindpy/fitfunctions/tex_info.py +568 -0
  304. solarwindpy/fitfunctions/trend_fits.py +482 -0
  305. solarwindpy/instabilities/__init__.py +16 -0
  306. solarwindpy/instabilities/beta_ani.py +82 -0
  307. solarwindpy/instabilities/verscharen2016.py +631 -0
  308. solarwindpy/plotting/__init__.py +33 -0
  309. solarwindpy/plotting/agg_plot.py +489 -0
  310. solarwindpy/plotting/base.py +465 -0
  311. solarwindpy/plotting/hist1d.py +405 -0
  312. solarwindpy/plotting/hist2d.py +1035 -0
  313. solarwindpy/plotting/histograms.py +1845 -0
  314. solarwindpy/plotting/labels/__init__.py +104 -0
  315. solarwindpy/plotting/labels/base.py +686 -0
  316. solarwindpy/plotting/labels/chemistry.py +19 -0
  317. solarwindpy/plotting/labels/composition.py +100 -0
  318. solarwindpy/plotting/labels/datetime.py +235 -0
  319. solarwindpy/plotting/labels/elemental_abundance.py +73 -0
  320. solarwindpy/plotting/labels/special.py +794 -0
  321. solarwindpy/plotting/orbits.py +515 -0
  322. solarwindpy/plotting/scatter.py +99 -0
  323. solarwindpy/plotting/select_data_from_figure.py +329 -0
  324. solarwindpy/plotting/spiral.py +980 -0
  325. solarwindpy/plotting/tools.py +434 -0
  326. solarwindpy/scripts/__init__.py +1 -0
  327. solarwindpy/scripts/logs/.gitignore +1 -0
  328. solarwindpy/solar_activity/__init__.py +53 -0
  329. solarwindpy/solar_activity/base.py +605 -0
  330. solarwindpy/solar_activity/lisird/__init__.py +3 -0
  331. solarwindpy/solar_activity/lisird/extrema_calculator.py +394 -0
  332. solarwindpy/solar_activity/lisird/lisird.py +319 -0
  333. solarwindpy/solar_activity/plots.py +116 -0
  334. solarwindpy/solar_activity/sunspot_number/.DS_Store +0 -0
  335. solarwindpy/solar_activity/sunspot_number/__init__.py +3 -0
  336. solarwindpy/solar_activity/sunspot_number/sidc.py +556 -0
  337. solarwindpy/solar_activity/sunspot_number/ssn_extrema.csv +72 -0
  338. solarwindpy/solar_activity/sunspot_number/ssn_extrema.csv.silso +72 -0
  339. solarwindpy/tools/__init__.py +162 -0
  340. solarwindpy-0.1.1.dist-info/METADATA +181 -0
  341. solarwindpy-0.1.1.dist-info/RECORD +409 -0
  342. {solarwindpy-0.0.1.dev0.dist-info โ†’ solarwindpy-0.1.1.dist-info}/WHEEL +1 -1
  343. solarwindpy-0.1.1.dist-info/licenses/LICENSE.rst +32 -0
  344. solarwindpy-0.1.1.dist-info/top_level.txt +3 -0
  345. tests/__init__.py +1 -0
  346. tests/conftest.py +10 -0
  347. tests/core/__init__.py +1 -0
  348. tests/core/test_alfvenic_turbulence.py +544 -0
  349. tests/core/test_base.py +112 -0
  350. tests/core/test_base_head_tail.py +29 -0
  351. tests/core/test_base_mi_tuples.py +11 -0
  352. tests/core/test_core_verify_datetimeindex.py +32 -0
  353. tests/core/test_ions.py +325 -0
  354. tests/core/test_plasma.py +2581 -0
  355. tests/core/test_plasma_io.py +12 -0
  356. tests/core/test_quantities.py +507 -0
  357. tests/core/test_spacecraft.py +210 -0
  358. tests/core/test_units_constants.py +22 -0
  359. tests/data/epoch.csv +4 -0
  360. tests/data/plasma.csv +4 -0
  361. tests/data/spacecraft.csv +4 -0
  362. tests/fitfunctions/conftest.py +60 -0
  363. tests/fitfunctions/test_core.py +193 -0
  364. tests/fitfunctions/test_exponentials.py +342 -0
  365. tests/fitfunctions/test_gaussians.py +142 -0
  366. tests/fitfunctions/test_lines.py +349 -0
  367. tests/fitfunctions/test_moyal.py +258 -0
  368. tests/fitfunctions/test_plots.py +258 -0
  369. tests/fitfunctions/test_power_laws.py +365 -0
  370. tests/fitfunctions/test_tex_info.py +183 -0
  371. tests/fitfunctions/test_trend_fit_properties.py +31 -0
  372. tests/fitfunctions/test_trend_fits.py +244 -0
  373. tests/plotting/__init__.py +1 -0
  374. tests/plotting/labels/__init__.py +1 -0
  375. tests/plotting/labels/test_chemistry.py +243 -0
  376. tests/plotting/labels/test_composition.py +345 -0
  377. tests/plotting/labels/test_datetime.py +445 -0
  378. tests/plotting/labels/test_elemental_abundance.py +366 -0
  379. tests/plotting/labels/test_init.py +66 -0
  380. tests/plotting/labels/test_labels_base.py +347 -0
  381. tests/plotting/labels/test_special.py +550 -0
  382. tests/plotting/test_agg_plot.py +602 -0
  383. tests/plotting/test_base.py +752 -0
  384. tests/plotting/test_fixtures_utilities.py +775 -0
  385. tests/plotting/test_histograms.py +546 -0
  386. tests/plotting/test_integration.py +675 -0
  387. tests/plotting/test_orbits.py +435 -0
  388. tests/plotting/test_performance.py +708 -0
  389. tests/plotting/test_scatter.py +752 -0
  390. tests/plotting/test_select_data_from_figure.py +1209 -0
  391. tests/plotting/test_spiral.py +573 -0
  392. tests/plotting/test_tools.py +607 -0
  393. tests/plotting/test_visual_validation.py +465 -0
  394. tests/solar_activity/__init__.py +1 -0
  395. tests/solar_activity/lisird/__init__.py +1 -0
  396. tests/solar_activity/lisird/test_extrema_calculator.py +593 -0
  397. tests/solar_activity/lisird/test_lisird_id.py +187 -0
  398. tests/solar_activity/sunspot_number/__init__.py +1 -0
  399. tests/solar_activity/sunspot_number/test_init.py +399 -0
  400. tests/solar_activity/sunspot_number/test_sidc.py +465 -0
  401. tests/solar_activity/sunspot_number/test_sidc_id.py +223 -0
  402. tests/solar_activity/sunspot_number/test_sidc_loader.py +275 -0
  403. tests/solar_activity/sunspot_number/test_ssn_extrema.py +406 -0
  404. tests/solar_activity/test_base.py +656 -0
  405. tests/solar_activity/test_init.py +396 -0
  406. tests/solar_activity/test_plots.py +371 -0
  407. tests/test_circular_imports.py +408 -0
  408. tests/test_issue_titles.py +25 -0
  409. tests/test_statusline.py +298 -0
  410. solarwindpy-0.0.1.dev0.dist-info/METADATA +0 -14
  411. solarwindpy-0.0.1.dev0.dist-info/RECORD +0 -4
  412. solarwindpy-0.0.1.dev0.dist-info/top_level.txt +0 -1
@@ -0,0 +1,101 @@
1
+ # Phase 1: Sphinx Build Diagnostics and Warning Audit
2
+
3
+ ## Phase Metadata
4
+ - **Phase**: 1/6
5
+ - **Estimated Duration**: 1.5 hours
6
+ - **Dependencies**: None
7
+ - **Status**: Not Started
8
+
9
+ ## ๐ŸŽฏ Phase Objective
10
+ Perform comprehensive analysis of Sphinx build system to identify all warnings, errors, and HTML rendering failures. Establish baseline understanding of documentation infrastructure issues and create systematic remediation roadmap.
11
+
12
+ ## ๐Ÿง  Phase Context
13
+ Before fixing documentation issues, we must understand the full scope of problems. This phase provides the diagnostic foundation for all subsequent fixes by cataloging every warning, error, and rendering failure in the Sphinx build system.
14
+
15
+ ## ๐Ÿ“‹ Implementation Tasks
16
+
17
+ ### Task Group 1: Build Environment Validation
18
+ - [ ] **Validate Documentation Environment** (Est: 15 min) - Ensure solarwindpy-20250404 environment is active and Sphinx dependencies are available
19
+ - Commit: `<checksum>`
20
+ - Status: Pending
21
+ - Notes: DocumentationMaintainer will verify environment setup
22
+ - [ ] **Check Sphinx Configuration** (Est: 15 min) - Review docs/conf.py for basic configuration issues and version compatibility
23
+ - Commit: `<checksum>`
24
+ - Status: Pending
25
+ - Notes: Identify any obvious configuration problems
26
+
27
+ ### Task Group 2: Build Execution and Warning Capture
28
+ - [ ] **Execute Clean Documentation Build** (Est: 20 min) - Run `make clean && make html` and capture all warnings/errors
29
+ - Commit: `<checksum>`
30
+ - Status: Pending
31
+ - Notes: Generate fresh build with complete warning log
32
+ - [ ] **Categorize Sphinx Warnings** (Est: 30 min) - Systematically categorize all warnings by type (docstring, cross-reference, configuration, etc.)
33
+ - Commit: `<checksum>`
34
+ - Status: Pending
35
+ - Notes: Create structured warning inventory
36
+
37
+ ### Task Group 3: HTML Rendering Analysis
38
+ - [ ] **Audit Problem HTML Pages** (Est: 20 min) - Manually inspect solarwindpy.fitfunctions.html, solarwindpy.core.html, solarwindpy.instabilities.html, solarwindpy.solar_activity.html
39
+ - Commit: `<checksum>`
40
+ - Status: Pending
41
+ - Notes: Document specific rendering failures and missing content
42
+ - [ ] **Compare Working vs Broken Pages** (Est: 10 min) - Identify patterns between properly rendered pages and problematic ones
43
+ - Commit: `<checksum>`
44
+ - Status: Pending
45
+ - Notes: Look for common patterns in rendering failures
46
+
47
+ ## โœ… Phase Acceptance Criteria
48
+ - [ ] Complete Sphinx build warning inventory created and categorized
49
+ - [ ] All problematic HTML pages identified with specific rendering issues documented
50
+ - [ ] Baseline documentation build metrics established
51
+ - [ ] Environment and configuration validated
52
+ - [ ] Systematic remediation roadmap created based on diagnostic findings
53
+ - [ ] Priority order established for fixing different types of issues
54
+
55
+ ## ๐Ÿงช Phase Testing Strategy
56
+ - **Build Validation**: Ensure clean build environment and reproducible build process
57
+ - **Warning Analysis**: Systematic categorization of all Sphinx warnings and errors
58
+ - **HTML Inspection**: Manual verification of HTML output quality and completeness
59
+
60
+ ## ๐Ÿ”ง Phase Technical Requirements
61
+ - **Environment**: solarwindpy-20250404 conda environment active
62
+ - **Tools**: Sphinx, make, web browser for HTML inspection
63
+ - **Documentation**: Access to docs/source/ and docs/build/ directories
64
+
65
+ ## ๐Ÿ“‚ Phase Affected Areas
66
+ - `docs/build/` - Generated documentation for analysis
67
+ - `docs/source/` - Source files for configuration review
68
+ - Warning logs and diagnostic reports (temporary files)
69
+
70
+ ## ๐Ÿ“Š Phase Progress Tracking
71
+
72
+ ### Current Status
73
+ - **Tasks Completed**: 0/6
74
+ - **Time Invested**: 0h of 1.5h
75
+ - **Completion Percentage**: 0%
76
+ - **Last Updated**: 2025-08-13
77
+
78
+ ### Blockers & Issues
79
+ - None anticipated for diagnostic phase
80
+
81
+ ### Next Actions
82
+ - Activate documentation environment
83
+ - Execute clean Sphinx build with warning capture
84
+ - Begin systematic warning categorization
85
+
86
+ ## ๐Ÿ’ฌ Phase Implementation Notes
87
+
88
+ ### Implementation Decisions
89
+ - Focus on comprehensive diagnosis before any fixes to ensure systematic approach
90
+ - Use DocumentationMaintainer agent for technical analysis with coordination from planning agents
91
+
92
+ ### Lessons Learned
93
+ [To be populated during implementation]
94
+
95
+ ### Phase Dependencies Resolution
96
+ - No dependencies for this initial diagnostic phase
97
+ - Provides foundation for all subsequent phases
98
+
99
+ ---
100
+ *Phase 1 of 6 - Documentation Rendering Fixes - Last Updated: 2025-08-13*
101
+ *See [0-Overview.md](./0-Overview.md) for complete plan context and cross-phase coordination.*
@@ -0,0 +1,113 @@
1
+ # Phase 2: Configuration and Infrastructure Fixes
2
+
3
+ ## Phase Metadata
4
+ - **Phase**: 2/6
5
+ - **Estimated Duration**: 2 hours
6
+ - **Dependencies**: Phase 1 (diagnostic findings)
7
+ - **Status**: Not Started
8
+
9
+ ## ๐ŸŽฏ Phase Objective
10
+ Fix Sphinx configuration, build system, and documentation infrastructure issues identified in Phase 1. Establish robust foundation for reliable documentation builds and resolve configuration-related warnings.
11
+
12
+ ## ๐Ÿง  Phase Context
13
+ Many Sphinx warnings and HTML rendering issues stem from configuration problems. This phase addresses the infrastructure foundation before tackling individual docstring issues, ensuring that fixes in later phases will be effective and sustainable.
14
+
15
+ ## ๐Ÿ“‹ Implementation Tasks
16
+
17
+ ### Task Group 1: Sphinx Configuration Optimization
18
+ - [ ] **Update conf.py Settings** (Est: 30 min) - Fix Sphinx configuration based on Phase 1 findings (extensions, themes, paths)
19
+ - Commit: `<checksum>`
20
+ - Status: Pending
21
+ - Notes: Address configuration warnings and compatibility issues
22
+ - [ ] **Validate Extension Configuration** (Est: 20 min) - Ensure all Sphinx extensions are properly configured and compatible
23
+ - Commit: `<checksum>`
24
+ - Status: Pending
25
+ - Notes: Fix extension-related warnings from diagnostic phase
26
+ - [ ] **Optimize Theme and Template Settings** (Est: 15 min) - Configure documentation theme and templates for proper rendering
27
+ - Commit: `<checksum>`
28
+ - Status: Pending
29
+ - Notes: Ensure consistent visual presentation across all pages
30
+
31
+ ### Task Group 2: Build System Infrastructure
32
+ - [ ] **Fix Makefile and Build Scripts** (Est: 20 min) - Update documentation build system for reliable operation
33
+ - Commit: `<checksum>`
34
+ - Status: Pending
35
+ - Notes: Address any build system issues found in Phase 1
36
+ - [ ] **Configure Autodoc and API Generation** (Est: 25 min) - Ensure proper API documentation generation settings
37
+ - Commit: `<checksum>`
38
+ - Status: Pending
39
+ - Notes: Fix autodoc warnings and API generation issues
40
+ - [ ] **Implement Documentation Requirements** (Est: 10 min) - Ensure all required packages are available for documentation builds
41
+ - Commit: `<checksum>`
42
+ - Status: Pending
43
+ - Notes: Verify documentation dependencies are properly specified
44
+
45
+ ### Task Group 3: Infrastructure Validation and Testing
46
+ - [ ] **Execute Test Build** (Est: 15 min) - Run clean build to validate configuration fixes
47
+ - Commit: `<checksum>`
48
+ - Status: Pending
49
+ - Notes: Verify configuration changes resolve infrastructure warnings
50
+ - [ ] **Validate RST File Processing** (Est: 5 min) - Ensure all reStructuredText files process correctly with new configuration
51
+ - Commit: `<checksum>`
52
+ - Status: Pending
53
+ - Notes: Check for any new warnings introduced by configuration changes
54
+
55
+ ## โœ… Phase Acceptance Criteria
56
+ - [ ] Sphinx configuration optimized and warnings-free
57
+ - [ ] Documentation build system operates reliably
58
+ - [ ] All extensions and themes configured correctly
59
+ - [ ] Infrastructure-related warnings eliminated
60
+ - [ ] API documentation generation functioning properly
61
+ - [ ] Clean test build validates configuration improvements
62
+ - [ ] Foundation established for reliable docstring processing
63
+
64
+ ## ๐Ÿงช Phase Testing Strategy
65
+ - **Configuration Testing**: Validate each configuration change with test builds
66
+ - **Build System Validation**: Ensure make commands execute without infrastructure errors
67
+ - **Extension Testing**: Verify all Sphinx extensions load and function correctly
68
+
69
+ ## ๐Ÿ”ง Phase Technical Requirements
70
+ - **Configuration Files**: docs/conf.py, docs/Makefile, requirements files
71
+ - **Sphinx Extensions**: autodoc, napoleon, viewcode, and theme extensions
72
+ - **Environment**: Verified documentation build environment from Phase 1
73
+
74
+ ## ๐Ÿ“‚ Phase Affected Areas
75
+ - `docs/conf.py` - Primary Sphinx configuration file
76
+ - `docs/Makefile` - Documentation build system
77
+ - `docs/requirements.txt` - Documentation build dependencies (if present)
78
+ - `docs/source/_static/` - Static files and theme customizations (if applicable)
79
+
80
+ ## ๐Ÿ“Š Phase Progress Tracking
81
+
82
+ ### Current Status
83
+ - **Tasks Completed**: 0/8
84
+ - **Time Invested**: 0h of 2h
85
+ - **Completion Percentage**: 0%
86
+ - **Last Updated**: 2025-08-13
87
+
88
+ ### Blockers & Issues
89
+ - Dependent on Phase 1 diagnostic findings
90
+ - May discover additional configuration issues during implementation
91
+
92
+ ### Next Actions
93
+ - Review Phase 1 diagnostic findings
94
+ - Begin Sphinx configuration optimization
95
+ - Implement fixes based on warning categorization
96
+
97
+ ## ๐Ÿ’ฌ Phase Implementation Notes
98
+
99
+ ### Implementation Decisions
100
+ - Prioritize configuration fixes that resolve the most warnings
101
+ - Ensure backwards compatibility while modernizing configuration
102
+ - Use DocumentationMaintainer agent expertise for Sphinx best practices
103
+
104
+ ### Lessons Learned
105
+ [To be populated during implementation]
106
+
107
+ ### Phase Dependencies Resolution
108
+ - Uses diagnostic findings from Phase 1 to guide configuration fixes
109
+ - Provides stable infrastructure foundation for Phase 3 docstring work
110
+
111
+ ---
112
+ *Phase 2 of 6 - Documentation Rendering Fixes - Last Updated: 2025-08-13*
113
+ *See [0-Overview.md](./0-Overview.md) for complete plan context and cross-phase coordination.*
@@ -0,0 +1,131 @@
1
+ # Phase 3: Docstring Syntax Audit and Repair
2
+
3
+ ## Phase Metadata
4
+ - **Phase**: 3/6
5
+ - **Estimated Duration**: 3.5 hours
6
+ - **Dependencies**: Phase 2 (infrastructure fixes)
7
+ - **Status**: Not Started
8
+
9
+ ## ๐ŸŽฏ Phase Objective
10
+ Systematically audit and repair docstring syntax errors across all SolarWindPy modules to eliminate Sphinx warnings and ensure proper API documentation generation. Focus on modules with known HTML rendering issues.
11
+
12
+ ## ๐Ÿง  Phase Context
13
+ With infrastructure fixes from Phase 2, docstring syntax errors are now the primary barrier to proper HTML rendering. This phase systematically fixes docstring issues in all modules, with priority on problematic modules identified in Phase 1.
14
+
15
+ ## ๐Ÿ“‹ Implementation Tasks
16
+
17
+ ### Task Group 1: Core Module Docstring Repair
18
+ - [ ] **Audit and Fix solarwindpy.core Module** (Est: 45 min) - Repair docstring syntax in core/*.py files (plasma.py, ions.py, base.py, etc.)
19
+ - Commit: `<checksum>`
20
+ - Status: Pending
21
+ - Notes: Focus on modules causing solarwindpy.core.html rendering issues
22
+ - [ ] **Audit and Fix solarwindpy.fitfunctions Module** (Est: 40 min) - Repair docstring syntax in fitfunctions/*.py files
23
+ - Commit: `<checksum>`
24
+ - Status: Pending
25
+ - Notes: Priority module due to solarwindpy.fitfunctions.html rendering failures
26
+ - [ ] **Audit and Fix solarwindpy.instabilities Module** (Est: 25 min) - Repair docstring syntax in instabilities/*.py files
27
+ - Commit: `<checksum>`
28
+ - Status: Pending
29
+ - Notes: Address solarwindpy.instabilities.html rendering issues
30
+
31
+ ### Task Group 2: Solar Activity and Plotting Module Fixes
32
+ - [ ] **Audit and Fix solarwindpy.solar_activity Module** (Est: 35 min) - Repair docstring syntax in solar_activity/ hierarchy
33
+ - Commit: `<checksum>`
34
+ - Status: Pending
35
+ - Notes: Fix solarwindpy.solar_activity.html rendering and submodule documentation
36
+ - [ ] **Audit and Fix solarwindpy.plotting Module** (Est: 30 min) - Repair docstring syntax in plotting/ hierarchy including labels/
37
+ - Commit: `<checksum>`
38
+ - Status: Pending
39
+ - Notes: Ensure plotting documentation renders properly with visual elements
40
+ - [ ] **Audit and Fix solarwindpy.tools Module** (Est: 15 min) - Repair docstring syntax in tools/*.py files
41
+ - Commit: `<checksum>`
42
+ - Status: Pending
43
+ - Notes: Smaller module, fewer expected issues
44
+
45
+ ### Task Group 3: Docstring Quality and Standards
46
+ - [ ] **Standardize Docstring Format** (Est: 20 min) - Ensure consistent NumPy/Google docstring format across all modules
47
+ - Commit: `<checksum>`
48
+ - Status: Pending
49
+ - Notes: Apply consistent formatting standards for professional documentation
50
+ - [ ] **Fix Cross-Reference Syntax** (Est: 15 min) - Repair Sphinx cross-reference syntax (:class:, :func:, :meth:, etc.)
51
+ - Commit: `<checksum>`
52
+ - Status: Pending
53
+ - Notes: Fix broken internal links and references
54
+ - [ ] **Validate Mathematical Notation** (Est: 10 min) - Ensure LaTeX math expressions render properly in docstrings
55
+ - Commit: `<checksum>`
56
+ - Status: Pending
57
+ - Notes: Critical for scientific software documentation
58
+
59
+ ### Task Group 4: Validation and Testing
60
+ - [ ] **Execute Post-Fix Build** (Est: 15 min) - Run clean Sphinx build to validate docstring fixes
61
+ - Commit: `<checksum>`
62
+ - Status: Pending
63
+ - Notes: Verify docstring repairs eliminate warnings
64
+ - [ ] **Spot Check API Documentation** (Est: 10 min) - Review generated API documentation for completeness and accuracy
65
+ - Commit: `<checksum>`
66
+ - Status: Pending
67
+ - Notes: Ensure docstring fixes result in proper API documentation
68
+
69
+ ## โœ… Phase Acceptance Criteria
70
+ - [ ] All docstring syntax errors eliminated across target modules
71
+ - [ ] Consistent docstring format applied throughout codebase
72
+ - [ ] Cross-references and internal links functioning correctly
73
+ - [ ] Mathematical notation rendering properly in documentation
74
+ - [ ] Sphinx build produces significantly fewer warnings
75
+ - [ ] API documentation generated correctly for all public functions/classes
76
+ - [ ] HTML pages show proper content organization with descriptions
77
+
78
+ ## ๐Ÿงช Phase Testing Strategy
79
+ - **Module-by-Module Validation**: Test each module after docstring fixes
80
+ - **Syntax Verification**: Use Sphinx's strict mode to catch remaining syntax issues
81
+ - **Cross-Reference Testing**: Validate all internal documentation links
82
+ - **API Coverage**: Ensure all public APIs have proper documentation
83
+
84
+ ## ๐Ÿ”ง Phase Technical Requirements
85
+ - **Docstring Standards**: NumPy/Google docstring format
86
+ - **Sphinx Syntax**: Proper reStructuredText and Sphinx directive usage
87
+ - **Mathematical Notation**: LaTeX math expressions for scientific content
88
+ - **Cross-References**: Sphinx intersphinx and autodoc linking
89
+
90
+ ## ๐Ÿ“‚ Phase Affected Areas
91
+ - `solarwindpy/core/*.py` - All core module docstrings
92
+ - `solarwindpy/fitfunctions/*.py` - All fitfunctions module docstrings
93
+ - `solarwindpy/instabilities/*.py` - All instabilities module docstrings
94
+ - `solarwindpy/solar_activity/**/*.py` - All solar activity module docstrings
95
+ - `solarwindpy/plotting/**/*.py` - All plotting module docstrings
96
+ - `solarwindpy/tools/*.py` - All tools module docstrings
97
+
98
+ ## ๐Ÿ“Š Phase Progress Tracking
99
+
100
+ ### Current Status
101
+ - **Tasks Completed**: 0/11
102
+ - **Time Invested**: 0h of 3.5h
103
+ - **Completion Percentage**: 0%
104
+ - **Last Updated**: 2025-08-13
105
+
106
+ ### Blockers & Issues
107
+ - Dependent on stable Sphinx configuration from Phase 2
108
+ - May discover complex docstring issues requiring additional time
109
+
110
+ ### Next Actions
111
+ - Begin with core module docstring audit
112
+ - Prioritize modules with known HTML rendering failures
113
+ - Apply systematic docstring syntax fixes
114
+
115
+ ## ๐Ÿ’ฌ Phase Implementation Notes
116
+
117
+ ### Implementation Decisions
118
+ - Focus on modules with known HTML rendering issues first
119
+ - Apply consistent docstring standards across all modules
120
+ - Use DocumentationMaintainer agent for docstring syntax expertise
121
+
122
+ ### Lessons Learned
123
+ [To be populated during implementation]
124
+
125
+ ### Phase Dependencies Resolution
126
+ - Requires stable Sphinx infrastructure from Phase 2
127
+ - Provides clean docstrings for HTML rendering validation in Phase 4
128
+
129
+ ---
130
+ *Phase 3 of 6 - Documentation Rendering Fixes - Last Updated: 2025-08-13*
131
+ *See [0-Overview.md](./0-Overview.md) for complete plan context and cross-phase coordination.*
@@ -0,0 +1,113 @@
1
+ # Phase 4: HTML Page Rendering Verification
2
+
3
+ ## Phase Metadata
4
+ - **Phase**: 4/6
5
+ - **Estimated Duration**: 1.5 hours
6
+ - **Dependencies**: Phase 3 (docstring fixes)
7
+ - **Status**: Not Started
8
+
9
+ ## ๐ŸŽฏ Phase Objective
10
+ Verify and fix HTML page rendering for all modules, ensuring proper content organization, complete API documentation display, and elimination of rendering failures identified in Phase 1.
11
+
12
+ ## ๐Ÿง  Phase Context
13
+ With infrastructure and docstring fixes complete, this phase validates that all HTML pages render correctly. Focus on previously problematic pages (solarwindpy.fitfunctions.html, solarwindpy.core.html, etc.) while ensuring comprehensive coverage across all modules.
14
+
15
+ ## ๐Ÿ“‹ Implementation Tasks
16
+
17
+ ### Task Group 1: Critical Page Rendering Verification
18
+ - [ ] **Verify solarwindpy.core.html Rendering** (Est: 20 min) - Validate complete rendering of core module documentation
19
+ - Commit: `<checksum>`
20
+ - Status: Pending
21
+ - Notes: Ensure all classes and functions display with proper descriptions
22
+ - [ ] **Verify solarwindpy.fitfunctions.html Rendering** (Est: 20 min) - Validate fitfunctions module HTML page completeness
23
+ - Commit: `<checksum>`
24
+ - Status: Pending
25
+ - Notes: Check mathematical expressions and class hierarchies render correctly
26
+ - [ ] **Verify solarwindpy.instabilities.html Rendering** (Est: 15 min) - Validate instabilities module documentation display
27
+ - Commit: `<checksum>`
28
+ - Status: Pending
29
+ - Notes: Ensure scientific content and equations render properly
30
+ - [ ] **Verify solarwindpy.solar_activity.html Rendering** (Est: 15 min) - Validate solar activity module and submodule documentation
31
+ - Commit: `<checksum>`
32
+ - Status: Pending
33
+ - Notes: Check hierarchical submodule documentation structure
34
+
35
+ ### Task Group 2: Comprehensive Page Audit
36
+ - [ ] **Audit All Module HTML Pages** (Est: 20 min) - Systematic check of all generated HTML pages for completeness
37
+ - Commit: `<checksum>`
38
+ - Status: Pending
39
+ - Notes: Verify plotting, tools, and all other module pages render correctly
40
+ - [ ] **Verify API Documentation Completeness** (Est: 15 min) - Ensure all public APIs appear in generated documentation
41
+ - Commit: `<checksum>`
42
+ - Status: Pending
43
+ - Notes: Check for missing classes, functions, or incomplete descriptions
44
+
45
+ ### Task Group 3: Content Organization and Navigation
46
+ - [ ] **Fix Content Organization Issues** (Est: 10 min) - Address any remaining content placement or organization problems
47
+ - Commit: `<checksum>`
48
+ - Status: Pending
49
+ - Notes: Ensure definitions appear in correct locations with proper descriptions
50
+ - [ ] **Validate Cross-Page Navigation** (Est: 5 min) - Test navigation between documentation pages and internal links
51
+ - Commit: `<checksum>`
52
+ - Status: Pending
53
+ - Notes: Verify table of contents and cross-references work correctly
54
+
55
+ ## โœ… Phase Acceptance Criteria
56
+ - [ ] All previously problematic HTML pages render completely and correctly
57
+ - [ ] No missing content or misplaced definitions in any module documentation
58
+ - [ ] All public APIs display with proper descriptions and signatures
59
+ - [ ] Mathematical expressions and scientific content render properly
60
+ - [ ] Navigation and cross-references function correctly
61
+ - [ ] HTML page quality matches professional scientific software standards
62
+ - [ ] Zero HTML rendering errors or incomplete pages
63
+
64
+ ## ๐Ÿงช Phase Testing Strategy
65
+ - **Visual Inspection**: Manual review of all HTML pages for completeness and quality
66
+ - **Content Verification**: Systematic check that all expected content appears correctly
67
+ - **Navigation Testing**: Verify internal links and cross-references work properly
68
+ - **Comparative Analysis**: Compare fixed pages against original broken versions
69
+
70
+ ## ๐Ÿ”ง Phase Technical Requirements
71
+ - **Web Browser**: For manual HTML page inspection
72
+ - **Sphinx Build Output**: Fresh documentation build from Phase 3 fixes
73
+ - **Documentation Standards**: Scientific software documentation quality benchmarks
74
+
75
+ ## ๐Ÿ“‚ Phase Affected Areas
76
+ - `docs/build/html/` - All generated HTML documentation pages
77
+ - `docs/build/html/solarwindpy.*.html` - Specific module documentation pages
78
+ - Navigation and cross-reference validation across all pages
79
+
80
+ ## ๐Ÿ“Š Phase Progress Tracking
81
+
82
+ ### Current Status
83
+ - **Tasks Completed**: 0/8
84
+ - **Time Invested**: 0h of 1.5h
85
+ - **Completion Percentage**: 0%
86
+ - **Last Updated**: 2025-08-13
87
+
88
+ ### Blockers & Issues
89
+ - Dependent on successful docstring fixes from Phase 3
90
+ - May identify residual rendering issues requiring additional fixes
91
+
92
+ ### Next Actions
93
+ - Execute fresh documentation build with Phase 3 fixes
94
+ - Begin systematic HTML page verification
95
+ - Address any remaining rendering issues
96
+
97
+ ## ๐Ÿ’ฌ Phase Implementation Notes
98
+
99
+ ### Implementation Decisions
100
+ - Focus on previously problematic pages first to validate fix effectiveness
101
+ - Use systematic approach to ensure no pages are missed
102
+ - Document any remaining issues for final resolution
103
+
104
+ ### Lessons Learned
105
+ [To be populated during implementation]
106
+
107
+ ### Phase Dependencies Resolution
108
+ - Requires clean docstrings from Phase 3
109
+ - Provides validated HTML output for quality assurance in Phase 5
110
+
111
+ ---
112
+ *Phase 4 of 6 - Documentation Rendering Fixes - Last Updated: 2025-08-13*
113
+ *See [0-Overview.md](./0-Overview.md) for complete plan context and cross-phase coordination.*
@@ -0,0 +1,119 @@
1
+ # Phase 5: Advanced Documentation Quality Assurance
2
+
3
+ ## Phase Metadata
4
+ - **Phase**: 5/6
5
+ - **Estimated Duration**: 2 hours
6
+ - **Dependencies**: Phase 4 (HTML rendering verification)
7
+ - **Status**: Not Started
8
+
9
+ ## ๐ŸŽฏ Phase Objective
10
+ Implement comprehensive documentation quality assurance including cross-references, link validation, documentation completeness checks, and professional quality standards for scientific software documentation.
11
+
12
+ ## ๐Ÿง  Phase Context
13
+ With basic rendering fixed, this phase elevates documentation quality to professional scientific software standards. Focus on comprehensive quality checks, user experience improvements, and establishing quality metrics for ongoing maintenance.
14
+
15
+ ## ๐Ÿ“‹ Implementation Tasks
16
+
17
+ ### Task Group 1: Cross-Reference and Link Validation
18
+ - [ ] **Validate All Internal Cross-References** (Est: 25 min) - Test all Sphinx cross-references (:class:, :func:, :meth:, etc.) for accuracy
19
+ - Commit: `<checksum>`
20
+ - Status: Pending
21
+ - Notes: Ensure all internal links resolve correctly
22
+ - [ ] **Run Sphinx Linkcheck** (Est: 20 min) - Execute sphinx-build linkcheck to identify and fix broken external links
23
+ - Commit: `<checksum>`
24
+ - Status: Pending
25
+ - Notes: Validate external references and citations
26
+ - [ ] **Fix Cross-Reference Inconsistencies** (Est: 15 min) - Repair any broken or inconsistent internal documentation links
27
+ - Commit: `<checksum>`
28
+ - Status: Pending
29
+ - Notes: Ensure consistent reference formatting throughout
30
+
31
+ ### Task Group 2: Documentation Completeness and Coverage
32
+ - [ ] **Audit API Documentation Coverage** (Est: 30 min) - Ensure all public APIs have complete documentation
33
+ - Commit: `<checksum>`
34
+ - Status: Pending
35
+ - Notes: Identify and document any missing API documentation
36
+ - [ ] **Validate Scientific Content Accuracy** (Est: 20 min) - Review scientific content for accuracy and completeness
37
+ - Commit: `<checksum>`
38
+ - Status: Pending
39
+ - Notes: Ensure physics formulas and references are correct
40
+ - [ ] **Check Documentation Examples** (Est: 10 min) - Verify code examples in docstrings are functional and accurate
41
+ - Commit: `<checksum>`
42
+ - Status: Pending
43
+ - Notes: Test example code snippets where applicable
44
+
45
+ ### Task Group 3: Professional Quality Standards
46
+ - [ ] **Implement Documentation Style Guide** (Est: 15 min) - Ensure consistent documentation style across all modules
47
+ - Commit: `<checksum>`
48
+ - Status: Pending
49
+ - Notes: Apply scientific software documentation best practices
50
+ - [ ] **Optimize Search and Navigation** (Est: 10 min) - Improve documentation searchability and user navigation experience
51
+ - Commit: `<checksum>`
52
+ - Status: Pending
53
+ - Notes: Enhance table of contents and index organization
54
+ - [ ] **Validate Accessibility Standards** (Est: 5 min) - Ensure documentation meets basic web accessibility standards
55
+ - Commit: `<checksum>`
56
+ - Status: Pending
57
+ - Notes: Check for proper heading hierarchy and alt text
58
+
59
+ ## โœ… Phase Acceptance Criteria
60
+ - [ ] All internal cross-references validated and functioning
61
+ - [ ] Zero broken external links in documentation
62
+ - [ ] Complete API documentation coverage for all public interfaces
63
+ - [ ] Scientific content accuracy validated
64
+ - [ ] Consistent documentation style applied throughout
65
+ - [ ] Professional quality matching leading scientific software projects
66
+ - [ ] Enhanced user navigation and search functionality
67
+ - [ ] Documentation accessibility standards met
68
+
69
+ ## ๐Ÿงช Phase Testing Strategy
70
+ - **Link Validation**: Automated testing of all internal and external links
71
+ - **Coverage Analysis**: Systematic review of API documentation completeness
72
+ - **Quality Metrics**: Establish measurable documentation quality standards
73
+ - **User Experience Testing**: Navigation and search functionality validation
74
+
75
+ ## ๐Ÿ”ง Phase Technical Requirements
76
+ - **Sphinx Tools**: linkcheck, search indexing, accessibility validation
77
+ - **Quality Standards**: Scientific software documentation best practices
78
+ - **Coverage Analysis**: Tools for measuring documentation completeness
79
+
80
+ ## ๐Ÿ“‚ Phase Affected Areas
81
+ - All documentation pages for cross-reference validation
82
+ - `docs/source/` - Source files for style and completeness improvements
83
+ - Search indexes and navigation structures
84
+ - External link references and citations
85
+
86
+ ## ๐Ÿ“Š Phase Progress Tracking
87
+
88
+ ### Current Status
89
+ - **Tasks Completed**: 0/9
90
+ - **Time Invested**: 0h of 2h
91
+ - **Completion Percentage**: 0%
92
+ - **Last Updated**: 2025-08-13
93
+
94
+ ### Blockers & Issues
95
+ - Dependent on properly rendered HTML from Phase 4
96
+ - May identify additional quality issues requiring fixes
97
+
98
+ ### Next Actions
99
+ - Begin comprehensive cross-reference validation
100
+ - Execute linkcheck for external link validation
101
+ - Implement systematic quality improvements
102
+
103
+ ## ๐Ÿ’ฌ Phase Implementation Notes
104
+
105
+ ### Implementation Decisions
106
+ - Focus on professional quality standards appropriate for scientific software
107
+ - Implement systematic quality checks for ongoing maintenance
108
+ - Use DocumentationMaintainer agent expertise for quality standards
109
+
110
+ ### Lessons Learned
111
+ [To be populated during implementation]
112
+
113
+ ### Phase Dependencies Resolution
114
+ - Requires properly rendered HTML pages from Phase 4
115
+ - Provides high-quality documentation foundation for optimization in Phase 6
116
+
117
+ ---
118
+ *Phase 5 of 6 - Documentation Rendering Fixes - Last Updated: 2025-08-13*
119
+ *See [0-Overview.md](./0-Overview.md) for complete plan context and cross-phase coordination.*