rms-oops 0.2.0__tar.gz → 0.3.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (441) hide show
  1. rms_oops-0.3.0/.claude/rules/dependency_management.md +52 -0
  2. rms_oops-0.3.0/.claude/rules/doc_dev_guide.md +122 -0
  3. rms_oops-0.3.0/.claude/rules/doc_how_to.md +95 -0
  4. rms_oops-0.3.0/.claude/rules/doc_python.md +131 -0
  5. rms_oops-0.3.0/.claude/rules/doc_readme.md +65 -0
  6. rms_oops-0.3.0/.claude/rules/doc_user_guide.md +95 -0
  7. rms_oops-0.3.0/.claude/rules/documentation.md +64 -0
  8. rms_oops-0.3.0/.claude/rules/environment.md +69 -0
  9. rms_oops-0.3.0/.claude/rules/filecache.md +212 -0
  10. rms_oops-0.3.0/.claude/rules/how_to.md +76 -0
  11. rms_oops-0.3.0/.claude/rules/logging.md +93 -0
  12. rms_oops-0.3.0/.claude/rules/python.md +108 -0
  13. rms_oops-0.3.0/.claude/rules/python_testing.md +138 -0
  14. rms_oops-0.3.0/.claude/rules/security.md +47 -0
  15. rms_oops-0.3.0/.claude/skills/bug-report/SKILL.md +79 -0
  16. rms_oops-0.3.0/.claude/skills/critique-documentation/SKILL.md +157 -0
  17. rms_oops-0.3.0/.claude/skills/critique-test-suite/SKILL.md +297 -0
  18. rms_oops-0.3.0/.claude/skills/git-workflow/SKILL.md +61 -0
  19. rms_oops-0.3.0/.claude/skills/pull-request/SKILL.md +37 -0
  20. rms_oops-0.3.0/.claude/skills/python-codebase-analysis/SKILL.md +202 -0
  21. rms_oops-0.3.0/.claude/skills/python-codebase-analysis/reference.md +80 -0
  22. rms_oops-0.3.0/.claude/skills/run-all-checks/SKILL.md +165 -0
  23. rms_oops-0.3.0/.github/ISSUE_TEMPLATE/bug_report.md +43 -0
  24. rms_oops-0.3.0/.github/ISSUE_TEMPLATE/config.yml +1 -0
  25. rms_oops-0.3.0/.github/ISSUE_TEMPLATE/feature_request.md +26 -0
  26. rms_oops-0.3.0/.github/ISSUE_TEMPLATE/other.md +24 -0
  27. rms_oops-0.3.0/.github/pull_request_template.md +52 -0
  28. rms_oops-0.3.0/.github/workflows/run-tests.yml +48 -0
  29. {rms_oops-0.2.0 → rms_oops-0.3.0}/.github/workflows/run-windows-tests.yml +2 -6
  30. rms_oops-0.3.0/CLAUDE.md +92 -0
  31. {rms_oops-0.2.0/rms_oops.egg-info → rms_oops-0.3.0}/PKG-INFO +2 -5
  32. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/__init__.py +28 -8
  33. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/_version.py +3 -3
  34. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/backplane/__init__.py +28 -17
  35. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/backplane/all.py +1 -0
  36. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/backplane/ansa.py +5 -1
  37. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/backplane/border.py +3 -0
  38. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/backplane/distance.py +3 -0
  39. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/backplane/lighting.py +13 -0
  40. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/backplane/limb.py +5 -0
  41. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/backplane/orbit.py +1 -0
  42. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/backplane/pixel.py +2 -1
  43. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/backplane/pole.py +2 -0
  44. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/backplane/resolution.py +4 -0
  45. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/backplane/ring.py +19 -1
  46. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/backplane/sky.py +7 -1
  47. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/backplane/spheroid.py +6 -3
  48. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/backplane/where.py +11 -0
  49. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/body.py +94 -86
  50. rms_oops-0.3.0/oops/cache.py +117 -0
  51. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/cadence/__init__.py +6 -0
  52. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/cadence/cadence_.py +2 -1
  53. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/cadence/dualcadence.py +15 -0
  54. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/cadence/instant.py +3 -0
  55. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/cadence/metronome.py +4 -14
  56. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/cadence/reshapedcadence.py +9 -0
  57. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/cadence/reversedcadence.py +11 -0
  58. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/cadence/sequence.py +2 -0
  59. rms_oops-0.3.0/oops/cadence/snapcadence.py +30 -0
  60. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/cadence/tdicadence.py +2 -0
  61. rms_oops-0.3.0/oops/cadence/timeshift.py +228 -0
  62. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/calibration/__init__.py +2 -0
  63. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/config.py +2 -2
  64. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/event.py +6 -5
  65. rms_oops-0.3.0/oops/fittable.py +183 -0
  66. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/fov/__init__.py +5 -0
  67. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/fov/barrelfov.py +4 -1
  68. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/fov/flatfov.py +2 -0
  69. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/fov/fov_.py +4 -3
  70. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/fov/gapfov.py +3 -0
  71. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/fov/offsetfov.py +36 -36
  72. rms_oops-0.3.0/oops/fov/platescale.py +111 -0
  73. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/fov/polynomialfov.py +3 -0
  74. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/fov/slicefov.py +3 -0
  75. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/fov/subarray.py +2 -0
  76. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/fov/subsampledfov.py +2 -0
  77. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/fov/tdifov.py +2 -0
  78. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/fov/wcsfov.py +3 -0
  79. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/frame/__init__.py +13 -6
  80. rms_oops-0.3.0/oops/frame/cmatrix.py +175 -0
  81. rms_oops-0.3.0/oops/frame/frame_.py +948 -0
  82. rms_oops-0.3.0/oops/frame/frameshift.py +164 -0
  83. rms_oops-0.3.0/oops/frame/inclinedframe.py +174 -0
  84. rms_oops-0.3.0/oops/frame/laplaceframe.py +207 -0
  85. rms_oops-0.3.0/oops/frame/navigation.py +204 -0
  86. rms_oops-0.3.0/oops/frame/poleframe.py +233 -0
  87. rms_oops-0.3.0/oops/frame/postargframe.py +121 -0
  88. rms_oops-0.3.0/oops/frame/quickframe.py +649 -0
  89. rms_oops-0.3.0/oops/frame/ringframe.py +233 -0
  90. rms_oops-0.3.0/oops/frame/rotation.py +188 -0
  91. rms_oops-0.3.0/oops/frame/spiceframe.py +573 -0
  92. rms_oops-0.3.0/oops/frame/spicetype1frame.py +355 -0
  93. rms_oops-0.3.0/oops/frame/spinframe.py +140 -0
  94. rms_oops-0.3.0/oops/frame/synchronousframe.py +116 -0
  95. rms_oops-0.3.0/oops/frame/trackerframe.py +169 -0
  96. rms_oops-0.3.0/oops/frame/twovectorframe.py +141 -0
  97. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/gold_master/__init__.py +23 -43
  98. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/gold_master/all.py +1 -0
  99. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/gold_master/test_support.py +4 -0
  100. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/gravity/__init__.py +2 -0
  101. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/gravity/gravity_.py +0 -3
  102. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/gravity/oblategravity.py +2 -1
  103. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/hosts/cassini/__init__.py +21 -3
  104. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/hosts/cassini/iss.py +104 -68
  105. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/hosts/cassini/uvis.py +0 -1
  106. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/hosts/galileo/__init__.py +2 -0
  107. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/hosts/galileo/ssi/__init__.py +16 -11
  108. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/hosts/hst/__init__.py +2 -0
  109. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/hosts/hst/acs/__init__.py +2 -1
  110. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/hosts/hst/nicmos/__init__.py +2 -0
  111. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/hosts/hst/wfc3/__init__.py +2 -1
  112. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/hosts/juno/__init__.py +20 -16
  113. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/hosts/juno/jiram/__init__.py +14 -26
  114. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/hosts/juno/jiram/img.py +11 -26
  115. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/hosts/juno/jiram/spe.py +14 -30
  116. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/hosts/juno/junocam/__init__.py +41 -149
  117. rms_oops-0.3.0/oops/hosts/juno/sru/__init__.py +278 -0
  118. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/hosts/jwst/__init__.py +2 -0
  119. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/hosts/jwst/nircam/__init__.py +2 -0
  120. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/hosts/keck/__init__.py +2 -5
  121. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/hosts/keck/nirc2/__init__.py +2 -1
  122. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/hosts/keck/nirc2.py +0 -1
  123. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/hosts/newhorizons/__init__.py +2 -3
  124. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/hosts/newhorizons/lorri.py +29 -8
  125. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/hosts/voyager/iss.py +22 -7
  126. rms_oops-0.3.0/oops/mutable.py +778 -0
  127. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/observation/__init__.py +3 -0
  128. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/observation/insitu.py +18 -7
  129. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/observation/observation_.py +166 -14
  130. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/observation/pixel.py +6 -8
  131. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/observation/rasterslit1d.py +3 -4
  132. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/observation/slit1d.py +27 -27
  133. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/observation/snapshot.py +31 -31
  134. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/observation/timedimage.py +7 -6
  135. rms_oops-0.3.0/oops/path/__init__.py +21 -0
  136. rms_oops-0.3.0/oops/path/circlepath.py +125 -0
  137. rms_oops-0.3.0/oops/path/coordpath.py +112 -0
  138. rms_oops-0.3.0/oops/path/fixedpath.py +91 -0
  139. rms_oops-0.3.0/oops/path/keplerpath.py +869 -0
  140. rms_oops-0.3.0/oops/path/linearcoordpath.py +131 -0
  141. rms_oops-0.3.0/oops/path/linearpath.py +116 -0
  142. rms_oops-0.3.0/oops/path/multipath.py +158 -0
  143. rms_oops-0.3.0/oops/path/path_.py +1454 -0
  144. rms_oops-0.3.0/oops/path/pathshift.py +161 -0
  145. rms_oops-0.3.0/oops/path/quickpath.py +449 -0
  146. rms_oops-0.3.0/oops/path/spicepath.py +349 -0
  147. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/surface/__init__.py +5 -0
  148. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/surface/ansa.py +3 -0
  149. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/surface/ellipsoid.py +2 -0
  150. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/surface/limb.py +2 -0
  151. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/surface/nullsurface.py +2 -0
  152. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/surface/orbitplane.py +2 -0
  153. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/surface/ringplane.py +2 -0
  154. rms_oops-0.3.0/oops/surface/spice_shape.py +49 -0
  155. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/surface/surface_.py +52 -41
  156. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/transform.py +15 -3
  157. {rms_oops-0.2.0 → rms_oops-0.3.0}/pyproject.toml +1 -4
  158. {rms_oops-0.2.0 → rms_oops-0.3.0/rms_oops.egg-info}/PKG-INFO +2 -5
  159. {rms_oops-0.2.0 → rms_oops-0.3.0}/rms_oops.egg-info/SOURCES.txt +51 -0
  160. rms_oops-0.3.0/rms_oops.egg-info/scm_file_list.json +408 -0
  161. rms_oops-0.3.0/rms_oops.egg-info/scm_version.json +8 -0
  162. {rms_oops-0.2.0 → rms_oops-0.3.0}/spicedb/__init__.py +13 -0
  163. rms_oops-0.3.0/tests/cadence/test_timeshift.py +56 -0
  164. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/cadence/unittester.py +1 -0
  165. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/fov/test_barrelfov.py +30 -0
  166. rms_oops-0.3.0/tests/fov/test_offsetfov.py +82 -0
  167. rms_oops-0.3.0/tests/fov/test_platescale.py +69 -0
  168. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/fov/unittester.py +2 -0
  169. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/frame/test_cmatrix.py +2 -5
  170. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/frame/test_frame.py +8 -14
  171. rms_oops-0.3.0/tests/frame/test_frameshift.py +93 -0
  172. rms_oops-0.3.0/tests/frame/test_navigation.py +73 -0
  173. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/frame/test_poleframe.py +27 -70
  174. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/frame/test_postargframe.py +0 -7
  175. rms_oops-0.3.0/tests/frame/test_quickframe.py +149 -0
  176. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/frame/test_ringframe.py +4 -10
  177. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/frame/test_spiceframe.py +54 -60
  178. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/frame/test_spinframe.py +6 -9
  179. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/frame/test_synchronousframe.py +10 -15
  180. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/frame/test_trackerframe.py +0 -3
  181. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/frame/unittester.py +3 -0
  182. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/hosts/cassini/uvis/uvis.py +1 -1
  183. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/hosts/cassini/vims/vims.py +1 -1
  184. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/hosts/juno/jiram/__init__.py +22 -24
  185. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/hosts/juno/jiram/img.py +1 -1
  186. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/hosts/juno/jiram/spe.py +1 -1
  187. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/hosts/juno/junocam/gold_master.py +2 -2
  188. rms_oops-0.3.0/tests/hosts/juno/sru/__init__.py +115 -0
  189. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/path/test_keplerpath.py +70 -18
  190. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/path/test_multipath.py +4 -6
  191. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/path/test_path.py +11 -14
  192. rms_oops-0.3.0/tests/path/test_pathshift.py +62 -0
  193. rms_oops-0.3.0/tests/path/test_quickpath.py +111 -0
  194. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/path/test_spicepath.py +116 -118
  195. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/path/unittester.py +2 -0
  196. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/surface/test_ansa.py +0 -3
  197. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/surface/test_centricellipsoid.py +0 -3
  198. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/surface/test_centricspheroid.py +0 -6
  199. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/surface/test_ellipsoid.py +0 -6
  200. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/surface/test_graphicellipsoid.py +0 -6
  201. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/surface/test_graphicspheroid.py +0 -6
  202. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/surface/test_limb.py +0 -3
  203. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/surface/test_ringplane.py +0 -6
  204. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/surface/test_spheroid.py +0 -6
  205. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/surface/test_spice_shape.py +5 -6
  206. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/surface/xtest_polarlimb-NOT-WORKING.py +2 -5
  207. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/test_body.py +2 -5
  208. rms_oops-0.3.0/tests/test_cache.py +148 -0
  209. rms_oops-0.3.0/tests/test_fittable.py +181 -0
  210. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/test_transform.py +3 -6
  211. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/unittester.py +2 -0
  212. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/unittester_with_hosts.py +3 -1
  213. rms_oops-0.2.0/.github/workflows/run-tests.yml +0 -70
  214. rms_oops-0.2.0/oops/fittable.py +0 -86
  215. rms_oops-0.2.0/oops/frame/cmatrix.py +0 -123
  216. rms_oops-0.2.0/oops/frame/frame_.py +0 -1244
  217. rms_oops-0.2.0/oops/frame/inclinedframe.py +0 -132
  218. rms_oops-0.2.0/oops/frame/laplaceframe.py +0 -225
  219. rms_oops-0.2.0/oops/frame/navigation.py +0 -144
  220. rms_oops-0.2.0/oops/frame/poleframe.py +0 -232
  221. rms_oops-0.2.0/oops/frame/postargframe.py +0 -93
  222. rms_oops-0.2.0/oops/frame/ringframe.py +0 -208
  223. rms_oops-0.2.0/oops/frame/rotation.py +0 -134
  224. rms_oops-0.2.0/oops/frame/spiceframe.py +0 -391
  225. rms_oops-0.2.0/oops/frame/spicetype1frame.py +0 -196
  226. rms_oops-0.2.0/oops/frame/spinframe.py +0 -111
  227. rms_oops-0.2.0/oops/frame/synchronousframe.py +0 -78
  228. rms_oops-0.2.0/oops/frame/trackerframe.py +0 -130
  229. rms_oops-0.2.0/oops/frame/twovectorframe.py +0 -129
  230. rms_oops-0.2.0/oops/path/__init__.py +0 -16
  231. rms_oops-0.2.0/oops/path/circlepath.py +0 -110
  232. rms_oops-0.2.0/oops/path/coordpath.py +0 -82
  233. rms_oops-0.2.0/oops/path/fixedpath.py +0 -68
  234. rms_oops-0.2.0/oops/path/keplerpath.py +0 -869
  235. rms_oops-0.2.0/oops/path/linearcoordpath.py +0 -85
  236. rms_oops-0.2.0/oops/path/linearpath.py +0 -85
  237. rms_oops-0.2.0/oops/path/multipath.py +0 -145
  238. rms_oops-0.2.0/oops/path/path_.py +0 -1529
  239. rms_oops-0.2.0/oops/path/spicepath.py +0 -236
  240. rms_oops-0.2.0/oops/surface/spice_shape.py +0 -49
  241. {rms_oops-0.2.0 → rms_oops-0.3.0}/.coveragerc +0 -0
  242. {rms_oops-0.2.0 → rms_oops-0.3.0}/.flake8 +0 -0
  243. {rms_oops-0.2.0 → rms_oops-0.3.0}/.github/workflows/publish_to_pypi.yml +0 -0
  244. {rms_oops-0.2.0 → rms_oops-0.3.0}/.github/workflows/publish_to_test_pypi.yml +0 -0
  245. {rms_oops-0.2.0 → rms_oops-0.3.0}/.github/workflows/run-lint.yml +0 -0
  246. {rms_oops-0.2.0 → rms_oops-0.3.0}/.gitignore +0 -0
  247. {rms_oops-0.2.0 → rms_oops-0.3.0}/CODE_OF_CONDUCT.md +0 -0
  248. {rms_oops-0.2.0 → rms_oops-0.3.0}/CONTRIBUTING.md +0 -0
  249. {rms_oops-0.2.0 → rms_oops-0.3.0}/LICENSE.md +0 -0
  250. {rms_oops-0.2.0 → rms_oops-0.3.0}/README.md +0 -0
  251. {rms_oops-0.2.0 → rms_oops-0.3.0}/codecov.yml +0 -0
  252. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/cmodel_/__init__.py +0 -0
  253. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/cmodel_/cmodel.py +0 -0
  254. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/cmodel_/distance.py +0 -0
  255. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/cmodel_/latitude.py +0 -0
  256. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/cmodel_/longitude.py +0 -0
  257. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/cmodel_/radius.py +0 -0
  258. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/cmodel_/unittester.py +0 -0
  259. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/deprecated/NOTES-ABOUT-OBSERVATION-CLASSES.txt +0 -0
  260. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/deprecated/extendedsource.py +0 -0
  261. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/deprecated/iss_test_suite.py +0 -0
  262. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/deprecated/pointsource.py +0 -0
  263. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/deprecated/polynomialfov.py +0 -0
  264. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/deprecated/pushbroom.py +0 -0
  265. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/deprecated/pushframe.py +0 -0
  266. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/deprecated/radialfov.py +0 -0
  267. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/deprecated/rasterscan.py +0 -0
  268. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/deprecated/rasterslit.py +0 -0
  269. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/deprecated/slit.py +0 -0
  270. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/format_/__init__.py +0 -0
  271. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/format_/format.py +0 -0
  272. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/format_/hms.py +0 -0
  273. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/format_/pythonfmt.py +0 -0
  274. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/format_/unittester.py +0 -0
  275. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/gll_ssi_masked/backplane-__init__.py +0 -0
  276. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/gll_ssi_masked/observation-__init__.py +0 -0
  277. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/gll_ssi_masked/ssi.py +0 -0
  278. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/multipath/multipath.py +0 -0
  279. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/nav_/__init__.py +0 -0
  280. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/nav_/navigation.py +0 -0
  281. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/nav_/nullnav.py +0 -0
  282. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/nav_/platescale.py +0 -0
  283. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/nav_/repointing.py +0 -0
  284. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/nav_/timeshift.py +0 -0
  285. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/nav_/unittester.py +0 -0
  286. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/old_frame_interpolation_using_matrix3.py.txt +0 -0
  287. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/old_observation_subclasses/pushbroom.py +0 -0
  288. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/old_observation_subclasses/pushframe.py +0 -0
  289. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/old_observation_subclasses/rasterscan.py +0 -0
  290. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/old_observation_subclasses/rasterslit.py +0 -0
  291. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/old_observation_subclasses/slit.py +0 -0
  292. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/packrat/__init__.py +0 -0
  293. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/packrat/packrat.py +0 -0
  294. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/packrat/packrat_arrays.py +0 -0
  295. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/packrat/packrat_entities.py +0 -0
  296. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/packrat/unittester.py +0 -0
  297. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/pds3.py +0 -0
  298. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/poleframe-with-tilt.py +0 -0
  299. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/registry.py +0 -0
  300. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/shape2d/__init__.py +0 -0
  301. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/shape2d/affine.py +0 -0
  302. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/shape2d/arc.py +0 -0
  303. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/shape2d/circle.py +0 -0
  304. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/shape2d/conic.py +0 -0
  305. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/shape2d/ellipse.py +0 -0
  306. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/shape2d/line.py +0 -0
  307. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/shape2d/point.py +0 -0
  308. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/shape2d/polygon.py +0 -0
  309. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/shape2d/triangle.py +0 -0
  310. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/spice_starcat/__init__.py +0 -0
  311. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/spice_starcat/make.sh +0 -0
  312. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/spice_starcat/spice_stcx01.i +0 -0
  313. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/spice_starcat/spice_stcx01.py +0 -0
  314. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/spice_starcat/spice_stcx01_interface.f +0 -0
  315. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/spice_starcat/spice_stcx01_wrap.c +0 -0
  316. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/spice_starcat/strings.f +0 -0
  317. {rms_oops-0.2.0 → rms_oops-0.3.0}/ideas/wobble.py +0 -0
  318. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/.coveragerc +0 -0
  319. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/calibration/calibration_.py +0 -0
  320. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/calibration/flatcalib.py +0 -0
  321. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/calibration/nullcalib.py +0 -0
  322. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/calibration/radiance.py +0 -0
  323. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/calibration/rawcounts.py +0 -0
  324. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/constants.py +0 -0
  325. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/fov/nullfov.py +0 -0
  326. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/gold_master/ansa.py +0 -0
  327. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/gold_master/border.py +0 -0
  328. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/gold_master/distance.py +0 -0
  329. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/gold_master/lighting.py +0 -0
  330. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/gold_master/limb.py +0 -0
  331. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/gold_master/orbit.py +0 -0
  332. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/gold_master/pole.py +0 -0
  333. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/gold_master/resolution.py +0 -0
  334. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/gold_master/ring.py +0 -0
  335. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/gold_master/sky.py +0 -0
  336. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/gold_master/spheroid.py +0 -0
  337. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/gold_master/where.py +0 -0
  338. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/hosts/__init__.py +0 -0
  339. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/hosts/cassini/vims.py +0 -0
  340. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/hosts/hst/acs/hrc.py +0 -0
  341. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/hosts/hst/acs/sbc.py +0 -0
  342. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/hosts/hst/acs/wfc.py +0 -0
  343. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/hosts/hst/nicmos/nic1.py +0 -0
  344. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/hosts/hst/nicmos/nic2.py +0 -0
  345. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/hosts/hst/nicmos/nic3.py +0 -0
  346. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/hosts/hst/wfc3/ir.py +0 -0
  347. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/hosts/hst/wfc3/uvis.py +0 -0
  348. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/hosts/hst/wfpc2.py +0 -0
  349. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/hosts/jwst/nircam/uncal.py +0 -0
  350. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/hosts/voyager/__init__.py +0 -0
  351. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/lightsource.py +0 -0
  352. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/meshgrid.py +0 -0
  353. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/spice_support.py +0 -0
  354. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/surface/centricellipsoid.py +0 -0
  355. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/surface/centricspheroid.py +0 -0
  356. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/surface/graphicellipsoid.py +0 -0
  357. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/surface/graphicspheroid.py +0 -0
  358. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/surface/polarlimb.py +0 -0
  359. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/surface/spheroid.py +0 -0
  360. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/unittester_support.py +0 -0
  361. {rms_oops-0.2.0 → rms_oops-0.3.0}/oops/utils.py +0 -0
  362. {rms_oops-0.2.0 → rms_oops-0.3.0}/requirements.txt +0 -0
  363. {rms_oops-0.2.0 → rms_oops-0.3.0}/rms_oops.egg-info/dependency_links.txt +0 -0
  364. {rms_oops-0.2.0 → rms_oops-0.3.0}/rms_oops.egg-info/requires.txt +0 -0
  365. {rms_oops-0.2.0 → rms_oops-0.3.0}/rms_oops.egg-info/top_level.txt +0 -0
  366. {rms_oops-0.2.0 → rms_oops-0.3.0}/scripts/automated_tests/oops_main_test.sh +0 -0
  367. {rms_oops-0.2.0 → rms_oops-0.3.0}/setup.cfg +0 -0
  368. {rms_oops-0.2.0 → rms_oops-0.3.0}/spicedb/sqlite_db.py +0 -0
  369. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/__init__.py +0 -0
  370. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/cadence/__init__.py +0 -0
  371. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/cadence/test_dualcadence.py +0 -0
  372. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/cadence/test_metronome.py +0 -0
  373. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/cadence/test_reshapedcadence.py +0 -0
  374. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/cadence/test_reversedcadence.py +0 -0
  375. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/cadence/test_sequence.py +0 -0
  376. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/cadence/test_tdicadence.py +0 -0
  377. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/calibration/__init__.py +0 -0
  378. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/calibration/test_flatcalib.py +0 -0
  379. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/calibration/test_radiance.py +0 -0
  380. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/calibration/test_rawcounts.py +0 -0
  381. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/calibration/unittester.py +0 -0
  382. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/fov/__init__.py +0 -0
  383. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/fov/test_flatfov.py +0 -0
  384. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/fov/test_polynomialfov.py +0 -0
  385. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/fov/test_subarray.py +0 -0
  386. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/fov/test_subsampledfov.py +0 -0
  387. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/fov/test_tdifov.py +0 -0
  388. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/fov/test_wcsfov.py +0 -0
  389. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/frame/__init__.py +0 -0
  390. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/frame/all.py +0 -0
  391. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/gravity/__init__.py +0 -0
  392. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/gravity/test_gravity.py +0 -0
  393. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/gravity/unittester.py +0 -0
  394. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/hosts/__init__.py +0 -0
  395. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/hosts/cassini/__init__.py +0 -0
  396. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/hosts/cassini/iss/__init__.py +0 -0
  397. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/hosts/cassini/iss/gold_master.py +0 -0
  398. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/hosts/cassini/iss/old_iss_tests.py +0 -0
  399. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/hosts/cassini/iss/standard_obs.py +0 -0
  400. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/hosts/cassini/iss/unittester.py +0 -0
  401. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/hosts/cassini/unittester.py +0 -0
  402. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/hosts/cassini/uvis/uvis_test_suite.py +0 -0
  403. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/hosts/cassini/vims/vims_test_suite.py +0 -0
  404. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/hosts/galileo/__init__.py +0 -0
  405. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/hosts/galileo/ssi/__init__.py +0 -0
  406. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/hosts/galileo/ssi/gold_master.py +0 -0
  407. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/hosts/galileo/ssi/standard_obs.py +0 -0
  408. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/hosts/galileo/ssi/unittester.py +0 -0
  409. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/hosts/galileo/unittester.py +0 -0
  410. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/hosts/hst/__init__.py +0 -0
  411. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/hosts/hst/unittester.py +0 -0
  412. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/hosts/hst/wfc3/__init__.py +0 -0
  413. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/hosts/hst/wfc3/wfc3_pointing_test copy.py +0 -0
  414. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/hosts/hst/wfc3/wfc3_pointing_test.py +0 -0
  415. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/hosts/hst/wfc3/wfc3_test_suite copy.py +0 -0
  416. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/hosts/hst/wfc3/wfc3_test_suite.py +0 -0
  417. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/hosts/juno/__init__.py +0 -0
  418. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/hosts/juno/junocam/__init__.py +0 -0
  419. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/hosts/juno/junocam/standard_obs.py +0 -0
  420. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/hosts/juno/unittester.py +0 -0
  421. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/hosts/jwst/__init__.py +0 -0
  422. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/hosts/keck/__init__.py +0 -0
  423. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/hosts/newhorizons/__init__.py +0 -0
  424. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/hosts/newhorizons/lorri.py +0 -0
  425. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/hosts/unittester.py +0 -0
  426. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/hosts/voyager/__init__.py +0 -0
  427. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/hosts/voyager/iss.py +0 -0
  428. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/observation/__init__.py +0 -0
  429. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/observation/test_pixel.py +0 -0
  430. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/observation/test_rasterslit1d.py +0 -0
  431. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/observation/test_slit1d.py +0 -0
  432. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/observation/test_snapshot.py +0 -0
  433. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/observation/test_timedimage.py +0 -0
  434. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/observation/unittester.py +0 -0
  435. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/path/__init__.py +0 -0
  436. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/path/test_circlepath.py +0 -0
  437. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/surface/__init__.py +0 -0
  438. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/surface/test_orbitplane.py +0 -0
  439. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/surface/unittester.py +0 -0
  440. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/test_event.py +0 -0
  441. {rms_oops-0.2.0 → rms_oops-0.3.0}/tests/test_utils.py +0 -0
