solarwindpy 0.0.1.dev0__py3-none-any.whl → 0.1.0__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.0.dist-info/METADATA +181 -0
  341. solarwindpy-0.1.0.dist-info/RECORD +409 -0
  342. {solarwindpy-0.0.1.dev0.dist-info → solarwindpy-0.1.0.dist-info}/WHEEL +1 -1
  343. solarwindpy-0.1.0.dist-info/licenses/LICENSE.rst +32 -0
  344. solarwindpy-0.1.0.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,237 @@
1
+ # Phase 2: Core Physics Modules Format Standardization
2
+
3
+ ## **Objective**
4
+ Standardize docstring formats to NumPy convention compliance for the 9 core physics modules that form the foundation of SolarWindPy's plasma physics analysis capabilities.
5
+
6
+ ## **Scope**
7
+ Convert existing docstrings to strict NumPy format while preserving existing scientific content and adding minimal missing basic documentation.
8
+
9
+ ## **Module Inventory and Format Standardization Targets**
10
+
11
+ ### **High Priority Core Modules (4 modules)**
12
+
13
+ #### **Module 1: `core/plasma.py` - Primary Plasma Container** (2 hours)
14
+ **Current Status**: Module has documentation but needs NumPy format conversion
15
+
16
+ **Standardization Requirements:**
17
+ - **Class Documentation**: Convert existing Plasma class docstring to NumPy format
18
+ - **Method Documentation**: Convert 25+ methods to NumPy format with proper parameter notation
19
+ - **Property Documentation**: Add basic Returns sections for properties
20
+ - **Parameter Format**: Convert to `param : type` notation throughout
21
+
22
+ **Key Format Conversion Example:**
23
+ ```python
24
+ class Plasma(base.Base):
25
+ """Container for plasma physics data including ions, magnetic field, and spacecraft.
26
+
27
+ Parameters
28
+ ----------
29
+ data : pandas.DataFrame
30
+ Multi-indexed DataFrame containing plasma measurements
31
+ ions : list of str
32
+ Ion species identifiers (e.g., ['p1', 'a'])
33
+ spacecraft : Spacecraft, optional
34
+ Spacecraft trajectory information
35
+
36
+ Attributes
37
+ ----------
38
+ species : list
39
+ Available ion species in the plasma
40
+ data : pandas.DataFrame
41
+ Underlying measurement data
42
+ ions : dict
43
+ Dictionary of Ion objects keyed by species
44
+ """
45
+ ```
46
+
47
+ **Format Standardization Areas:**
48
+ - Convert existing docstrings to NumPy parameter format
49
+ - Add missing Returns sections for methods that return values
50
+ - Standardize type notation (array_like, optional, etc.)
51
+ - Ensure consistent section header formatting
52
+
53
+ #### **Module 2: `core/ions.py` - Ion Species Handling** (2 hours)
54
+ **Current Status**: Has some documentation but needs NumPy format conversion
55
+
56
+ **Standardization Requirements:**
57
+ - **Ion Class**: Convert existing docstring to NumPy format
58
+ - **Moment Calculations**: Standardize parameter documentation format
59
+ - **Method Documentation**: Add Returns sections where missing
60
+ - **Parameter Format**: Convert to consistent `param : type` notation
61
+
62
+ **Key Format Focus:**
63
+ - Standardize existing physics equations to proper LaTeX format
64
+ - Convert parameter lists to NumPy parameter section format
65
+ - Add basic docstrings for undocumented methods
66
+ - Ensure consistent Returns section formatting
67
+
68
+ #### **Module 3: `core/base.py` - Foundation Base Class** (1.5 hours)
69
+ **Current Status**: Has basic documentation requiring NumPy format conversion
70
+
71
+ **Standardization Requirements:**
72
+ - **Base Class**: Convert existing docstring to NumPy format
73
+ - **Method Documentation**: Standardize parameter and return documentation
74
+ - **Utility Functions**: Add basic docstrings where completely missing
75
+ - **Format Consistency**: Ensure uniform NumPy convention throughout
76
+
77
+ #### **Module 4: `core/vector.py` - Vector Mathematics** (1 hour)
78
+ **Current Status**: Mathematical operations need NumPy format standardization
79
+
80
+ **Standardization Requirements:**
81
+ - **Vector Operations**: Convert existing docstrings to NumPy format
82
+ - **Parameter Documentation**: Standardize mathematical parameter notation
83
+ - **Returns Sections**: Add proper return value documentation
84
+ - **LaTeX Format**: Standardize existing mathematical notation formatting
85
+
86
+ ### **Medium Priority Core Modules (3 modules)**
87
+
88
+ #### **Module 5: `core/spacecraft.py` - Spacecraft Trajectory** (1 hour)
89
+ **Standardization Requirements:**
90
+ - **Format Conversion**: Convert existing docstrings to NumPy format
91
+ - **Parameter Sections**: Standardize coordinate and trajectory parameter documentation
92
+ - **Returns Documentation**: Add missing Returns sections for calculation methods
93
+
94
+ #### **Module 6: `core/tensor.py` - Tensor Mathematics** (1 hour)
95
+ **Standardization Requirements:**
96
+ - **Format Conversion**: Convert mathematical operation docstrings to NumPy format
97
+ - **Parameter Notation**: Standardize tensor parameter documentation
98
+ - **LaTeX Standardization**: Ensure consistent mathematical notation formatting
99
+
100
+ #### **Module 7: `core/alfvenic_turbulence.py` - Alfven Wave Analysis** (1.5 hours)
101
+ **Standardization Requirements:**
102
+ - **Format Conversion**: Convert existing physics documentation to NumPy format
103
+ - **Parameter Standardization**: Ensure consistent turbulence parameter documentation
104
+ - **Reference Format**: Standardize existing literature reference formatting
105
+
106
+ ### **Standard Priority Core Modules (2 modules)**
107
+
108
+ #### **Module 8: `core/units_constants.py` - Physical Constants** (0.5 hours)
109
+ **Standardization Requirements:**
110
+ - **Format Conversion**: Convert constant documentation to NumPy format
111
+ - **Unit Documentation**: Standardize unit specification format
112
+ - **Reference Standardization**: Ensure consistent citation formatting
113
+
114
+ #### **Module 9: `core/__init__.py` - Package Entry Point** (0.5 hours)
115
+ **Standardization Requirements:**
116
+ - **Module Docstring**: Add basic NumPy format module-level docstring
117
+ - **Import Documentation**: Standardize public API documentation format
118
+ - **Format Consistency**: Ensure NumPy convention compliance
119
+
120
+ ## **Format Standardization Standards for Core Modules**
121
+
122
+ ### **NumPy Format Requirements**
123
+
124
+ #### **NumPy Parameter Format Standards**
125
+ ```python
126
+ def thermal_speed(temperature, mass):
127
+ """Calculate thermal speed from temperature and mass.
128
+
129
+ Parameters
130
+ ----------
131
+ temperature : float or array_like
132
+ Ion temperature in Kelvin [K]
133
+ mass : float
134
+ Ion mass in kilograms [kg]
135
+
136
+ Returns
137
+ -------
138
+ float or ndarray
139
+ Thermal speed in meters per second [m/s]
140
+ """
141
+ ```
142
+
143
+ #### **Format Consistency Requirements**
144
+ - **Parameter Format**: All parameters with consistent `param : type` notation
145
+ - **Type Documentation**: Standardized type specifications (array_like, optional)
146
+ - **Returns Format**: Consistent return value documentation
147
+ - **Section Headers**: Proper underline formatting for all sections
148
+
149
+ #### **Conservative Documentation Approach**
150
+ **DO NOT ADD Examples sections to functions that don't already have them**
151
+
152
+ - **Existing Examples**: Convert existing examples to proper NumPy format
153
+ - **No New Examples**: Do not add Examples sections where they don't exist
154
+ - **Format Focus**: Concentrate on parameter and return documentation
155
+ - **Content Preservation**: Maintain existing scientific content accuracy
156
+
157
+ ### **Format Conversion Framework**
158
+
159
+ #### **Required Format Conversions**
160
+ - **Parameters**: Convert to NumPy `param : type` format
161
+ - **Returns**: Add Returns sections where missing
162
+ - **Existing Content**: Preserve existing Notes and References
163
+ - **No New Sections**: Do not add new Examples or References
164
+
165
+ #### **Format Validation Requirements**
166
+ - **pydocstyle Compliance**: All docstrings pass NumPy convention checks
167
+ - **Parameter Format**: Consistent parameter documentation style
168
+ - **Returns Documentation**: Proper return value format
169
+ - **Section Consistency**: Uniform section header formatting
170
+
171
+ ## **Format Conversion Strategy**
172
+
173
+ ### **Phase 2 Module Processing Order**
174
+ 1. **plasma.py** - Highest impact, most methods requiring format conversion
175
+ 2. **ions.py** - Core calculations, many methods needing standardization
176
+ 3. **base.py** - Foundation class, format affects all derived classes
177
+ 4. **vector.py** - Mathematical operations with parameter standardization needs
178
+ 5. **alfvenic_turbulence.py** - Specialized module with existing documentation
179
+ 6. **spacecraft.py** - Coordinate systems with parameter documentation
180
+ 7. **tensor.py** - Mathematical operations requiring format consistency
181
+ 8. **units_constants.py** - Constants needing standardized documentation
182
+ 9. **__init__.py** - Package entry point requiring basic module docstring
183
+
184
+ ### **Quality Assurance Process**
185
+ 1. **Format Conversion**: Convert existing docstrings to NumPy format
186
+ 2. **Content Preservation**: Ensure existing scientific content remains accurate
187
+ 3. **pydocstyle Validation**: NumPy convention compliance check
188
+ 4. **Consistency Review**: Uniform formatting across all modules
189
+ 5. **Sphinx Integration**: Verify documentation builds correctly
190
+
191
+ ## **Validation and Testing Criteria**
192
+
193
+ ### **NumPy Convention Compliance**
194
+ - [ ] All public classes have comprehensive docstrings
195
+ - [ ] All public methods follow NumPy parameter/returns format
196
+ - [ ] Properties include proper return value documentation
197
+ - [ ] Module-level docstrings provide comprehensive overviews
198
+
199
+ ### **Format Standardization Standards**
200
+ - [ ] **Parameter Format**: All parameters use NumPy `param : type` notation
201
+ - [ ] **Returns Sections**: All functions returning values have Returns documentation
202
+ - [ ] **Type Consistency**: Standardized type specifications throughout
203
+ - [ ] **Existing Content Preserved**: No loss of existing scientific information
204
+
205
+ ### **Code Quality Checks**
206
+ - [ ] **pydocstyle Compliance**: Zero NumPy convention violations
207
+ - [ ] **Sphinx Integration**: Enhanced documentation builds successfully
208
+ - [ ] **Example Validation**: All docstring examples execute correctly
209
+ - [ ] **Cross-Reference Accuracy**: Internal links and references valid
210
+
211
+ ## **Success Criteria**
212
+
213
+ ### **Primary Format Standardization Goals**
214
+ - **Format Compliance**: All 9 core modules follow NumPy docstring conventions
215
+ - **Content Preservation**: Existing scientific content maintained accurately
216
+ - **Consistency**: Uniform formatting across all core modules
217
+ - **pydocstyle Clean**: Zero violations for NumPy format compliance
218
+
219
+ ### **Quality Metrics**
220
+ - **Zero pydocstyle Violations**: Clean NumPy format compliance
221
+ - **Format Consistency**: Uniform parameter and return documentation
222
+ - **Content Preservation**: No scientific accuracy loss during conversion
223
+ - **Sphinx Compatibility**: Documentation builds without format warnings
224
+
225
+ ## **Integration with Subsequent Phases**
226
+
227
+ ### **Dependencies for Phase 3 (Fitfunctions)**
228
+ - **Format Standards**: Established NumPy convention patterns
229
+ - **Parameter Format**: Consistent mathematical parameter documentation
230
+ - **Validation Framework**: pydocstyle compliance testing established
231
+
232
+ ### **Foundation for Advanced Modules**
233
+ - **Base Class Format**: Foundation NumPy format for all derived classes
234
+ - **Format Standards**: Established consistent documentation patterns
235
+ - **Quality Framework**: pydocstyle validation processes proven effective
236
+
237
+ This conservative format standardization of core physics modules establishes the NumPy convention foundation for the entire SolarWindPy package, ensuring consistent documentation formatting while preserving scientific integrity.
@@ -0,0 +1,188 @@
1
+ # Phase 3: Fitfunctions Mathematical Modules Format Standardization
2
+
3
+ ## **Objective**
4
+ Standardize docstring formats to NumPy convention compliance for the 10 fitfunctions modules that provide mathematical curve fitting, statistical analysis, and data modeling capabilities.
5
+
6
+ ## **Scope**
7
+ Convert existing docstrings to strict NumPy format while preserving mathematical content and adding minimal missing basic documentation.
8
+
9
+ ## **Module Inventory and Format Standardization Targets**
10
+
11
+ ### **Critical Foundation Modules (2 modules)**
12
+
13
+ #### **Module 1: `fitfunctions/core.py` - Abstract FitFunction Base Class** (2 hours)
14
+ **Current Status**: Has documentation requiring NumPy format conversion
15
+
16
+ **Standardization Requirements:**
17
+ - **FitFunction Class**: Convert existing docstring to NumPy format
18
+ - **Method Documentation**: Standardize parameter and return documentation
19
+ - **Statistical Methods**: Convert existing documentation to NumPy format
20
+ - **Parameter Format**: Ensure consistent `param : type` notation
21
+
22
+ **Key Format Conversion Focus:**
23
+ - Convert existing optimization documentation to NumPy parameter format
24
+ - Standardize statistical method return documentation
25
+ - Preserve existing mathematical content while fixing format
26
+ - Add basic Returns sections where completely missing
27
+
28
+ #### **Module 2: `fitfunctions/plots.py` - Fit Visualization Tools** (1.5 hours)
29
+ **Current Status**: Limited documentation requiring format standardization
30
+
31
+ **Standardization Requirements:**
32
+ - **FFPlot Class**: Convert existing docstrings to NumPy format
33
+ - **Method Documentation**: Add basic docstrings where completely missing
34
+ - **Parameter Format**: Standardize plotting parameter documentation
35
+ - **Returns Documentation**: Add Returns sections for plotting methods
36
+
37
+ ### **Statistical Distribution Modules (4 modules)**
38
+
39
+ #### **Module 3: `fitfunctions/gaussians.py` - Gaussian Distributions** (1.5 hours)
40
+ **Standardization Requirements:**
41
+ - **Class Documentation**: Convert Gaussian function docstrings to NumPy format
42
+ - **Mathematical Notation**: Standardize existing LaTeX equation formatting
43
+ - **Parameter Documentation**: Convert to consistent `param : type` notation
44
+ - **Property Documentation**: Add Returns sections for statistical properties
45
+
46
+ #### **Module 4: `fitfunctions/exponentials.py` - Exponential Functions** (1 hour)
47
+ **Standardization Requirements:**
48
+ - **Function Documentation**: Convert exponential function docstrings to NumPy format
49
+ - **Parameter Format**: Standardize decay/growth parameter documentation
50
+ - **Mathematical Format**: Ensure consistent LaTeX formatting for existing equations
51
+
52
+ #### **Module 5: `fitfunctions/lines.py` - Linear Regression** (1 hour)
53
+ **Standardization Requirements:**
54
+ - **Linear Function**: Convert existing linear fit documentation to NumPy format
55
+ - **Statistical Documentation**: Standardize regression parameter documentation
56
+ - **Returns Format**: Add proper return value documentation
57
+
58
+ #### **Module 6: `fitfunctions/power_laws.py` - Power Law Functions** (1 hour)
59
+ **Standardization Requirements:**
60
+ - **Power Law Documentation**: Convert existing docstrings to NumPy format
61
+ - **Parameter Format**: Standardize power law parameter documentation
62
+ - **Mathematical Notation**: Ensure consistent LaTeX formatting
63
+
64
+ ### **Specialized Mathematical Modules (3 modules)**
65
+
66
+ #### **Module 7: `fitfunctions/moyal.py` - Moyal Distribution** (1 hour)
67
+ **Standardization Requirements:**
68
+ - **Moyal Function**: Convert existing specialized distribution documentation
69
+ - **Parameter Format**: Standardize Moyal parameter documentation
70
+ - **Statistical Properties**: Convert existing property documentation to NumPy format
71
+
72
+ #### **Module 8: `fitfunctions/trend_fits.py` - Trend Analysis** (0.5 hours)
73
+ **Standardization Requirements:**
74
+ - **Trend Functions**: Convert trend analysis documentation to NumPy format
75
+ - **Method Documentation**: Standardize trend calculation parameter format
76
+
77
+ #### **Module 9: `fitfunctions/tex_info.py` - LaTeX Utilities** (0.5 hours)
78
+ **Standardization Requirements:**
79
+ - **Utility Functions**: Add basic docstrings for LaTeX formatting functions
80
+ - **Parameter Documentation**: Standardize LaTeX utility parameter format
81
+
82
+ ### **Package Infrastructure (1 module)**
83
+
84
+ #### **Module 10: `fitfunctions/__init__.py` - Package Entry Point** (0.5 hours)
85
+ **Standardization Requirements:**
86
+ - **Module Docstring**: Add basic NumPy format module-level docstring
87
+ - **Import Documentation**: Standardize public API documentation format
88
+
89
+ ## **Format Standardization Standards**
90
+
91
+ ### **NumPy Convention Focus**
92
+ - **Parameter Format**: Convert all parameters to `param : type` notation
93
+ - **Returns Documentation**: Add Returns sections where functions return values
94
+ - **Mathematical Format**: Standardize existing LaTeX equation formatting
95
+ - **Type Consistency**: Use standardized type specifications (array_like, optional)
96
+
97
+ ### **Conservative Approach Guidelines**
98
+ - **DO NOT** add Examples sections to functions that don't already have them
99
+ - **DO NOT** add new mathematical content or equations
100
+ - **DO NOT** add new References sections unless converting existing informal references
101
+ - **DO** preserve all existing mathematical and statistical content
102
+ - **DO** focus on format compliance over content expansion
103
+
104
+ ### **Mathematical Documentation Standards**
105
+ ```python
106
+ def gaussian_function(x, amplitude, mean, std):
107
+ """Gaussian function evaluation.
108
+
109
+ Parameters
110
+ ----------
111
+ x : array_like
112
+ Input values where function is evaluated
113
+ amplitude : float
114
+ Peak amplitude parameter
115
+ mean : float
116
+ Distribution mean parameter
117
+ std : float
118
+ Standard deviation parameter
119
+
120
+ Returns
121
+ -------
122
+ ndarray
123
+ Function values at input points
124
+ """
125
+ ```
126
+
127
+ ## **Implementation Strategy**
128
+
129
+ ### **Phase 3 Module Processing Order**
130
+ 1. **core.py** - Foundation class affecting all fitfunction implementations
131
+ 2. **plots.py** - Visualization tools with parameter standardization needs
132
+ 3. **gaussians.py** - Most commonly used distribution functions
133
+ 4. **exponentials.py** - Standard mathematical functions
134
+ 5. **lines.py** - Simple linear regression functions
135
+ 6. **power_laws.py** - Specialized mathematical functions
136
+ 7. **moyal.py** - Advanced statistical distribution
137
+ 8. **trend_fits.py** - Trend analysis utilities
138
+ 9. **tex_info.py** - LaTeX utility functions
139
+ 10. **__init__.py** - Package entry point
140
+
141
+ ### **Quality Assurance Process**
142
+ 1. **Format Conversion**: Convert existing docstrings to NumPy format
143
+ 2. **Mathematical Preservation**: Ensure existing equations remain accurate
144
+ 3. **pydocstyle Validation**: NumPy convention compliance check
145
+ 4. **Consistency Review**: Uniform formatting across all fitfunction modules
146
+ 5. **Sphinx Integration**: Verify mathematical documentation renders correctly
147
+
148
+ ## **Validation and Testing Criteria**
149
+
150
+ ### **Format Standardization Standards**
151
+ - [ ] **Parameter Format**: All parameters use NumPy `param : type` notation
152
+ - [ ] **Returns Sections**: All functions returning values have Returns documentation
153
+ - [ ] **Mathematical Format**: Existing LaTeX equations properly formatted
154
+ - [ ] **Type Consistency**: Standardized type specifications throughout
155
+
156
+ ### **Code Quality Checks**
157
+ - [ ] **pydocstyle Compliance**: Zero NumPy convention violations
158
+ - [ ] **Mathematical Integrity**: Existing equations and algorithms preserved
159
+ - [ ] **Sphinx Integration**: Documentation builds without mathematical rendering issues
160
+ - [ ] **Format Consistency**: Uniform parameter and return documentation
161
+
162
+ ## **Success Criteria**
163
+
164
+ ### **Primary Format Standardization Goals**
165
+ - **Format Compliance**: All 10 fitfunctions modules follow NumPy docstring conventions
166
+ - **Mathematical Preservation**: Existing mathematical content maintained accurately
167
+ - **Consistency**: Uniform formatting across all fitfunctions modules
168
+ - **pydocstyle Clean**: Zero violations for NumPy format compliance
169
+
170
+ ### **Quality Metrics**
171
+ - **Zero pydocstyle Violations**: Clean NumPy format compliance
172
+ - **Mathematical Integrity**: No loss of existing mathematical documentation
173
+ - **Format Consistency**: Uniform parameter and return documentation
174
+ - **Sphinx Compatibility**: Documentation builds without format warnings
175
+
176
+ ## **Integration with Subsequent Phases**
177
+
178
+ ### **Dependencies for Phase 4 (Plotting)**
179
+ - **Format Standards**: Established NumPy convention patterns for mathematical functions
180
+ - **Parameter Documentation**: Consistent mathematical parameter formatting
181
+ - **LaTeX Standards**: Standardized mathematical notation formatting
182
+
183
+ ### **Foundation for Remaining Modules**
184
+ - **Mathematical Documentation**: Established patterns for scientific function documentation
185
+ - **Format Consistency**: Proven NumPy format conversion processes
186
+ - **Quality Framework**: pydocstyle validation for mathematical modules
187
+
188
+ This conservative format standardization of fitfunctions modules ensures NumPy convention compliance while preserving the mathematical and statistical integrity essential for scientific curve fitting and analysis.
@@ -0,0 +1,243 @@
1
+ # Phase 4: Plotting Visualization Modules Format Standardization
2
+
3
+ ## **Objective**
4
+ Standardize docstring formats to NumPy convention compliance for the 18 plotting modules that provide data visualization, publication-quality plotting, and interactive analysis capabilities.
5
+
6
+ ## **Scope**
7
+ Convert existing docstrings to strict NumPy format while preserving visualization content and adding minimal missing basic documentation.
8
+
9
+ ## **Module Inventory and Format Standardization Targets**
10
+
11
+ ### **Foundation Plotting Modules (4 modules)**
12
+
13
+ #### **Module 1: `plotting/base.py` - Base Plotting Infrastructure** (2 hours)
14
+ **Current Status**: Core plotting utilities requiring NumPy format conversion
15
+
16
+ **Standardization Requirements:**
17
+ - **Base Classes**: Convert existing plotting class docstrings to NumPy format
18
+ - **Method Documentation**: Standardize matplotlib parameter documentation
19
+ - **Parameter Format**: Convert to consistent `param : type` notation
20
+ - **Returns Documentation**: Add Returns sections for plotting methods
21
+
22
+ #### **Module 2: `plotting/agg_plot.py` - Aggregated Plot Utilities** (1.5 hours)
23
+ **Current Status**: Limited documentation requiring format standardization
24
+
25
+ **Standardization Requirements:**
26
+ - **Utility Functions**: Add basic docstrings where completely missing
27
+ - **Parameter Format**: Standardize aggregation parameter documentation
28
+ - **Returns Format**: Add proper return value documentation
29
+
30
+ #### **Module 3: `plotting/histograms.py` - Histogram Plotting (deprecated)** (0.5 hours)
31
+ **Current Status**: Deprecated module requiring minimal format updates
32
+
33
+ **Standardization Requirements:**
34
+ - **Deprecation Documentation**: Ensure proper deprecation notice formatting
35
+ - **Legacy Format**: Convert existing docstrings to NumPy format
36
+ - **Minimal Updates**: Focus only on format compliance
37
+
38
+ #### **Module 4: `plotting/tools.py` - General Plotting Tools** (1.5 hours)
39
+ **Current Status**: General utilities requiring format standardization
40
+
41
+ **Standardization Requirements:**
42
+ - **Tool Functions**: Convert existing utility docstrings to NumPy format
43
+ - **Parameter Documentation**: Standardize plotting tool parameter format
44
+ - **Helper Methods**: Add basic docstrings where missing
45
+
46
+ ### **Histogram Plotting Modules (2 modules)**
47
+
48
+ #### **Module 5: `plotting/hist1d.py` - 1D Histogram Plots** (1.5 hours)
49
+ **Standardization Requirements:**
50
+ - **Histogram Functions**: Convert existing 1D histogram docstrings to NumPy format
51
+ - **Parameter Format**: Standardize binning and styling parameter documentation
52
+ - **Returns Documentation**: Add Returns sections for histogram objects
53
+
54
+ #### **Module 6: `plotting/hist2d.py` - 2D Histogram Plots** (1.5 hours)
55
+ **Standardization Requirements:**
56
+ - **2D Histogram Functions**: Convert existing 2D plotting docstrings to NumPy format
57
+ - **Parameter Format**: Standardize 2D binning parameter documentation
58
+ - **Colormap Documentation**: Standardize colormap parameter formatting
59
+
60
+ ### **Specialized Visualization Modules (3 modules)**
61
+
62
+ #### **Module 7: `plotting/scatter.py` - Scatter Plot Utilities** (1 hour)
63
+ **Standardization Requirements:**
64
+ - **Scatter Functions**: Convert scatter plot docstrings to NumPy format
65
+ - **Parameter Format**: Standardize marker and color parameter documentation
66
+ - **Statistical Overlays**: Convert statistical annotation documentation
67
+
68
+ #### **Module 8: `plotting/spiral.py` - Spiral Mesh Calculations** (1 hour)
69
+ **Standardization Requirements:**
70
+ - **Spiral Functions**: Convert mesh calculation docstrings to NumPy format
71
+ - **Mathematical Parameters**: Standardize spiral parameter documentation
72
+ - **Coordinate Documentation**: Convert coordinate system parameter format
73
+
74
+ #### **Module 9: `plotting/orbits.py` - Orbital Trajectory Plots** (1.5 hours)
75
+ **Standardization Requirements:**
76
+ - **Orbital Functions**: Convert trajectory plotting docstrings to NumPy format
77
+ - **Coordinate Parameters**: Standardize orbital parameter documentation
78
+ - **Trajectory Documentation**: Convert existing orbital mechanics documentation
79
+
80
+ ### **Interactive and Selection Modules (1 module)**
81
+
82
+ #### **Module 10: `plotting/select_data_from_figure.py` - Interactive Data Selection** (1 hour)
83
+ **Standardization Requirements:**
84
+ - **Interactive Functions**: Convert selection tool docstrings to NumPy format
85
+ - **Event Parameters**: Standardize matplotlib event parameter documentation
86
+ - **Callback Documentation**: Convert callback function parameter format
87
+
88
+ ### **Labels Package Modules (8 modules)**
89
+
90
+ #### **Module 11: `plotting/labels/__init__.py` - Labels Package Entry Point** (0.5 hours)
91
+ **Standardization Requirements:**
92
+ - **Module Docstring**: Add basic NumPy format module-level docstring
93
+ - **Import Documentation**: Standardize labels package API documentation
94
+
95
+ #### **Module 12: `plotting/labels/base.py` - Base Label Formatting** (1 hour)
96
+ **Standardization Requirements:**
97
+ - **Label Classes**: Convert base label formatting docstrings to NumPy format
98
+ - **Formatting Parameters**: Standardize label formatting parameter documentation
99
+ - **Text Processing**: Convert text processing method documentation
100
+
101
+ #### **Module 13: `plotting/labels/special.py` - Special Scientific Labels** (1 hour)
102
+ **Standardization Requirements:**
103
+ - **Scientific Labels**: Convert specialized label docstrings to NumPy format
104
+ - **Symbol Parameters**: Standardize scientific symbol parameter documentation
105
+ - **LaTeX Format**: Ensure consistent LaTeX label formatting
106
+
107
+ #### **Module 14: `plotting/labels/chemistry.py` - Chemical Species Labels** (0.5 hours)
108
+ **Standardization Requirements:**
109
+ - **Chemical Labels**: Convert chemical species docstrings to NumPy format
110
+ - **Species Parameters**: Standardize chemical notation parameter documentation
111
+
112
+ #### **Module 15: `plotting/labels/composition.py` - Composition Ratio Labels** (0.5 hours)
113
+ **Standardization Requirements:**
114
+ - **Ratio Labels**: Convert composition ratio docstrings to NumPy format
115
+ - **Composition Parameters**: Standardize ratio parameter documentation
116
+
117
+ #### **Module 16: `plotting/labels/datetime.py` - Time Formatting Labels** (0.5 hours)
118
+ **Standardization Requirements:**
119
+ - **Time Labels**: Convert datetime formatting docstrings to NumPy format
120
+ - **Format Parameters**: Standardize time format parameter documentation
121
+
122
+ #### **Module 17: `plotting/labels/elemental_abundance.py` - Element Abundance Labels** (0.5 hours)
123
+ **Standardization Requirements:**
124
+ - **Abundance Labels**: Convert element abundance docstrings to NumPy format
125
+ - **Element Parameters**: Standardize abundance parameter documentation
126
+
127
+ ### **Package Infrastructure (1 module)**
128
+
129
+ #### **Module 18: `plotting/__init__.py` - Package Entry Point** (0.5 hours)
130
+ **Standardization Requirements:**
131
+ - **Module Docstring**: Add basic NumPy format module-level docstring
132
+ - **Import Documentation**: Standardize plotting package API documentation
133
+
134
+ ## **Format Standardization Standards**
135
+
136
+ ### **NumPy Convention Focus**
137
+ - **Parameter Format**: Convert all parameters to `param : type` notation
138
+ - **Returns Documentation**: Add Returns sections where functions return matplotlib objects
139
+ - **Plotting Format**: Standardize matplotlib parameter documentation
140
+ - **Type Consistency**: Use standardized type specifications (array_like, optional)
141
+
142
+ ### **Conservative Approach Guidelines**
143
+ - **DO NOT** add Examples sections to functions that don't already have them
144
+ - **DO NOT** add new plotting functionality or visualization content
145
+ - **DO NOT** add new References sections unless converting existing informal references
146
+ - **DO** preserve all existing matplotlib and visualization content
147
+ - **DO** focus on format compliance over content expansion
148
+
149
+ ### **Plotting Documentation Standards**
150
+ ```python
151
+ def scatter_plot(x, y, color=None, marker='o', size=50):
152
+ """Create scatter plot with scientific formatting.
153
+
154
+ Parameters
155
+ ----------
156
+ x : array_like
157
+ X-axis data values
158
+ y : array_like
159
+ Y-axis data values
160
+ color : array_like or str, optional
161
+ Color specification for markers
162
+ marker : str, optional
163
+ Marker style specification
164
+ size : float or array_like, optional
165
+ Marker size specification
166
+
167
+ Returns
168
+ -------
169
+ matplotlib.collections.PathCollection
170
+ Scatter plot collection object
171
+ """
172
+ ```
173
+
174
+ ## **Implementation Strategy**
175
+
176
+ ### **Phase 4 Module Processing Order**
177
+ 1. **base.py** - Foundation plotting infrastructure affecting all other modules
178
+ 2. **tools.py** - General utilities used across plotting functions
179
+ 3. **agg_plot.py** - Aggregation utilities
180
+ 4. **hist1d.py** - Common 1D histogram plotting
181
+ 5. **hist2d.py** - 2D histogram visualization
182
+ 6. **scatter.py** - Scatter plot utilities
183
+ 7. **spiral.py** - Specialized mesh calculations
184
+ 8. **orbits.py** - Orbital trajectory visualization
185
+ 9. **select_data_from_figure.py** - Interactive selection tools
186
+ 10. **labels/base.py** - Foundation label formatting
187
+ 11. **labels/special.py** - Scientific label utilities
188
+ 12. **labels/chemistry.py** - Chemical notation labels
189
+ 13. **labels/composition.py** - Composition ratio labels
190
+ 14. **labels/datetime.py** - Time formatting labels
191
+ 15. **labels/elemental_abundance.py** - Abundance labels
192
+ 16. **histograms.py** - Deprecated histogram module
193
+ 17. **labels/__init__.py** - Labels package entry
194
+ 18. **__init__.py** - Main plotting package entry
195
+
196
+ ### **Quality Assurance Process**
197
+ 1. **Format Conversion**: Convert existing docstrings to NumPy format
198
+ 2. **Matplotlib Preservation**: Ensure existing plotting functionality remains accurate
199
+ 3. **pydocstyle Validation**: NumPy convention compliance check
200
+ 4. **Consistency Review**: Uniform formatting across all plotting modules
201
+ 5. **Sphinx Integration**: Verify plotting documentation renders correctly
202
+
203
+ ## **Validation and Testing Criteria**
204
+
205
+ ### **Format Standardization Standards**
206
+ - [ ] **Parameter Format**: All parameters use NumPy `param : type` notation
207
+ - [ ] **Returns Sections**: All functions returning matplotlib objects have Returns documentation
208
+ - [ ] **Plotting Format**: Matplotlib parameter documentation standardized
209
+ - [ ] **Type Consistency**: Standardized type specifications throughout
210
+
211
+ ### **Code Quality Checks**
212
+ - [ ] **pydocstyle Compliance**: Zero NumPy convention violations
213
+ - [ ] **Matplotlib Integrity**: Existing plotting functionality preserved
214
+ - [ ] **Sphinx Integration**: Documentation builds without rendering issues
215
+ - [ ] **Format Consistency**: Uniform parameter and return documentation
216
+
217
+ ## **Success Criteria**
218
+
219
+ ### **Primary Format Standardization Goals**
220
+ - **Format Compliance**: All 18 plotting modules follow NumPy docstring conventions
221
+ - **Visualization Preservation**: Existing matplotlib and plotting content maintained accurately
222
+ - **Consistency**: Uniform formatting across all plotting modules
223
+ - **pydocstyle Clean**: Zero violations for NumPy format compliance
224
+
225
+ ### **Quality Metrics**
226
+ - **Zero pydocstyle Violations**: Clean NumPy format compliance
227
+ - **Matplotlib Integrity**: No loss of existing plotting documentation
228
+ - **Format Consistency**: Uniform parameter and return documentation
229
+ - **Sphinx Compatibility**: Documentation builds without format warnings
230
+
231
+ ## **Integration with Subsequent Phases**
232
+
233
+ ### **Dependencies for Phase 5 (Specialized Modules)**
234
+ - **Format Standards**: Established NumPy convention patterns for visualization functions
235
+ - **Parameter Documentation**: Consistent matplotlib parameter formatting
236
+ - **Return Documentation**: Standardized matplotlib object return formatting
237
+
238
+ ### **Foundation for Package Documentation**
239
+ - **Visualization Documentation**: Established patterns for plotting function documentation
240
+ - **Format Consistency**: Proven NumPy format conversion processes for large modules
241
+ - **Quality Framework**: pydocstyle validation for visualization modules
242
+
243
+ This conservative format standardization of plotting modules ensures NumPy convention compliance while preserving the matplotlib integration and visualization capabilities essential for scientific data analysis and publication-quality plots.