@@ -0,0 +1,52 @@
1
+ ---
2
+ description: Standards for declaring, installing, and maintaining Python project dependencies.
3
+ ---
4
+
5
+ # Dependency Management
6
+
7
+ ## 1. Single Source of Truth
8
+
9
+ - Declare ALL dependencies in **`pyproject.toml`** under `[project]` (PEP 621).
10
+ - Do NOT maintain a separate hand-written `requirements.txt` for runtime dependencies. If a `requirements.txt` is kept, it should contain only `-e .` for backward compatibility.
11
+
12
+ ## 2. Dependency Groups
13
+
14
+ | Group | Section | Install command | Purpose |
15
+ |-------|---------|-----------------|---------|
16
+ | **Runtime** | `[project].dependencies` | `pip install .` | Required for the package to function. |
17
+ | **Dev** | `[project.optional-dependencies].dev` | `pip install -e ".[dev]"` | Testing, linting, type-checking, coverage. |
18
+ | **Docs** | `[project.optional-dependencies].docs` | `pip install -e ".[docs]"` | Sphinx and documentation extensions. |
19
+
20
+ ## 3. Version Constraints
21
+
22
+ - Specify **minimum** compatible versions for direct dependencies (e.g., `numpy>=2.2.0`).
23
+ - Do NOT pin exact versions (`==`) in library projects; exact pinning belongs in lock files or application deployments.
24
+ - For dev/docs dependencies, specify minimum versions to ensure consistent tool behavior across contributors.
25
+
26
+ ## 4. Adding or Updating Dependencies
27
+
28
+ 1. Add the dependency to the correct section in `pyproject.toml`.
29
+ 2. Run `pip install -e ".[dev]"` (or the relevant group) to verify installation.
30
+ 3. Run the full test suite and type-check to confirm compatibility.
31
+ 4. Commit the `pyproject.toml` change with a `build:` commit type.
32
+
33
+ ## 5. Security and Maintenance
34
+
35
+ - Run `pip audit` in CI to catch known vulnerabilities.
36
+ - Enable automated dependency update tooling (Dependabot, Renovate).
37
+ - Review update PRs for breaking changes before merging.
38
+ - Periodically remove unused dependencies to reduce attack surface.
39
+
40
+ ## 6. Tooling Configuration
41
+
42
+ Consolidate all tool configuration into `pyproject.toml` where supported:
43
+
44
+ | Tool | Section |
45
+ |------|---------|
46
+ | pytest | `[tool.pytest.ini_options]` |
47
+ | coverage | `[tool.coverage.run]`, `[tool.coverage.report]` |
48
+ | mypy | `[tool.mypy]`, `[[tool.mypy.overrides]]` |
49
+ | ruff | `[tool.ruff]`, `[tool.ruff.lint]` — use explicit `select = [...]` for E, F, W, I, UP, B, SIM, C4, A, N, PT, RUF (see python) |
50
+ | setuptools_scm | `[tool.setuptools_scm]` |
51
+
52
+ Do NOT create separate config files (`.coveragerc`, `.mypy.ini`, `.flake8`, `setup.cfg`) when the tool supports `pyproject.toml`.
@@ -0,0 +1,122 @@
1
+ ---
2
+ description: Format, layout, and completeness rules for the developer/contributor guide of a Python package, covering repository layout, class diagrams, per-module prose, and the API reference.
3
+ paths:
4
+ - "docs/**/*.rst"
5
+ - "docs/**/*.md"
6
+ ---
7
+
8
+ # Developer Guide
9
+
10
+ The developer guide is the manual for people who **modify, extend, build, test,
11
+ or release** the package. It explains how the code is organized, how the pieces
12
+ cooperate, and how to work on it safely. Build on `doc_python` (Sphinx,
13
+ cross-references, prose, build discipline). Assume a competent Python developer
14
+ who is new to *this* codebase; favor architecture and contracts over restating
15
+ what the code already says.
16
+
17
+ ## 1. File Layout
18
+
19
+ - Live under `docs/` (commonly a `dev_guide/` subdirectory) as reStructuredText.
20
+ - A single landing page (e.g. `dev_guide.rst`) holds a 1-2 sentence audience
21
+ statement and a `toctree` (deep `:maxdepth:`) listing the chapters in reading
22
+ order, ending with the API reference and the contribution guide.
23
+ - Organize chapters by subsystem, plus cross-cutting chapters (introduction,
24
+ architecture/class hierarchy, extending, conventions). Name files with a
25
+ shared prefix (`dev_guide_<topic>.rst`).
26
+ - The landing page is reachable from the documentation root `toctree`.
27
+
28
+ ## 2. Required Chapters
29
+
30
+ - **Introduction** — who the guide is for, how it differs from the user guide,
31
+ and a package overview (what it does, the runtime and key dependencies).
32
+ - **Repository layout** — an annotated directory tree (a `::` literal block)
33
+ with a one-line comment on each significant directory and top-level file,
34
+ and a statement of which part is the importable public package versus
35
+ supporting code.
36
+ - **Environment setup** — how to get a working development checkout:
37
+ - Clone, virtual-environment creation, and an editable install with the dev
38
+ extras (`pip install -e ".[dev]"`).
39
+ - Every environment variable needed to run, test, or build, with defaults.
40
+ - How to run the package's entry points locally, including a smoke test.
41
+ - How to run the test suite: the default invocation, how to include slower
42
+ or integration tiers, parallel/CI-matching flags, running a single
43
+ file/test, and coverage. Note the test layout and any required markers.
44
+ - How to run linters, type checks, formatters, and the docs build, plus any
45
+ one-command wrapper that runs them all.
46
+ - The CI/CD pipeline (what runs on which trigger) and the release process.
47
+ - The contribution workflow, or a pointer to the contribution guide.
48
+ - **Architecture / class hierarchy** — see Section 3.
49
+ - **Per-subsystem chapters** — see Section 4.
50
+ - **Extending the system** — see Section 5.
51
+ - **Coding conventions** — the project's style and quality rules, or a pointer
52
+ to where they live.
53
+ - **API reference** — see Section 6.
54
+
55
+ ## 3. Architecture and Class Diagrams
56
+
57
+ - Include at least one **class diagram** (a Mermaid `classDiagram` or
58
+ equivalent) showing the principal classes, their key public members, and the
59
+ relationships between them (inheritance, composition, "produces"/"consumes").
60
+ - Mark abstract classes and dataclasses; show the methods that define each
61
+ abstract contract.
62
+ - Follow every diagram with narrative prose that walks each group of classes in
63
+ turn — a diagram alone is not documentation.
64
+ - Cross-reference every class named in the narrative per `doc_python` Section 5.
65
+ Do NOT cross-reference inside the diagram block itself.
66
+ - Keep the diagram in sync with the code: a renamed or removed class invalidates
67
+ the diagram and must be fixed in the same change.
68
+
69
+ ## 4. Per-Subsystem / Per-Module Prose
70
+
71
+ Each subsystem chapter MUST give a reader enough to navigate and modify that
72
+ code without reverse-engineering it. Include:
73
+
74
+ - **Overview** — the subsystem's responsibility and how it fits the overall
75
+ flow, with a cross-reference to the module(s) it documents.
76
+ - **Per-class / per-file description** — prose for each significant class or
77
+ module: its role, the abstract contract it defines or implements (list the
78
+ methods subclasses must provide and what each returns), notable attributes,
79
+ and how instances are created and used. Describe behavior and contracts, not a
80
+ line-by-line restatement of the source.
81
+ - **Concrete subclasses / implementations** — enumerate the shipping
82
+ implementations of each abstract base and what distinguishes each.
83
+ - **Important invariants** — thread-safety and concurrency constraints, caching
84
+ and shared mutable state, ordering requirements, and units/conventions for
85
+ any quantity that is easy to get wrong. State these explicitly where they
86
+ apply.
87
+ - **API-reference pointer** — end the chapter with a link to the autodoc page(s)
88
+ for the subsystem.
89
+
90
+ ## 5. Extending the System
91
+
92
+ - Provide a step-by-step recipe for each documented extension point (adding a
93
+ plugin, backend, subclass, data source, etc.): which base class to inherit,
94
+ which methods to implement and their contracts, where to put the file, and how
95
+ to register it so the package discovers it.
96
+ - Include a minimal, correct code skeleton for each recipe in a
97
+ `.. code-block:: python` directive.
98
+ - Cross-reference the relevant subsystem chapter and the base classes involved
99
+ rather than duplicating their contracts.
100
+
101
+ ## 6. API Reference
102
+
103
+ - Generate the API reference from docstrings with `autodoc`; do not hand-write
104
+ API descriptions that will drift from the code.
105
+ - Provide an API-reference landing page with a `toctree`, plus one page per
106
+ top-level package/subpackage. On each page use `automodule` directives with
107
+ `:members:`, `:undoc-members:`, and `:show-inheritance:` so the full public
108
+ surface (including as-yet-undocumented members) is visible.
109
+ - Cover the entire importable public API: when a new public module is added,
110
+ add a corresponding API-reference entry in the same change, or it will be
111
+ silently absent from the rendered surface.
112
+ - The quality of these pages is bounded by docstring quality (`doc_python`
113
+ Section 4); thin docstrings produce a thin API reference.
114
+
115
+ ## 7. Build Discipline
116
+
117
+ The developer guide is the heaviest user of cross-references, autodoc, and
118
+ diagrams, so it is the most prone to silent breakage. It MUST build clean under
119
+ both `sphinx-build -W` (warnings as errors) and `sphinx-build -n` (nitpicky)
120
+ per `doc_python` Section 6 before delivering — every cross-reference resolving,
121
+ every `automodule` importing (mock heavy optional imports in `conf.py` rather
122
+ than dropping modules from the reference), and every diagram rendering.
@@ -0,0 +1,95 @@
1
+ ---
2
+ description: Format and completeness rules for task-focused how-to articles that walk a user through a single workflow with prerequisites, steps, and troubleshooting.
3
+ paths:
4
+ - "docs/**/*.rst"
5
+ - "docs/**/*.md"
6
+ ---
7
+
8
+ # How-To Articles
9
+
10
+ A how-to article walks a reader through ONE concrete task from start to finish.
11
+ It complements the reference material in `doc_user_guide`: the user guide
12
+ documents every option exhaustively, while a how-to picks one goal and shows the
13
+ shortest correct path to it. Build on `doc_python` (prose conventions, build
14
+ discipline). Where a how-to and the user guide describe the same workflow, keep
15
+ them consistent and link between them rather than duplicating detail.
16
+
17
+ ## 1. Audience and Tone
18
+
19
+ - Write for someone fluent in `pip` and the command line but unfamiliar with the
20
+ package internals.
21
+ - Use clear, direct, action-oriented language; define domain-specific terms on
22
+ first use.
23
+ - Focus on what the reader must do and what they should observe.
24
+
25
+ ## 2. Required Elements
26
+
27
+ 1. **Action-oriented title** — name the task as an action (e.g. "How To Export a
28
+ Report", not "Report Export Overview").
29
+ 2. **Brief introduction** — 1-3 sentences on the purpose and value of the task.
30
+ 3. **Prerequisites** — supported Python version, install command, and any
31
+ required data, environment variables, or prior configuration.
32
+ 4. **Numbered steps** — one action per step in logical order, each with the
33
+ exact API snippet or command-line invocation and a note of what the reader
34
+ should see after it.
35
+ 5. **Expected results** — a summary of the successful end state (output, files
36
+ created, side effects). Keep this consistent with the per-step observations.
37
+ 6. **Troubleshooting** — the common failure modes (import errors, missing data,
38
+ version or environment mismatches) and their fixes.
39
+ 7. **Related material** — next steps and links to the relevant user-guide
40
+ chapters or other how-to articles.
41
+
42
+ ## 3. Structure
43
+
44
+ ```markdown
45
+ # How To [Action]
46
+
47
+ [1-3 sentence introduction explaining purpose and value.]
48
+
49
+ ## Prerequisites
50
+
51
+ - Python >= <version>
52
+ - `pip install <dist-name>`
53
+ - [Any required data, environment variables, or configuration]
54
+
55
+ ## Steps
56
+
57
+ 1. Import the module:
58
+ ```python
59
+ from package import SomeClass
60
+ ```
61
+ 2. [Action]. You should see [result].
62
+ 3. [Action].
63
+
64
+ ## Expected Results
65
+
66
+ [Summary of the successful end state — output, files created, etc.]
67
+
68
+ ## Troubleshooting
69
+
70
+ - **[Problem]**: [Solution].
71
+
72
+ ## Additional Information
73
+
74
+ [Tips, performance notes, or links to related guides.]
75
+ ```
76
+
77
+ ## 4. Converting Technical Content
78
+
79
+ When turning docstrings, test scripts, or internal notes into a how-to:
80
+
81
+ 1. Identify the user-facing feature or workflow.
82
+ 2. Determine the target audience (API user, command-line user, contributor).
83
+ 3. Extract the user actions from the technical steps.
84
+ 4. Translate internal terminology into user-facing language.
85
+ 5. Add runnable examples, expected output, and troubleshooting.
86
+
87
+ ## 5. Diagrams and Figures
88
+
89
+ - **When to use**: multi-step workflows, data pipelines, or architecture that is
90
+ clearer as a visual.
91
+ - **Placement**: inline, immediately after the relevant step or section.
92
+ - **Format**: prefer text-based diagrams (e.g. Mermaid, rendered by Sphinx) for
93
+ process flows; use PNG/SVG for screenshots or data visualizations.
94
+ - **Naming**: descriptive filenames (e.g. `export-pipeline.svg`), with alt text
95
+ for accessibility.
@@ -0,0 +1,131 @@
1
+ ---
2
+ description: Foundation standards for documenting a Python package with Sphinx, ReadTheDocs, and docstrings; shared by the README, user-guide, dev-guide, and how-to rules.
3
+ ---
4
+
5
+ # Python Documentation Foundation
6
+
7
+ This rule defines the documentation system, prose conventions, docstring
8
+ rules, and Sphinx build requirements that apply to **all** documentation in a
9
+ Python package. The companion rules build on it:
10
+
11
+ - `doc_readme` — the top-level `README`.
12
+ - `doc_user_guide` — the end-user manual.
13
+ - `doc_dev_guide` — the contributor / maintainer manual and API reference.
14
+ - `doc_how_to` — task-focused how-to articles.
15
+
16
+ Read this rule first; the others assume its docstring, cross-reference, prose,
17
+ and build requirements without repeating them.
18
+
19
+ ## 1. Documentation System
20
+
21
+ - Use **Sphinx** for all project documentation, hosted on **ReadTheDocs**.
22
+ - Author narrative pages in **reStructuredText** (`.rst`). Markdown (`.md`) is
23
+ permitted only for files that must also render on the code host (the
24
+ `README`, `CONTRIBUTING`), included into Sphinx via **MyST** (`myst-parser`).
25
+ - Keep all documentation source under a single `docs/` directory with one
26
+ `conf.py`. Build outputs (`docs/_build/`) are never committed.
27
+ - After ANY code or documentation change, rebuild the full tree and fix every
28
+ warning and error before delivering (see Section 6).
29
+
30
+ ## 2. Prose Conventions
31
+
32
+ - One space between a sentence-ending period and the next sentence.
33
+ - American spelling, not British (e.g. `color`, not `colour`).
34
+ - Define each domain-specific term on first use.
35
+ - Describe the **current** state of the software only. Never anchor prose to a
36
+ moment in time or to migration history: avoid "new", "legacy", "old",
37
+ "now", "recently", "as before", "backwards compatible", and similar framing.
38
+ - Do not use unicode smart quotes, em-dashes, or arrows inside `.py` files
39
+ (they are acceptable in `.rst` and `.md`).
40
+
41
+ ## 3. Sphinx Configuration (`conf.py`)
42
+
43
+ A single `conf.py` configures the whole tree. It MUST:
44
+
45
+ - Put the importable source root on `sys.path` so `autodoc` can import the
46
+ package without an install step on the doc builder.
47
+ - Derive the version from installed package metadata (e.g.
48
+ `importlib.metadata.version`) rather than hard-coding a version string.
49
+ - Enable, at minimum, these extensions:
50
+ - `sphinx.ext.autodoc` — pull API docs from docstrings.
51
+ - `sphinx.ext.napoleon` — parse Google-style docstrings.
52
+ - `sphinx.ext.viewcode` — link API docs to highlighted source.
53
+ - `sphinx.ext.intersphinx` — cross-link to the docs of Python and key
54
+ third-party dependencies; populate `intersphinx_mapping` accordingly.
55
+ - `myst_parser` — include Markdown files (the `README`).
56
+ - A diagram extension (e.g. `sphinxcontrib.mermaid`) when the guides use
57
+ diagrams; configure it for headless/client-side rendering so CI needs no
58
+ browser.
59
+ - Set `source_suffix` to include both `.rst` and `.md`.
60
+ - Configure Napoleon for Google-style docstrings (`napoleon_google_docstring`,
61
+ `napoleon_use_param`, `napoleon_use_rtype`).
62
+ - Mock optional/heavy imports that are unavailable on the doc builder (GUI
63
+ toolkits, backends) via `autodoc_mock_imports` so `autodoc` can import every
64
+ module headlessly.
65
+ - Use `nitpick_ignore` / `nitpick_ignore_regex` ONLY for symbols that
66
+ genuinely have no resolvable target (third-party packages without a Sphinx
67
+ inventory, typing internals leaked by `autodoc`, sibling packages outside the
68
+ public API). Every entry MUST carry a comment explaining why it cannot be
69
+ linked. Never silence a nitpick warning for a symbol you actually own.
70
+
71
+ ## 4. Docstrings
72
+
73
+ - EVERY module, class, method, and function MUST have a descriptive docstring.
74
+ - Follow **PEP 257** using **Google style** with `Parameters:` (not `Args:`).
75
+ - Include `Returns:` and `Raises:` only when there are return values or raised
76
+ exceptions to document.
77
+ - Document observable behavior sufficient to write a black-box test; do not
78
+ describe internal implementation details.
79
+ - Wrap docstring text to the project's docstring width (commonly **90**
80
+ characters).
81
+ - The API reference is generated from these docstrings, so a missing or thin
82
+ docstring is a hole in the published API documentation, not a private matter.
83
+
84
+ ## 5. Cross-Reference Completeness
85
+
86
+ - EVERY mention of a code object in narrative prose MUST use the appropriate
87
+ Sphinx cross-reference role so it links to the API reference:
88
+ - `:class:`~package.module.Class``
89
+ - `:meth:`~package.module.Class.method``
90
+ - `:func:`~package.module.func``
91
+ - `:mod:`package.module``
92
+ - `:attr:`~package.module.Class.attr``
93
+ - `:data:`~package.module.NAME``
94
+ Use `:doc:` to link other documentation pages and `:ref:` for labeled
95
+ sections.
96
+ - Bare CamelCase or `module.symbol` text in prose is a violation, even when
97
+ wrapped in inline literals. Inline literals (`` `` ``) are for YAML/JSON
98
+ keys, file paths, CLI tokens, environment variables, and shell snippets —
99
+ not for API symbols.
100
+ - Cross-references are NOT required (and should be omitted) inside
101
+ `.. code-block::` directives, `::` literal blocks, diagram blocks, and
102
+ section titles.
103
+ - When a code object is added, removed, or renamed, every cross-reference to it
104
+ across the whole docs tree MUST be updated in the same change. A rename
105
+ without reference updates is a documentation regression.
106
+
107
+ ## 6. Build Discipline (warnings as errors AND nitpicky)
108
+
109
+ Documentation is correct only when it builds clean under BOTH gates:
110
+
111
+ ```bash
112
+ sphinx-build -W -b html docs docs/_build # warnings-as-errors
113
+ sphinx-build -n -b html docs docs/_build # nitpicky (catches broken xrefs)
114
+ ```
115
+
116
+ - `-W` promotes every warning (undefined label, duplicate target, malformed
117
+ directive, broken toctree) to an error.
118
+ - `-n` (nitpicky) flags every cross-reference that does not resolve to a known
119
+ target — the primary defense against the stale references in Section 5.
120
+ - BOTH must succeed with ZERO warnings before delivering. CI MUST run the same
121
+ build with the same flags; a doc change that breaks the build is not done.
122
+ - Validate complex diagrams in their authoring tool before committing.
123
+
124
+ ## 7. Change Discipline
125
+
126
+ - Any code change MUST update the affected docstrings, narrative pages, and the
127
+ `README` in the same change.
128
+ - NEVER leave stale or contradictory documentation. If a feature is removed,
129
+ remove its documentation; if it is renamed, rename every reference.
130
+ - A new public module requires a corresponding API-reference entry so it
131
+ appears in the rendered API surface (see `doc_dev_guide`).
@@ -0,0 +1,65 @@
1
+ ---
2
+ description: Format and completeness rules for the top-level README of a Python package, including badges, quickstart, and Sphinx inclusion.
3
+ paths:
4
+ - "README.md"
5
+ ---
6
+
7
+ # README
8
+
9
+ The `README` is the project's front door: it renders on the code host and on
10
+ the package index, and is included into the Sphinx documentation. Build on
11
+ `doc_python` (prose conventions, change discipline). Because it is the most
12
+ widely seen page, keep it accurate, scannable, and free of internal jargon.
13
+
14
+ ## 1. Format and Inclusion
15
+
16
+ - Write the `README` in Markdown (`README.md`) so it renders on the code host
17
+ and the package index.
18
+ - It MUST be includable into the Sphinx docs via `myst-parser` so the
19
+ introduction is authored once. Place a marker comment (for example
20
+ `<!-- start-after-point -->`) after the badge block; the documentation
21
+ includes everything **after** the marker, so the badges (host-only) never
22
+ leak into the rendered docs.
23
+ - Keep one top-level `#` title (the project name). If a documentation linter
24
+ objects to multiple `#` headings created by the introduction section, scope
25
+ the disable to the file with a comment rather than restructuring headings.
26
+
27
+ ## 2. Required Sections (in order)
28
+
29
+ 1. **Title** — the project / distribution name.
30
+ 2. **Badges** — a grouped block of status badges, each linking to its source:
31
+ release version and date, CI/test status, documentation build status, code
32
+ coverage, package-index version / supported Python versions / downloads,
33
+ open & closed issues and pull requests, license, and repository activity.
34
+ Group related badges on adjacent lines.
35
+ 3. **Introduction** — 1-3 short paragraphs in plain prose: what the package
36
+ does, the problem it solves, and who it is for. No code-object jargon.
37
+ 4. **Features** — a bulleted list with bold lead-ins summarizing the main
38
+ capabilities at a glance.
39
+ 5. **Installation** — supported Python versions, prerequisites (system
40
+ dependencies, external data, required environment variables), and the
41
+ `pip install <dist-name>` line. Include any non-obvious setup as numbered
42
+ steps with copy-pasteable code blocks.
43
+ 6. **Quick Start** — the shortest path to a first useful result. For a library,
44
+ a minimal import-and-call snippet; for a package with a command-line
45
+ component, one concrete invocation per primary entry point. Every example
46
+ MUST be runnable as written, with placeholder paths clearly marked.
47
+ 7. **Documentation** — a link to the hosted documentation and a one-line note
48
+ on how to build the docs locally.
49
+ 8. **Contributing** — a link to the contribution guide.
50
+ 9. **License** — the license name linking to the license file.
51
+
52
+ A package with no command-line component omits CLI invocations from Quick Start
53
+ and shows API usage instead; everything else applies unchanged.
54
+
55
+ ## 3. Content Rules
56
+
57
+ - The `README` is a summary and an entry point, NOT a manual. Do not document
58
+ every option or workflow here — link to the relevant user-guide page for full
59
+ references.
60
+ - Every command-line program or primary API the package ships should be
61
+ mentioned at least once with a pointer to its detailed documentation.
62
+ - Keep the badge block, supported-version statement, install command, and entry
63
+ points consistent with the packaging metadata and the user guide. When any of
64
+ these change, update the `README` in the same change (`doc_python` Section 7).
65
+ - Verify all links (badges, documentation, contributing, license) resolve.
@@ -0,0 +1,95 @@
1
+ ---
2
+ description: Format, layout, and completeness rules for the end-user guide of a Python package, covering overview, configuration, and command-line program references.
3
+ paths:
4
+ - "docs/**/*.rst"
5
+ - "docs/**/*.md"
6
+ ---
7
+
8
+ # User Guide
9
+
10
+ The user guide is the manual for people who **use** the package without reading
11
+ its source: installing it, calling its API, and running its command-line
12
+ programs. Build on `doc_python` (Sphinx, cross-references, prose, build
13
+ discipline). Write for someone fluent in Python and the command line but
14
+ unfamiliar with the package internals; never require the reader to read source
15
+ code to accomplish a documented task.
16
+
17
+ ## 1. File Layout
18
+
19
+ - Live under `docs/` in a dedicated `user_guide/` subdirectory as
20
+ reStructuredText, keeping the user manual self-contained and parallel to the
21
+ developer guide's own subdirectory.
22
+ - A single landing page (e.g. `user_guide/user_guide.rst`) holds a 1-2 sentence
23
+ introduction and a `toctree` (`:maxdepth: 2`) listing the chapters. It
24
+ contains no other prose.
25
+ - One chapter per major feature or, for packages with a command-line component,
26
+ one chapter per command-line program (or tightly related group). Name files
27
+ with a shared prefix (`user_guide_<topic>.rst`).
28
+ - Put instrument-, platform-, or format-specific material that would clutter the
29
+ main chapters into clearly named appendix pages (`user_guide_appendix_*.rst`).
30
+ - The landing page is reachable from the documentation root `toctree` (via its
31
+ subdirectory path, e.g. `user_guide/user_guide`).
32
+ - Because the chapters live in a subdirectory, references to pages OUTSIDE it
33
+ (the introduction, the developer guide) must use absolute `:doc:` targets
34
+ (a leading `/`); references among the user-guide chapters themselves stay
35
+ relative.
36
+
37
+ ## 2. Required Content
38
+
39
+ The guide as a whole MUST cover:
40
+
41
+ - **Introduction / purpose** — what the package is for and the value it
42
+ delivers, stated before any mechanics.
43
+ - **Overview** — the high-level workflow or pipeline: the main stages, how they
44
+ connect, and what the user gets out of each. A diagram helps when the flow has
45
+ more than two stages.
46
+ - **Installation and setup** — supported Python versions, install commands
47
+ (`pip`, and `pipx` when command-line programs should be available
48
+ system-wide), prerequisites, required external data, and every environment
49
+ variable the package reads. Show the layout of any expected input/output
50
+ directory tree with a literal block.
51
+ - **Configuration** — the full configuration model: where settings come from,
52
+ the precedence order when more than one source exists (command-line flag >
53
+ environment variable > config file > built-in default is the typical order),
54
+ the available settings grouped by purpose, and their defaults. If
55
+ configuration is large, give it its own chapter and cross-reference it.
56
+ - **API usage** (for any importable surface) — the common workflows as runnable
57
+ snippets with expected results.
58
+ - **Reference for every command-line program** — see Section 3.
59
+ - **Examples** — realistic end-to-end examples for the common workflows, each as
60
+ a copy-pasteable code block.
61
+
62
+ ## 3. Documenting Command-Line Programs
63
+
64
+ For EACH command-line program the package installs:
65
+
66
+ - State its name, one-line purpose, and the basic invocation syntax in a code
67
+ block (e.g. `prog SUBJECT [options]`).
68
+ - Document EVERY option, grouped into labeled subsections by purpose (input /
69
+ selection, output, processing, logging, miscellaneous). For each option give:
70
+ the exact flag and its argument placeholder, what it does, its default, and
71
+ any environment-variable or config-file equivalent it overrides.
72
+ - Note positional vs. optional arguments, repeatable options, accepted value
73
+ sets (e.g. log levels), and case sensitivity.
74
+ - Show at least one complete, runnable example invocation.
75
+ - When a program consumes or emits a structured file (a queue/task description,
76
+ a results file), document that file's schema in the chapter that owns the
77
+ program.
78
+ - If the package omits a command-line component entirely, skip this section;
79
+ document the equivalent API entry points under "API usage" instead.
80
+
81
+ ## 4. Style
82
+
83
+ - Lead each chapter with purpose and context, then mechanics; explain *why*
84
+ before *how*.
85
+ - Provide a code block for every command or API call shown; never make the
86
+ reader reconstruct an invocation from prose.
87
+ - Cross-reference other chapters, configuration, and API objects per
88
+ `doc_python` Section 5 rather than duplicating their content.
89
+ - State expected results: what the user should see, and what files are produced
90
+ and where.
91
+ - Keep option lists, defaults, and supported-value sets in exact agreement with
92
+ the program's actual argument parser and the packaging metadata. When the code
93
+ changes, update the guide in the same change.
94
+ - For step-by-step task walkthroughs that warrant their own article, follow
95
+ `doc_how_to` and link to it from the relevant chapter.
@@ -0,0 +1,64 @@
1
+ ---
2
+ description: Standards for Python library documentation using Sphinx, ReadTheDocs, and docstrings.
3
+ ---
4
+
5
+ # Documentation Standards
6
+
7
+ ## 1. Documentation System
8
+
9
+ - Use **Sphinx** for all project documentation, hosted on **ReadTheDocs**.
10
+ - After any code or doc change, run `sphinx-build` on the full documentation tree and fix all warnings and errors before delivering.
11
+
12
+ ## 2. Documentation Standard
13
+
14
+ - Always use one space between the period at the end of a sentence and the next sentence.
15
+ - Always use American spelling instead of British spelling (e.g. color instead of colour).
16
+
17
+ ## 3. Required Documentation
18
+
19
+ | Document | Contents | Keep up-to-date? |
20
+ |----------|----------|-------------------|
21
+ | **Module index** | Every module that exists or is planned (placeholders for future modules). | Yes |
22
+ | **Architecture overview** | Class hierarchy, public API surface, and interface contracts. | Yes |
23
+ | **Install guide** | `pip install` instructions, supported Python versions, optional dependencies. | Yes |
24
+ | **Usage examples** | Common workflows with code snippets and expected output. | Yes |
25
+ | **README** | Project summary, PyPI/ReadTheDocs badges, quickstart, and links to full docs. | Yes |
26
+
27
+ ## 4. Docstrings
28
+
29
+ - EVERY class, method, function, and module MUST have a descriptive docstring.
30
+ - Follow **PEP 257** using **Google style** with `Parameters:` (not `Args:`).
31
+ - Include `Returns:` and `Raises:` only if there are return values or exceptions raised.
32
+ - Include behavioral notes sufficient to write a black-box test but do not reference the internal details of the code.
33
+ - Wrap docstring text to **90** characters.
34
+
35
+ ## 5. Cross-Reference Completeness
36
+
37
+ - EVERY mention of a class, method, function, module, attribute, or data
38
+ constant in narrative prose MUST use the appropriate Sphinx cross-reference
39
+ role:
40
+ - `:class:`~nav.path.module.Class``
41
+ - `:meth:`~nav.path.module.Class.method``
42
+ - `:func:`~nav.path.module.func``
43
+ - `:mod:`nav.path.module``
44
+ - `:attr:`~nav.path.module.Class.attr``
45
+ - `:data:`~nav.path.module.NAME``
46
+ - Bare CamelCase or `module.symbol` text in narrative prose is a violation,
47
+ even when wrapped in inline literals (`` `` ``). Inline literals are for
48
+ YAML/JSON keys, file paths, CLI tokens, and shell snippets — not for API
49
+ symbols.
50
+ - Cross-references are NOT required (and should be omitted) inside
51
+ `.. code-block::` directives, `::` literal blocks, Mermaid / other diagram
52
+ blocks, YAML examples, or section titles.
53
+ - When a class, method, function, module, attribute, or data constant is
54
+ added, removed, or renamed, every cross-reference to it across the docs
55
+ tree MUST be updated in the same change. A rename without ref updates is a
56
+ documentation regression.
57
+ - Validate by building with `sphinx-build -W -b html` (warnings as errors)
58
+ AND `sphinx-build -n -b html` (nitpicky mode); both MUST succeed with zero
59
+ warnings before delivering.
60
+
61
+ ## 6. Change Discipline
62
+
63
+ - Any code change MUST update the relevant docstrings and the README if affected.
64
+ - NEVER leave stale or contradictory documentation. If a feature is removed, remove its docs.