powermean 0.1.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 (457) hide show
  1. powermean-0.1.0/.gitignore +9 -0
  2. powermean-0.1.0/CMakeLists.txt +12 -0
  3. powermean-0.1.0/LICENSE +28 -0
  4. powermean-0.1.0/PKG-INFO +53 -0
  5. powermean-0.1.0/README.md +43 -0
  6. powermean-0.1.0/docs/BUILD_GUIDE.md +35 -0
  7. powermean-0.1.0/docs/README.md +77 -0
  8. powermean-0.1.0/docs/assets/did-cohort-effects.png +0 -0
  9. powermean-0.1.0/docs/assets/gravity-intervals.png +0 -0
  10. powermean-0.1.0/docs/assets/powermean-logo.png +0 -0
  11. powermean-0.1.0/docs/availability.md +36 -0
  12. powermean-0.1.0/docs/build-guide.mjs +178 -0
  13. powermean-0.1.0/docs/examples/README.md +25 -0
  14. powermean-0.1.0/docs/examples/compare-samples.md +231 -0
  15. powermean-0.1.0/docs/examples/iols_first_fit.py +47 -0
  16. powermean-0.1.0/docs/examples/nonlinear-did.md +437 -0
  17. powermean-0.1.0/docs/examples/reuse-a-fit.md +279 -0
  18. powermean-0.1.0/docs/from-ppmlhdfe.md +48 -0
  19. powermean-0.1.0/docs/get-started.md +204 -0
  20. powermean-0.1.0/docs/guide.css +36 -0
  21. powermean-0.1.0/docs/guide.html +6318 -0
  22. powermean-0.1.0/docs/guide.qmd +4405 -0
  23. powermean-0.1.0/docs/help/prepare-data.md +53 -0
  24. powermean-0.1.0/docs/help/report-a-problem.md +57 -0
  25. powermean-0.1.0/docs/help/troubleshooting.md +128 -0
  26. powermean-0.1.0/docs/install.md +81 -0
  27. powermean-0.1.0/docs/iols_installation.md +121 -0
  28. powermean-0.1.0/docs/methods/bias-correction.md +130 -0
  29. powermean-0.1.0/docs/methods/cancellation.md +124 -0
  30. powermean-0.1.0/docs/methods/covariance-refinements.md +121 -0
  31. powermean-0.1.0/docs/methods/fixed-effects.md +97 -0
  32. powermean-0.1.0/docs/methods/inference.md +70 -0
  33. powermean-0.1.0/docs/methods/model.md +142 -0
  34. powermean-0.1.0/docs/methods/numerical-methods.md +55 -0
  35. powermean-0.1.0/docs/methods/proportional-effects.md +65 -0
  36. powermean-0.1.0/docs/reference/api.md +418 -0
  37. powermean-0.1.0/docs/reference/experimental-fixed-effects.md +247 -0
  38. powermean-0.1.0/docs/reference/iols_options.md +31 -0
  39. powermean-0.1.0/docs/reference/options.md +293 -0
  40. powermean-0.1.0/docs/reference/results.md +474 -0
  41. powermean-0.1.0/docs/reference/solver-options.md +121 -0
  42. powermean-0.1.0/docs/reference/tables.md +141 -0
  43. powermean-0.1.0/docs/references.md +55 -0
  44. powermean-0.1.0/docs/validation.md +61 -0
  45. powermean-0.1.0/examples/first_fit.py +57 -0
  46. powermean-0.1.0/examples/nonlinear_did.py +200 -0
  47. powermean-0.1.0/examples/short_panel.py +45 -0
  48. powermean-0.1.0/licenses/NATIVE_NOTICE.md +37 -0
  49. powermean-0.1.0/licenses/PYBIND11_LICENSE +29 -0
  50. powermean-0.1.0/licenses/eigen/COPYING.BSD +26 -0
  51. powermean-0.1.0/licenses/eigen/COPYING.MPL2 +373 -0
  52. powermean-0.1.0/licenses/eigen/HEADER_NOTICES.txt +74 -0
  53. powermean-0.1.0/licenses/pybind11/EXECUTORCH_LICENSE +37 -0
  54. powermean-0.1.0/licenses/pybind11/LLVM_LICENSE +279 -0
  55. powermean-0.1.0/pyproject.toml +679 -0
  56. powermean-0.1.0/src/powermean/__init__.py +110 -0
  57. powermean-0.1.0/src/powermean/_native/__init__.py +5 -0
  58. powermean-0.1.0/src/powermean/_native/basis/CMakeLists.txt +15 -0
  59. powermean-0.1.0/src/powermean/_native/basis/__init__.py +14 -0
  60. powermean-0.1.0/src/powermean/_native/basis/build.py +71 -0
  61. powermean-0.1.0/src/powermean/_native/basis/echelon.cpp +584 -0
  62. powermean-0.1.0/src/powermean/_native/basis_lifecycle.cpp +2074 -0
  63. powermean-0.1.0/src/powermean/_native/iols/CMakeLists.txt +60 -0
  64. powermean-0.1.0/src/powermean/_native/iols/__init__.py +5 -0
  65. powermean-0.1.0/src/powermean/_native/iols/bind.cpp +2999 -0
  66. powermean-0.1.0/src/powermean/_native/iols/build.py +93 -0
  67. powermean-0.1.0/src/powermean/_native/label_checks.cpp +609 -0
  68. powermean-0.1.0/src/powermean/_prepare/__init__.py +16 -0
  69. powermean-0.1.0/src/powermean/_prepare/compose.py +411 -0
  70. powermean-0.1.0/src/powermean/_prepare/dependence.py +569 -0
  71. powermean-0.1.0/src/powermean/_prepare/effects.py +149 -0
  72. powermean-0.1.0/src/powermean/_prepare/inputs.py +179 -0
  73. powermean-0.1.0/src/powermean/_prepare/owned.py +152 -0
  74. powermean-0.1.0/src/powermean/_vendor/SKLEARN_COPYING +319 -0
  75. powermean-0.1.0/src/powermean/_vendor/__init__.py +18 -0
  76. powermean-0.1.0/src/powermean/_vendor/_compat.py +192 -0
  77. powermean-0.1.0/src/powermean/_vendor/_scipy.py +98 -0
  78. powermean-0.1.0/src/powermean/_vendor/_typing.py +143 -0
  79. powermean-0.1.0/src/powermean/_vendor/vendor_linear_loss.py +877 -0
  80. powermean-0.1.0/src/powermean/_vendor/vendor_newton.py +737 -0
  81. powermean-0.1.0/src/powermean/api.py +414 -0
  82. powermean-0.1.0/src/powermean/data/__init__.py +15 -0
  83. powermean-0.1.0/src/powermean/data/_arrays.py +56 -0
  84. powermean-0.1.0/src/powermean/data/accounting.py +151 -0
  85. powermean-0.1.0/src/powermean/data/collinearity.py +482 -0
  86. powermean-0.1.0/src/powermean/data/collinearity_geometry.py +445 -0
  87. powermean-0.1.0/src/powermean/data/collinearity_numeric.py +427 -0
  88. powermean-0.1.0/src/powermean/data/collinearity_records.py +441 -0
  89. powermean-0.1.0/src/powermean/data/computation.py +188 -0
  90. powermean-0.1.0/src/powermean/data/design.py +269 -0
  91. powermean-0.1.0/src/powermean/data/fe_component_storage.py +438 -0
  92. powermean-0.1.0/src/powermean/data/fingerprint.py +316 -0
  93. powermean-0.1.0/src/powermean/data/inference_conventions.py +201 -0
  94. powermean-0.1.0/src/powermean/data/inference_requests.py +358 -0
  95. powermean-0.1.0/src/powermean/data/inputs.py +243 -0
  96. powermean-0.1.0/src/powermean/data/numeric_fit.py +176 -0
  97. powermean-0.1.0/src/powermean/data/raw.py +672 -0
  98. powermean-0.1.0/src/powermean/data/request_values.py +200 -0
  99. powermean-0.1.0/src/powermean/data/retained.py +579 -0
  100. powermean-0.1.0/src/powermean/data/sample.py +295 -0
  101. powermean-0.1.0/src/powermean/data/sample_fe.py +592 -0
  102. powermean-0.1.0/src/powermean/data/sample_fe_source.py +701 -0
  103. powermean-0.1.0/src/powermean/data/sample_fe_state.py +615 -0
  104. powermean-0.1.0/src/powermean/data/specs.py +528 -0
  105. powermean-0.1.0/src/powermean/data/weights.py +205 -0
  106. powermean-0.1.0/src/powermean/describe/__init__.py +26 -0
  107. powermean-0.1.0/src/powermean/describe/balance.py +311 -0
  108. powermean-0.1.0/src/powermean/describe/balance_regression.py +380 -0
  109. powermean-0.1.0/src/powermean/describe/common.py +90 -0
  110. powermean-0.1.0/src/powermean/describe/frame.py +482 -0
  111. powermean-0.1.0/src/powermean/describe/numeric.py +561 -0
  112. powermean-0.1.0/src/powermean/describe/options.py +290 -0
  113. powermean-0.1.0/src/powermean/describe/outcome.py +438 -0
  114. powermean-0.1.0/src/powermean/describe/regression.py +142 -0
  115. powermean-0.1.0/src/powermean/describe/summary.py +211 -0
  116. powermean-0.1.0/src/powermean/effects/__init__.py +5 -0
  117. powermean-0.1.0/src/powermean/effects/targets.py +364 -0
  118. powermean-0.1.0/src/powermean/errors.py +242 -0
  119. powermean-0.1.0/src/powermean/fe/__init__.py +22 -0
  120. powermean-0.1.0/src/powermean/fe/_cancel_storage.py +102 -0
  121. powermean-0.1.0/src/powermean/fe/absorb.py +554 -0
  122. powermean-0.1.0/src/powermean/fe/absorb_acceleration.py +628 -0
  123. powermean-0.1.0/src/powermean/fe/absorb_numeric.py +837 -0
  124. powermean-0.1.0/src/powermean/fe/absorb_within.py +76 -0
  125. powermean-0.1.0/src/powermean/fe/admission.py +265 -0
  126. powermean-0.1.0/src/powermean/fe/admission_budget.py +75 -0
  127. powermean-0.1.0/src/powermean/fe/admission_incidence.py +717 -0
  128. powermean-0.1.0/src/powermean/fe/admission_records.py +124 -0
  129. powermean-0.1.0/src/powermean/fe/admission_slopes.py +204 -0
  130. powermean-0.1.0/src/powermean/fe/cancel.py +226 -0
  131. powermean-0.1.0/src/powermean/fe/cancelled_joint_basis.py +150 -0
  132. powermean-0.1.0/src/powermean/fe/certificate_basis.py +3905 -0
  133. powermean-0.1.0/src/powermean/fe/certificate_coordinates.py +828 -0
  134. powermean-0.1.0/src/powermean/fe/certificate_witness.py +665 -0
  135. powermean-0.1.0/src/powermean/fe/connectivity.py +352 -0
  136. powermean-0.1.0/src/powermean/fe/geometry.py +732 -0
  137. powermean-0.1.0/src/powermean/fe/geometry_checks.py +353 -0
  138. powermean-0.1.0/src/powermean/fe/geometry_design.py +542 -0
  139. powermean-0.1.0/src/powermean/fe/geometry_eigh.py +44 -0
  140. powermean-0.1.0/src/powermean/fe/geometry_errors.py +67 -0
  141. powermean-0.1.0/src/powermean/fe/geometry_gram.py +595 -0
  142. powermean-0.1.0/src/powermean/fe/geometry_rank.py +1542 -0
  143. powermean-0.1.0/src/powermean/fe/geometry_storage.py +35 -0
  144. powermean-0.1.0/src/powermean/fe/groups.py +702 -0
  145. powermean-0.1.0/src/powermean/fe/primitive_codes.py +196 -0
  146. powermean-0.1.0/src/powermean/fe/profile.py +620 -0
  147. powermean-0.1.0/src/powermean/fe/profile_arithmetic.py +1186 -0
  148. powermean-0.1.0/src/powermean/fe/profile_nb2.py +526 -0
  149. powermean-0.1.0/src/powermean/fe/profile_nb2_scalar.py +483 -0
  150. powermean-0.1.0/src/powermean/fe/reductions.py +531 -0
  151. powermean-0.1.0/src/powermean/fe/retained.py +147 -0
  152. powermean-0.1.0/src/powermean/fe/retained_live.py +316 -0
  153. powermean-0.1.0/src/powermean/formula/__init__.py +11 -0
  154. powermean-0.1.0/src/powermean/formula/formulaic_api.py +268 -0
  155. powermean-0.1.0/src/powermean/formula/frame.py +361 -0
  156. powermean-0.1.0/src/powermean/formula/grammar.py +299 -0
  157. powermean-0.1.0/src/powermean/formula/materialization.py +200 -0
  158. powermean-0.1.0/src/powermean/formula/names.py +341 -0
  159. powermean-0.1.0/src/powermean/formula/validity.py +133 -0
  160. powermean-0.1.0/src/powermean/inference/__init__.py +14 -0
  161. powermean-0.1.0/src/powermean/inference/absorbed.py +205 -0
  162. powermean-0.1.0/src/powermean/inference/absorbed_block_hc.py +303 -0
  163. powermean-0.1.0/src/powermean/inference/absorbed_code_tuples.py +60 -0
  164. powermean-0.1.0/src/powermean/inference/absorbed_composition.py +174 -0
  165. powermean-0.1.0/src/powermean/inference/absorbed_constant.py +205 -0
  166. powermean-0.1.0/src/powermean/inference/absorbed_d4_scale.py +145 -0
  167. powermean-0.1.0/src/powermean/inference/absorbed_details.py +92 -0
  168. powermean-0.1.0/src/powermean/inference/absorbed_hc_scale.py +108 -0
  169. powermean-0.1.0/src/powermean/inference/absorbed_linear.py +681 -0
  170. powermean-0.1.0/src/powermean/inference/absorbed_preflight.py +446 -0
  171. powermean-0.1.0/src/powermean/inference/absorbed_rank.py +512 -0
  172. powermean-0.1.0/src/powermean/inference/absorbed_rows.py +23 -0
  173. powermean-0.1.0/src/powermean/inference/absorbed_warnings.py +39 -0
  174. powermean-0.1.0/src/powermean/inference/block_leverage.py +432 -0
  175. powermean-0.1.0/src/powermean/inference/bread.py +213 -0
  176. powermean-0.1.0/src/powermean/inference/cancelled.py +174 -0
  177. powermean-0.1.0/src/powermean/inference/cancelled_hc.py +305 -0
  178. powermean-0.1.0/src/powermean/inference/coefficient_combinations.py +310 -0
  179. powermean-0.1.0/src/powermean/inference/coefficient_expressions.py +299 -0
  180. powermean-0.1.0/src/powermean/inference/contributions.py +284 -0
  181. powermean-0.1.0/src/powermean/inference/convention.py +362 -0
  182. powermean-0.1.0/src/powermean/inference/correction/__init__.py +5 -0
  183. powermean-0.1.0/src/powermean/inference/correction/_cancelled_operator.py +444 -0
  184. powermean-0.1.0/src/powermean/inference/correction/_inputs.py +145 -0
  185. powermean-0.1.0/src/powermean/inference/correction/_row_derivatives.py +190 -0
  186. powermean-0.1.0/src/powermean/inference/correction/budget.py +167 -0
  187. powermean-0.1.0/src/powermean/inference/correction/cell.py +254 -0
  188. powermean-0.1.0/src/powermean/inference/correction/operator.py +311 -0
  189. powermean-0.1.0/src/powermean/inference/correction/pairs.py +137 -0
  190. powermean-0.1.0/src/powermean/inference/correction/selector.py +354 -0
  191. powermean-0.1.0/src/powermean/inference/correction/short_group.py +443 -0
  192. powermean-0.1.0/src/powermean/inference/hc.py +1086 -0
  193. powermean-0.1.0/src/powermean/inference/hc_provider.py +255 -0
  194. powermean-0.1.0/src/powermean/inference/influence.py +194 -0
  195. powermean-0.1.0/src/powermean/inference/leverage.py +759 -0
  196. powermean-0.1.0/src/powermean/inference/linear_provider.py +174 -0
  197. powermean-0.1.0/src/powermean/inference/multiway.py +370 -0
  198. powermean-0.1.0/src/powermean/inference/numeric.py +109 -0
  199. powermean-0.1.0/src/powermean/inference/provider.py +176 -0
  200. powermean-0.1.0/src/powermean/inference/psd.py +627 -0
  201. powermean-0.1.0/src/powermean/inference/restriction_rank.py +192 -0
  202. powermean-0.1.0/src/powermean/inference/ssc.py +843 -0
  203. powermean-0.1.0/src/powermean/inference/vcov.py +524 -0
  204. powermean-0.1.0/src/powermean/inference/wz_absorbed.py +155 -0
  205. powermean-0.1.0/src/powermean/inference/wz_binding.py +1056 -0
  206. powermean-0.1.0/src/powermean/inference/wz_coefficient.py +337 -0
  207. powermean-0.1.0/src/powermean/inference/wz_covariance.py +373 -0
  208. powermean-0.1.0/src/powermean/inference/wz_operator.py +727 -0
  209. powermean-0.1.0/src/powermean/inference/wz_resources.py +35 -0
  210. powermean-0.1.0/src/powermean/interface/__init__.py +19 -0
  211. powermean-0.1.0/src/powermean/interface/_ordinary_pair_default.py +242 -0
  212. powermean-0.1.0/src/powermean/interface/cancelled_fit.py +828 -0
  213. powermean-0.1.0/src/powermean/interface/cancelled_selection.py +432 -0
  214. powermean-0.1.0/src/powermean/interface/cancelled_tau1_origin.py +317 -0
  215. powermean-0.1.0/src/powermean/interface/dispatch.py +683 -0
  216. powermean-0.1.0/src/powermean/interface/expressions.py +199 -0
  217. powermean-0.1.0/src/powermean/interface/fe_bias.py +590 -0
  218. powermean-0.1.0/src/powermean/interface/fe_bias_options.py +30 -0
  219. powermean-0.1.0/src/powermean/interface/fe_cancelled_result.py +649 -0
  220. powermean-0.1.0/src/powermean/interface/fe_dispatch.py +2013 -0
  221. powermean-0.1.0/src/powermean/interface/fe_joint_result.py +1086 -0
  222. powermean-0.1.0/src/powermean/interface/fe_light.py +1512 -0
  223. powermean-0.1.0/src/powermean/interface/fe_linear.py +445 -0
  224. powermean-0.1.0/src/powermean/interface/fe_options.py +486 -0
  225. powermean-0.1.0/src/powermean/interface/fe_result_backends.py +569 -0
  226. powermean-0.1.0/src/powermean/interface/fe_root.py +193 -0
  227. powermean-0.1.0/src/powermean/interface/numeric_execution.py +676 -0
  228. powermean-0.1.0/src/powermean/interface/options.py +1465 -0
  229. powermean-0.1.0/src/powermean/interface/owned_fit_state.py +522 -0
  230. powermean-0.1.0/src/powermean/interface/ppml_audit.py +38 -0
  231. powermean-0.1.0/src/powermean/interface/preparation.py +502 -0
  232. powermean-0.1.0/src/powermean/interface/retained_admission.py +467 -0
  233. powermean-0.1.0/src/powermean/interface/retained_binding.py +553 -0
  234. powermean-0.1.0/src/powermean/interface/retained_context.py +663 -0
  235. powermean-0.1.0/src/powermean/interface/retained_covariance.py +209 -0
  236. powermean-0.1.0/src/powermean/interface/retained_metadata.py +550 -0
  237. powermean-0.1.0/src/powermean/interface/retained_outcomes.py +419 -0
  238. powermean-0.1.0/src/powermean/interface/retained_postfit.py +242 -0
  239. powermean-0.1.0/src/powermean/interface/retained_preparation.py +277 -0
  240. powermean-0.1.0/src/powermean/interface/retained_result.py +269 -0
  241. powermean-0.1.0/src/powermean/interface/retained_space.py +398 -0
  242. powermean-0.1.0/src/powermean/interface/retained_time.py +397 -0
  243. powermean-0.1.0/src/powermean/interface/retained_traces.py +297 -0
  244. powermean-0.1.0/src/powermean/interface/retention.py +305 -0
  245. powermean-0.1.0/src/powermean/interface/sample.py +924 -0
  246. powermean-0.1.0/src/powermean/interface/sample_encoding.py +64 -0
  247. powermean-0.1.0/src/powermean/interface/sample_evidence.py +361 -0
  248. powermean-0.1.0/src/powermean/interface/sample_records.py +892 -0
  249. powermean-0.1.0/src/powermean/messages.py +504 -0
  250. powermean-0.1.0/src/powermean/model/__init__.py +5 -0
  251. powermean-0.1.0/src/powermean/model/matrix.py +22 -0
  252. powermean-0.1.0/src/powermean/model/order.py +337 -0
  253. powermean-0.1.0/src/powermean/model/order_scale.py +422 -0
  254. powermean-0.1.0/src/powermean/model/rows.py +573 -0
  255. powermean-0.1.0/src/powermean/model/variance.py +335 -0
  256. powermean-0.1.0/src/powermean/py.typed +0 -0
  257. powermean-0.1.0/src/powermean/results/__init__.py +33 -0
  258. powermean-0.1.0/src/powermean/results/absorbed_assessment_binding.py +239 -0
  259. powermean-0.1.0/src/powermean/results/absorbed_assessment_capture.py +467 -0
  260. powermean-0.1.0/src/powermean/results/absorbed_assessment_handoff.py +466 -0
  261. powermean-0.1.0/src/powermean/results/absorbed_attempts.py +394 -0
  262. powermean-0.1.0/src/powermean/results/absorbed_binding.py +614 -0
  263. powermean-0.1.0/src/powermean/results/absorbed_checks.py +298 -0
  264. powermean-0.1.0/src/powermean/results/absorbed_geometry.py +332 -0
  265. powermean-0.1.0/src/powermean/results/absorbed_geometry_records.py +484 -0
  266. powermean-0.1.0/src/powermean/results/absorbed_groupings.py +614 -0
  267. powermean-0.1.0/src/powermean/results/absorbed_handoff.py +583 -0
  268. powermean-0.1.0/src/powermean/results/absorbed_history.py +434 -0
  269. powermean-0.1.0/src/powermean/results/absorbed_linear_history.py +275 -0
  270. powermean-0.1.0/src/powermean/results/absorbed_outcome_records.py +388 -0
  271. powermean-0.1.0/src/powermean/results/absorbed_owned.py +589 -0
  272. powermean-0.1.0/src/powermean/results/absorbed_partitions.py +632 -0
  273. powermean-0.1.0/src/powermean/results/absorbed_point_records.py +273 -0
  274. powermean-0.1.0/src/powermean/results/absorbed_points.py +421 -0
  275. powermean-0.1.0/src/powermean/results/absorbed_retained.py +494 -0
  276. powermean-0.1.0/src/powermean/results/absorbed_root.py +236 -0
  277. powermean-0.1.0/src/powermean/results/absorbed_root_binding.py +166 -0
  278. powermean-0.1.0/src/powermean/results/absorbed_root_records.py +199 -0
  279. powermean-0.1.0/src/powermean/results/absorbed_sample.py +842 -0
  280. powermean-0.1.0/src/powermean/results/absorbed_sample_binding.py +794 -0
  281. powermean-0.1.0/src/powermean/results/absorbed_scale_cache.py +317 -0
  282. powermean-0.1.0/src/powermean/results/absorbed_state_records.py +417 -0
  283. powermean-0.1.0/src/powermean/results/absorbed_states.py +406 -0
  284. powermean-0.1.0/src/powermean/results/absorbed_trace.py +354 -0
  285. powermean-0.1.0/src/powermean/results/active_covariance.py +298 -0
  286. powermean-0.1.0/src/powermean/results/binding.py +368 -0
  287. powermean-0.1.0/src/powermean/results/cancelled_bias.py +71 -0
  288. powermean-0.1.0/src/powermean/results/cancelled_inference.py +257 -0
  289. powermean-0.1.0/src/powermean/results/cancelled_provenance.py +129 -0
  290. powermean-0.1.0/src/powermean/results/cancelled_recovery.py +216 -0
  291. powermean-0.1.0/src/powermean/results/cancelled_retained.py +451 -0
  292. powermean-0.1.0/src/powermean/results/cancelled_rows.py +273 -0
  293. powermean-0.1.0/src/powermean/results/citations.py +219 -0
  294. powermean-0.1.0/src/powermean/results/cluster_covariance.py +382 -0
  295. powermean-0.1.0/src/powermean/results/contrast_reporting.py +217 -0
  296. powermean-0.1.0/src/powermean/results/covariance.py +705 -0
  297. powermean-0.1.0/src/powermean/results/effect_design.py +198 -0
  298. powermean-0.1.0/src/powermean/results/effect_reporting.py +308 -0
  299. powermean-0.1.0/src/powermean/results/etable.py +442 -0
  300. powermean-0.1.0/src/powermean/results/etable_models.py +346 -0
  301. powermean-0.1.0/src/powermean/results/etable_options.py +208 -0
  302. powermean-0.1.0/src/powermean/results/fe_helpers.py +221 -0
  303. powermean-0.1.0/src/powermean/results/fe_result_backends.py +101 -0
  304. powermean-0.1.0/src/powermean/results/fe_sample.py +394 -0
  305. powermean-0.1.0/src/powermean/results/handoff.py +1676 -0
  306. powermean-0.1.0/src/powermean/results/indefinite.py +52 -0
  307. powermean-0.1.0/src/powermean/results/naming.py +142 -0
  308. powermean-0.1.0/src/powermean/results/numeric_assessment.py +173 -0
  309. powermean-0.1.0/src/powermean/results/ordinary_support.py +181 -0
  310. powermean-0.1.0/src/powermean/results/owned.py +523 -0
  311. powermean-0.1.0/src/powermean/results/point.py +492 -0
  312. powermean-0.1.0/src/powermean/results/prediction.py +207 -0
  313. powermean-0.1.0/src/powermean/results/provenance.py +646 -0
  314. powermean-0.1.0/src/powermean/results/restriction_reporting.py +239 -0
  315. powermean-0.1.0/src/powermean/results/result.py +950 -0
  316. powermean-0.1.0/src/powermean/results/retained.py +370 -0
  317. powermean-0.1.0/src/powermean/results/retained_collinearity.py +215 -0
  318. powermean-0.1.0/src/powermean/results/retained_collinearity_geometry.py +277 -0
  319. powermean-0.1.0/src/powermean/results/retained_diagnostic_problems.py +395 -0
  320. powermean-0.1.0/src/powermean/results/retained_gamma.py +281 -0
  321. powermean-0.1.0/src/powermean/results/retained_gamma_witnesses.py +398 -0
  322. powermean-0.1.0/src/powermean/results/retained_hc.py +839 -0
  323. powermean-0.1.0/src/powermean/results/retained_hc_records.py +434 -0
  324. powermean-0.1.0/src/powermean/results/retained_index_values.py +78 -0
  325. powermean-0.1.0/src/powermean/results/retained_inference.py +1755 -0
  326. powermean-0.1.0/src/powermean/results/retained_input_values.py +485 -0
  327. powermean-0.1.0/src/powermean/results/retained_inputs.py +225 -0
  328. powermean-0.1.0/src/powermean/results/retained_labels.py +554 -0
  329. powermean-0.1.0/src/powermean/results/retained_rectifier.py +369 -0
  330. powermean-0.1.0/src/powermean/results/retained_support.py +380 -0
  331. powermean-0.1.0/src/powermean/results/retained_support_lp.py +202 -0
  332. powermean-0.1.0/src/powermean/results/retained_support_witnesses.py +343 -0
  333. powermean-0.1.0/src/powermean/results/sample.py +227 -0
  334. powermean-0.1.0/src/powermean/results/saturated.py +196 -0
  335. powermean-0.1.0/src/powermean/results/summary.py +363 -0
  336. powermean-0.1.0/src/powermean/results/table_writers.py +277 -0
  337. powermean-0.1.0/src/powermean/results/tables.py +271 -0
  338. powermean-0.1.0/src/powermean/results/wz_bias.py +103 -0
  339. powermean-0.1.0/src/powermean/results/wz_inference.py +195 -0
  340. powermean-0.1.0/src/powermean/solve/__init__.py +7 -0
  341. powermean-0.1.0/src/powermean/solve/absorbed_certificate.py +721 -0
  342. powermean-0.1.0/src/powermean/solve/absorbed_certificate_block.py +588 -0
  343. powermean-0.1.0/src/powermean/solve/absorbed_certificate_factor.py +393 -0
  344. powermean-0.1.0/src/powermean/solve/absorbed_certificate_final.py +362 -0
  345. powermean-0.1.0/src/powermean/solve/absorbed_certificate_final_parts.py +140 -0
  346. powermean-0.1.0/src/powermean/solve/absorbed_certificate_geometry.py +790 -0
  347. powermean-0.1.0/src/powermean/solve/absorbed_certificate_history.py +660 -0
  348. powermean-0.1.0/src/powermean/solve/absorbed_certificate_inner.py +531 -0
  349. powermean-0.1.0/src/powermean/solve/absorbed_certificate_point.py +753 -0
  350. powermean-0.1.0/src/powermean/solve/absorbed_certificate_scale.py +316 -0
  351. powermean-0.1.0/src/powermean/solve/absorbed_certificate_sparse.py +376 -0
  352. powermean-0.1.0/src/powermean/solve/absorbed_dense_factor.py +377 -0
  353. powermean-0.1.0/src/powermean/solve/absorbed_direction.py +1030 -0
  354. powermean-0.1.0/src/powermean/solve/absorbed_loss.py +931 -0
  355. powermean-0.1.0/src/powermean/solve/absorbed_pair_layout.py +79 -0
  356. powermean-0.1.0/src/powermean/solve/absorbed_rhs.py +1046 -0
  357. powermean-0.1.0/src/powermean/solve/absorbed_root.py +957 -0
  358. powermean-0.1.0/src/powermean/solve/absorbed_root_records.py +440 -0
  359. powermean-0.1.0/src/powermean/solve/absorbed_scale_admission.py +492 -0
  360. powermean-0.1.0/src/powermean/solve/absorbed_scale_details.py +124 -0
  361. powermean-0.1.0/src/powermean/solve/absorbed_scale_records.py +188 -0
  362. powermean-0.1.0/src/powermean/solve/absorbed_scale_request.py +285 -0
  363. powermean-0.1.0/src/powermean/solve/absorbed_start.py +481 -0
  364. powermean-0.1.0/src/powermean/solve/assessment.py +188 -0
  365. powermean-0.1.0/src/powermean/solve/cancelled_attempt.py +72 -0
  366. powermean-0.1.0/src/powermean/solve/cancelled_certificate.py +600 -0
  367. powermean-0.1.0/src/powermean/solve/cancelled_existence.py +526 -0
  368. powermean-0.1.0/src/powermean/solve/cancelled_existence_exact.py +221 -0
  369. powermean-0.1.0/src/powermean/solve/cancelled_loss.py +219 -0
  370. powermean-0.1.0/src/powermean/solve/cancelled_operator.py +397 -0
  371. powermean-0.1.0/src/powermean/solve/cancelled_records.py +433 -0
  372. powermean-0.1.0/src/powermean/solve/cancelled_root.py +328 -0
  373. powermean-0.1.0/src/powermean/solve/cancelled_root_attempt.py +116 -0
  374. powermean-0.1.0/src/powermean/solve/cancelled_tau1.py +464 -0
  375. powermean-0.1.0/src/powermean/solve/cancelled_tau1_bridge.py +265 -0
  376. powermean-0.1.0/src/powermean/solve/certificate.py +669 -0
  377. powermean-0.1.0/src/powermean/solve/compact_assembly.py +610 -0
  378. powermean-0.1.0/src/powermean/solve/compact_matrix.py +234 -0
  379. powermean-0.1.0/src/powermean/solve/compact_scaling.py +300 -0
  380. powermean-0.1.0/src/powermean/solve/factorization.py +287 -0
  381. powermean-0.1.0/src/powermean/solve/iols/__init__.py +101 -0
  382. powermean-0.1.0/src/powermean/solve/iols/_numeric.py +29 -0
  383. powermean-0.1.0/src/powermean/solve/iols/adapter.py +415 -0
  384. powermean-0.1.0/src/powermean/solve/iols/candidate.py +294 -0
  385. powermean-0.1.0/src/powermean/solve/iols/direct_route.py +439 -0
  386. powermean-0.1.0/src/powermean/solve/iols/kernel.py +417 -0
  387. powermean-0.1.0/src/powermean/solve/iols/kernel_attempt.py +391 -0
  388. powermean-0.1.0/src/powermean/solve/iols/kernel_grid.py +482 -0
  389. powermean-0.1.0/src/powermean/solve/iols/kernel_loop.py +363 -0
  390. powermean-0.1.0/src/powermean/solve/iols/kernel_phase.py +411 -0
  391. powermean-0.1.0/src/powermean/solve/iols/kernel_records.py +362 -0
  392. powermean-0.1.0/src/powermean/solve/iols/kernel_state.py +339 -0
  393. powermean-0.1.0/src/powermean/solve/iols/kernel_step.py +327 -0
  394. powermean-0.1.0/src/powermean/solve/iols/normalization.py +189 -0
  395. powermean-0.1.0/src/powermean/solve/iols/options.py +325 -0
  396. powermean-0.1.0/src/powermean/solve/iols/records.py +33 -0
  397. powermean-0.1.0/src/powermean/solve/iols/reference.py +61 -0
  398. powermean-0.1.0/src/powermean/solve/iols/source.py +74 -0
  399. powermean-0.1.0/src/powermean/solve/joint_root.py +656 -0
  400. powermean-0.1.0/src/powermean/solve/joint_root_records.py +260 -0
  401. powermean-0.1.0/src/powermean/solve/line_search.py +198 -0
  402. powermean-0.1.0/src/powermean/solve/linear.py +414 -0
  403. powermean-0.1.0/src/powermean/solve/linear_absorbed.py +381 -0
  404. powermean-0.1.0/src/powermean/solve/linear_absorbed_numeric.py +364 -0
  405. powermean-0.1.0/src/powermean/solve/linear_absorbed_point.py +358 -0
  406. powermean-0.1.0/src/powermean/solve/linear_absorbed_state.py +370 -0
  407. powermean-0.1.0/src/powermean/solve/linear_certificate.py +367 -0
  408. powermean-0.1.0/src/powermean/solve/linear_evaluation.py +224 -0
  409. powermean-0.1.0/src/powermean/solve/linear_status.py +201 -0
  410. powermean-0.1.0/src/powermean/solve/m1_options.py +220 -0
  411. powermean-0.1.0/src/powermean/solve/newton_absorbed.py +785 -0
  412. powermean-0.1.0/src/powermean/solve/newton_convex.py +1015 -0
  413. powermean-0.1.0/src/powermean/solve/newton_profiled.py +798 -0
  414. powermean-0.1.0/src/powermean/solve/newton_retry.py +161 -0
  415. powermean-0.1.0/src/powermean/solve/newton_trace.py +212 -0
  416. powermean-0.1.0/src/powermean/solve/no_point.py +60 -0
  417. powermean-0.1.0/src/powermean/solve/options.py +354 -0
  418. powermean-0.1.0/src/powermean/solve/point_loss.py +377 -0
  419. powermean-0.1.0/src/powermean/solve/profiled_indications.py +174 -0
  420. powermean-0.1.0/src/powermean/solve/profiled_linear_loss.py +445 -0
  421. powermean-0.1.0/src/powermean/solve/profiled_loss.py +751 -0
  422. powermean-0.1.0/src/powermean/solve/profiled_trigger.py +523 -0
  423. powermean-0.1.0/src/powermean/solve/quantities.py +167 -0
  424. powermean-0.1.0/src/powermean/solve/reduced_execution.py +992 -0
  425. powermean-0.1.0/src/powermean/solve/reduced_joint_direction.py +140 -0
  426. powermean-0.1.0/src/powermean/solve/reduced_nonlinear.py +464 -0
  427. powermean-0.1.0/src/powermean/solve/reduced_nonlinear_loss.py +343 -0
  428. powermean-0.1.0/src/powermean/solve/reported.py +369 -0
  429. powermean-0.1.0/src/powermean/solve/root_kernel.py +600 -0
  430. powermean-0.1.0/src/powermean/solve/sparse_matrix.py +32 -0
  431. powermean-0.1.0/src/powermean/solve/starts.py +178 -0
  432. powermean-0.1.0/src/powermean/solve/status.py +172 -0
  433. powermean-0.1.0/src/powermean/solve/support.py +549 -0
  434. powermean-0.1.0/src/powermean/solve/support_gamma.py +632 -0
  435. powermean-0.1.0/src/powermean/solve/support_gamma_lp.py +632 -0
  436. powermean-0.1.0/src/powermean/solve/support_gamma_problem.py +272 -0
  437. powermean-0.1.0/src/powermean/solve/support_gamma_structured.py +696 -0
  438. powermean-0.1.0/src/powermean/solve/support_gamma_witness.py +587 -0
  439. powermean-0.1.0/src/powermean/solve/support_lp.py +452 -0
  440. powermean-0.1.0/src/powermean/solve/support_overlap_lp.py +148 -0
  441. powermean-0.1.0/src/powermean/solve/support_problem.py +222 -0
  442. powermean-0.1.0/src/powermean/solve/support_projection.py +637 -0
  443. powermean-0.1.0/src/powermean/solve/support_rectifier.py +648 -0
  444. powermean-0.1.0/src/powermean/solve/support_witness.py +499 -0
  445. powermean-0.1.0/src/powermean/systems/__init__.py +6 -0
  446. powermean-0.1.0/src/powermean/systems/_cancel_rows.py +180 -0
  447. powermean-0.1.0/src/powermean/systems/admitted.py +133 -0
  448. powermean-0.1.0/src/powermean/systems/cancelled.py +606 -0
  449. powermean-0.1.0/src/powermean/systems/identified.py +251 -0
  450. powermean-0.1.0/src/powermean/systems/joint.py +431 -0
  451. powermean-0.1.0/src/powermean/systems/profiled.py +607 -0
  452. powermean-0.1.0/src/powermean/testing/__init__.py +53 -0
  453. powermean-0.1.0/src/powermean/testing/designs_solver.py +327 -0
  454. powermean-0.1.0/src/powermean/testing/designs_threeway.py +253 -0
  455. powermean-0.1.0/src/powermean/testing/designs_twoway.py +244 -0
  456. powermean-0.1.0/src/powermean/testing/showcase.py +371 -0
  457. powermean-0.1.0/src/powermean/testing/synthetic.py +274 -0
@@ -0,0 +1,9 @@
1
+ __pycache__/
2
+ *.py[cod]
3
+ *.egg-info/
4
+ build/
5
+ dist/
6
+ .pytest_cache/
7
+ .ruff_cache/
8
+ .mypy_cache/
9
+ .venv/
@@ -0,0 +1,12 @@
1
+ cmake_minimum_required(VERSION 3.18)
2
+ project(powermean LANGUAGES CXX)
3
+
4
+ option(POWERMEAN_BUILD_IOLS "Build the optional compiled no-FE IOLS kernel" ON)
5
+ if(POWERMEAN_BUILD_IOLS)
6
+ add_subdirectory(src/powermean/_native/iols)
7
+ endif()
8
+
9
+ option(POWERMEAN_BUILD_BASIS "Build the optional exact FE basis accelerator" OFF)
10
+ if(POWERMEAN_BUILD_BASIS)
11
+ add_subdirectory(src/powermean/_native/basis)
12
+ endif()
@@ -0,0 +1,28 @@
1
+ BSD 3-Clause License
2
+
3
+ Copyright (c) 2026, David Benatia
4
+
5
+ Redistribution and use in source and binary forms, with or without
6
+ modification, are permitted provided that the following conditions are met:
7
+
8
+ 1. Redistributions of source code must retain the above copyright notice, this
9
+ list of conditions and the following disclaimer.
10
+
11
+ 2. Redistributions in binary form must reproduce the above copyright notice,
12
+ this list of conditions and the following disclaimer in the documentation
13
+ and/or other materials provided with the distribution.
14
+
15
+ 3. Neither the name of the copyright holder nor the names of its
16
+ contributors may be used to endorse or promote products derived from
17
+ this software without specific prior written permission.
18
+
19
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22
+ DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
23
+ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24
+ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
25
+ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
26
+ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27
+ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
@@ -0,0 +1,53 @@
1
+ Metadata-Version: 2.4
2
+ Name: powermean
3
+ Version: 0.1.0
4
+ Summary: Power-mean regression: logs, zeros, fixed effects and proportional effects
5
+ Author: David Benatia
6
+ License-Expression: BSD-3-Clause
7
+ License-File: LICENSE
8
+ License-File: licenses/NATIVE_NOTICE.md
9
+ License-File: licenses/PYBIND11_LICENSE
10
+ License-File: licenses/eigen/COPYING.BSD
11
+ License-File: licenses/eigen/COPYING.MPL2
12
+ License-File: licenses/eigen/HEADER_NOTICES.txt
13
+ License-File: licenses/pybind11/EXECUTORCH_LICENSE
14
+ License-File: licenses/pybind11/LLVM_LICENSE
15
+ License-File: src/powermean/_vendor/SKLEARN_COPYING
16
+ Classifier: Development Status :: 4 - Beta
17
+ Classifier: Intended Audience :: Science/Research
18
+ Classifier: Programming Language :: Python :: 3 :: Only
19
+ Classifier: Programming Language :: Python :: 3.12
20
+ Classifier: Programming Language :: Python :: 3.13
21
+ Classifier: Programming Language :: Python :: 3.14
22
+ Classifier: Topic :: Scientific/Engineering
23
+ Classifier: Typing :: Typed
24
+ Project-URL: Homepage, https://github.com/dvbn/powermean
25
+ Project-URL: Documentation, https://github.com/dvbn/powermean/blob/main/docs/README.md
26
+ Project-URL: Issues, https://github.com/dvbn/powermean/issues
27
+ Project-URL: Changelog, https://github.com/dvbn/powermean/blob/main/CHANGELOG.md
28
+ Requires-Python: >=3.12
29
+ Requires-Dist: numpy>=2.3.1
30
+ Requires-Dist: pandas>=2.2.2
31
+ Requires-Dist: scipy>=1.15.0
32
+ Requires-Dist: formulaic>=1.0.0
33
+ Requires-Dist: within-py<0.5,>=0.4
34
+ Description-Content-Type: text/markdown
35
+
36
+
37
+ # Powermean
38
+
39
+ <img src="https://raw.githubusercontent.com/dvbn/powermean/9ca4917ebf7666fed58f842112ab28de8a37fd65/docs/assets/powermean-logo.png" align="right" width="120" alt="Powermean logo" />
40
+
41
+ **Powermean is a Python package for fitting power-mean regressions and estimating proportional effects.** It implements the framework of Benatia et al. (2026), *Dealing with Logs and Zeros in Regression Models*, including exponential conditional-mean models and log-linear regressions. With `pm.fit`, choose the conditional mean and the working variance separately, model outcomes in levels with observed zeros, and report proportional effects with confidence intervals. [Paper](https://arxiv.org/abs/2203.11820v4)
42
+
43
+ Estimate multiple high-dimensional fixed-effect blocks jointly, or cancel a selected block while retaining the others. Powermean provides bias corrections that address the incidental-parameters problem in short panels and three-way gravity models. The same formula interface takes you from a simple conditional-mean regression to three-way gravity and nonlinear difference-in-differences.
44
+
45
+ ```bash
46
+ python -m pip install powermean
47
+ ```
48
+
49
+ Use Python 3.12 or later. The release provides native wheels for CPython 3.12–3.14
50
+ on Linux, macOS, and Windows for x86-64 and ARM64.
51
+
52
+ [User guide](https://github.com/dvbn/powermean/blob/main/docs/README.md) · [Function index](https://github.com/dvbn/powermean/blob/main/docs/reference/api.md)
53
+ · [Gravity walkthrough](https://github.com/dvbn/powermean/blob/main/docs/get-started.md) · [Nonlinear DiD](https://github.com/dvbn/powermean/blob/main/docs/examples/nonlinear-did.md)
@@ -0,0 +1,43 @@
1
+ # Powermean <img src="docs/assets/powermean-logo.png" align="right" width="120" alt="Powermean logo" />
2
+
3
+ **Powermean is a Python package for fitting power-mean regressions and estimating proportional effects.** It implements the framework of Benatia et al. (2026), *Dealing with Logs and Zeros in Regression Models*, including exponential conditional-mean models and log-linear regressions. With `pm.fit`, choose the conditional mean and the working variance separately, model outcomes in levels with observed zeros, and report proportional effects with confidence intervals. [Paper](https://arxiv.org/abs/2203.11820v4)
4
+
5
+ Estimate multiple high-dimensional fixed-effect blocks jointly, or cancel a selected block while retaining the others. Powermean provides bias corrections that address the incidental-parameters problem in short panels and three-way gravity models. The same formula interface takes you from a simple conditional-mean regression to three-way gravity and nonlinear difference-in-differences.
6
+
7
+ [Install Powermean](docs/install.md) · [User guide](docs/README.md) · [Function index](docs/reference/api.md)
8
+
9
+ ```bash
10
+ python -m pip install powermean
11
+ ```
12
+
13
+ **Conditional mean.** Suppose `x` is strictly exogenous and `E[y | x] = exp(a + b*x)`. With a data frame named `data` containing `y` and `x`, fit the arithmetic conditional mean by Poisson pseudo-maximum likelihood (PPML).
14
+
15
+ ```python
16
+ import powermean as pm
17
+
18
+ fit = pm.fit("y ~ x", data, omega=1, tau=1)
19
+ ```
20
+
21
+ Read the coefficient on `x` and its interval in `fit.tidy()`. Keep `omega=1` and set `tau=1.5` or `tau=2` (Gamma PML) to change the working variance for the same mean. A runnable example shows how to report the fitted percentage change. [One conditional mean, three working variances](docs/methods/model.md#fit-one-conditional-mean-three-ways)
22
+
23
+ **Gravity.** How does bilateral trade differ when a pair has an agreement? Fit trade in levels with pair, exporter-year and importer-year effects and report the proportional difference with a pair-clustered interval. [Gravity walkthrough](docs/get-started.md)
24
+
25
+ **Nonlinear difference-in-differences.** How do expected visits change after policy adoption? Use `pm.fit` for common or staggered adoption under multiplicative parallel trends, then read the effects by cohort and date with unit-clustered intervals. [DiD walkthrough](docs/examples/nonlinear-did.md)
26
+
27
+ ## Work with the results
28
+
29
+ Before comparing coefficients, check which rows each model used. Each result records their input positions and the reasons for exclusions. [Compare estimation samples](docs/examples/compare-samples.md)
30
+
31
+ Use `pm.etable` to place several fitted models side by side. The result also supplies tests, proportional effects and alternative covariance estimates. [Reuse and export a fit](docs/examples/reuse-a-fit.md) · [Tables and formats](docs/reference/tables.md)
32
+
33
+ ## Documentation and citation
34
+
35
+ - [User guide](docs/README.md) · [Function index](docs/reference/api.md) · [Troubleshooting](docs/help/troubleshooting.md)
36
+ - [Offline guide](docs/guide.html) · [Quarto source](docs/guide.qmd). Download the HTML and open it in a browser.
37
+ - [Papers and section map](docs/references.md). Cite Benatia et al. (2026) and, for a WZ adjustment, Weidner and Zylkin (2021). Record the exact package build with your analysis.
38
+
39
+ ## License
40
+
41
+ Powermean's own source is licensed under [BSD-3-Clause](LICENSE).
42
+ Bundled components carry the [scikit-learn notice](src/powermean/_vendor/SKLEARN_COPYING)
43
+ and [native extension notices](licenses/NATIVE_NOTICE.md).
@@ -0,0 +1,35 @@
1
+ # Build or read the guide
2
+
3
+ The [HTML guide](guide.html) is the complete reading document. Open it in a
4
+ current browser. Its style, navigation scripts and MathML equations are
5
+ included; reading it does not require a connection. Keep it in the unpacked
6
+ source distribution to follow links to accompanying files. Links to papers
7
+ may need a connection.
8
+
9
+ The matching [Quarto document](guide.qmd) contains the full guide text.
10
+ The individual Markdown chapters remain the editing source. After changing
11
+ a chapter, assemble and render the document from the repository root:
12
+
13
+ ```bash
14
+ node docs/build-guide.mjs
15
+ quarto render docs/guide.qmd --to html
16
+ node docs/build-guide.mjs --check
17
+ ```
18
+
19
+ Quarto is a documentation authoring tool, not a Powermean runtime dependency.
20
+ The earlier checked render used Quarto 1.10.18. Rendering does not
21
+ execute the Python examples. The Markdown chapters hold the captured
22
+ console output and package-generated tables. Images are embedded in the
23
+ reading copy. To refresh an example, run its displayed Python in an
24
+ installed Powermean environment before rendering, and save figure outputs
25
+ under `docs/assets/`.
26
+
27
+ The build script checks that the Markdown outline and offline guide list
28
+ the same chapters in the same five groups. It refreshes chapter navigation
29
+ and resolves links inside the combined document. `guide.css` supplies local presentation
30
+ styles. Commit the chapter changes, regenerated `guide.qmd` and rendered
31
+ `guide.html` together so the source and reading copy remain synchronized.
32
+
33
+ <!-- guide-navigation:start -->
34
+ [Previous: Papers and methods](references.md) · [Guide index](README.md)
35
+ <!-- guide-navigation:end -->
@@ -0,0 +1,77 @@
1
+ # Powermean user guide
2
+
3
+ <a id="powermean-01-user-guide"></a>
4
+
5
+ <img src="assets/powermean-logo.png" align="right" width="130" class="guide-logo" alt="Powermean logo" />
6
+
7
+ Start with the conditional mean of the outcome in levels, including observed zeros. Powermean accompanies *Dealing with Logs and Zeros in Regression Models* by Benatia et al. (2026). [Paper](https://arxiv.org/abs/2203.11820v4) · [Install Powermean](install.md)
8
+
9
+ **Conditional mean.** Suppose `x` is strictly exogenous and `E[y | x] = exp(a + b*x)`. With your own data frame, fit the arithmetic conditional mean by PPML.
10
+
11
+ ```python
12
+ import powermean as pm
13
+
14
+ fit = pm.fit("y ~ x", data, omega=1, tau=1)
15
+ ```
16
+
17
+ Read the slope and its uncertainty with `fit.tidy()`. At `omega=1`, PPML (`tau=1`), Gamma PML (`tau=2`) and intermediate working variances such as `tau=1.5` target the same correctly specified conditional mean. [Run the example with 12 observations](methods/model.md#fit-one-conditional-mean-three-ways)
18
+
19
+ **Gravity.** Fit trade in levels with pair, exporter-year and importer-year fixed effects. Read an agreement's estimated proportional effect and its interval. [Gravity walkthrough](get-started.md)
20
+
21
+ **Nonlinear difference-in-differences.** Start with a policy adopted at a common date, then allow effects to vary by adoption cohort and date under multiplicative parallel trends. [DiD walkthrough](examples/nonlinear-did.md) · [Cohort effects figure](examples/nonlinear-did.md#plot-the-cohort-by-period-effects)
22
+
23
+ | What do you need next? | Where to go |
24
+ | --- | --- |
25
+ | Set up an analysis | [Prepare the data and formula](help/prepare-data.md), then [choose the mean and working variance](methods/model.md). |
26
+ | Choose a panel specification | [Estimate fixed effects](methods/fixed-effects.md) or [cancel one block](methods/cancellation.md), then [choose uncertainty for your sampling design](methods/inference.md). |
27
+ | Compare and report fits | [Check the rows](examples/compare-samples.md), [interpret a proportional effect](methods/proportional-effects.md), or [build and export tables](reference/tables.md). |
28
+ | Look up a call or resolve a warning | [Function index](reference/api.md) · [Fit options](reference/options.md) · [Troubleshooting](help/troubleshooting.md) |
29
+
30
+ Download the [standalone HTML guide](guide.html) for offline reading. The [Quarto source](guide.qmd) is also available.
31
+
32
+ ## Get started
33
+
34
+ - [Install the current version](install.md) from a local wheel or source archive.
35
+ - [Fit your first gravity model](get-started.md) and read its console output.
36
+ - [Prepare data](help/prepare-data.md) and write the formula.
37
+ - [Run the examples](examples/README.md) from your terminal.
38
+
39
+ ## Fit a model
40
+
41
+ - [Choose a mean and working variance](methods/model.md), including PPML, Gamma PML, log OLS and NB2.
42
+ - [Estimate fixed effects](methods/fixed-effects.md) and check what identifies the slope.
43
+ - [Cancel one fixed-effect block](methods/cancellation.md) and compare the resulting estimating equations.
44
+ - [Choose a solver](methods/numerical-methods.md) and interpret its certificate.
45
+
46
+ ## Read and report results
47
+
48
+ - [Check and compare estimation samples](examples/compare-samples.md), then describe their outcomes.
49
+ - [Explore and export a fit](examples/reuse-a-fit.md), including predictions, coefficient tests, contrasts and tables.
50
+ - [Interpret proportional changes](methods/proportional-effects.md) on the fitted and population scales.
51
+
52
+ ## Panel designs and inference
53
+
54
+ - [Estimate nonlinear difference-in-differences](examples/nonlinear-did.md) with common or staggered adoption.
55
+ - [Choose a covariance estimator](methods/inference.md) for the sampling design.
56
+ - [Correct coefficient bias](methods/bias-correction.md) with the procedures of Benatia et al. (2026) or Weidner and Zylkin (2021).
57
+ - [Adjust pair covariance in gravity](methods/covariance-refinements.md) and plot the resulting intervals.
58
+ - [Compare with Stata ppmlhdfe](from-ppmlhdfe.md) on the same rows and specification.
59
+
60
+ ## Reference and help
61
+
62
+ | Page | What to look up |
63
+ | --- | --- |
64
+ | [Function index](reference/api.md) | Find an installed function, result method or output. |
65
+ | [Supported methods](availability.md) | Supported model and covariance choices. |
66
+ | [Fit options](reference/options.md) | Formula, sample, model, covariance and start arguments. |
67
+ | [Results](reference/results.md) | Estimates, tests, covariance, sample records, diagnostics and fixed effects. |
68
+ | [Tables and formats](reference/tables.md) | Summary statistics, balance, outcomes, regression tables and exports. |
69
+ | [Solver options](reference/solver-options.md) | Newton, IOLS and numerical controls. |
70
+ | [Advanced fixed effects](reference/experimental-fixed-effects.md) | Joint and cancelled controls, correction and inference requirements. |
71
+ | [IOLS options](reference/iols_options.md) | Typed implementation and iteration settings. |
72
+ | [IOLS installation](iols_installation.md) | Compiled and NumPy-only builds. |
73
+ | [Troubleshooting](help/troubleshooting.md) | Diagnose a warning, refusal or failed fit. |
74
+ | [Report a problem](help/report-a-problem.md) | Gather the sample, diagnostic and version information. |
75
+ | [Validation](validation.md) | Interpret numerical and statistical checks. |
76
+ | [Papers and methods](references.md) | Read and cite the underlying work. |
77
+ | [Build the guide](BUILD_GUIDE.md) | Regenerate the standalone HTML from these chapters. |
@@ -0,0 +1,36 @@
1
+ # Supported methods
2
+
3
+ <a id="what-powermean-01-supports"></a>
4
+
5
+ Statistical interpretation
6
+ depends on the mean, sampling assumptions and the applicable fixed-effect
7
+ regime. [Methods and papers](references.md)
8
+
9
+ | Task | Domain |
10
+ | --- | --- |
11
+ | Fit without fixed effects | `pm.fit` with finite mean orders, power working variance or supported NB2, plus log OLS at order zero. Positive orders allow zeros. Nonpositive orders require positive outcomes. |
12
+ | Estimate fixed effects jointly | One or more blocks after `\|` in the formula. Joint prediction is in sample. Supplied observation weights are unavailable. |
13
+ | Cancel one block | Select a named block at nonzero mean order, with every other block retained. The working variance and equation have method-specific requirements. `fixef()` can recover the cancelled scales in sample. |
14
+ | Choose a numerical procedure | Newton is the default for nonlinear fits. IOLS handles supported no-FE models with positive order and power `tau` in `[1, 2]`. Order zero uses a linear calculation. |
15
+ | Reuse prepared rows | `pm.prepare` captures the design and available cluster information. Supported fits can change mean, working variance or covariance within the prepared domain. |
16
+ | Estimate uncertainty | Robust, named HC and one- or multiway cluster methods within their fit-time and postfit domains. With cancellation, use observed bread. The fit-specific default covariance and the named HC rules are in [options](reference/options.md#fit-time-covariance-for-fixed-effects). |
17
+ | Correct coefficient bias | The `"short_group"` and `"cell"` corrections of Benatia et al. (2026) for supported cancelled fits. WZ `"wz"` for unweighted three-way PPML within its panel requirements. |
18
+ | Adjust pair covariance in gravity | `vcov={"cluster": "pair", "adjustment": "wz"}` for the covered three-way PPML design. |
19
+ | Report or export | Coefficients, intervals, conditional proportional changes, contrasts, tests, prediction where supported, and regression, outcome and balance tables. |
20
+
21
+ For joint fits with nonzero mean order, power `tau` outside `[1, 2]`
22
+ requests a selected root. Those values have narrower existence results.
23
+ [Working-variance range](reference/options.md#full-family-scope-and-the-current-entry-restriction)
24
+
25
+ The [advanced FE options](reference/experimental-fixed-effects.md)
26
+ describe experimental module-level records and correction requirements.
27
+ Powermean does not compute HAC or Conley covariance, the deletion or higher-order covariance estimators of Benatia et al. (2026), automatic working-variance targeting,
28
+ instrumental-variable estimates or multiple-block cancellation. The
29
+ [options](reference/options.md) and [results](reference/results.md)
30
+ references give accepted spellings and result-specific limits. Find a
31
+ function or output in the [function index](reference/api.md) and look up all
32
+ display and export options in [tables and formats](reference/tables.md).
33
+
34
+ <!-- guide-navigation:start -->
35
+ [Previous: Function index](reference/api.md) · [Guide index](README.md) · [Next: Options](reference/options.md)
36
+ <!-- guide-navigation:end -->
@@ -0,0 +1,178 @@
1
+ // Assemble the Markdown chapters; no package imports, example execution or network.
2
+ import fs from 'node:fs';
3
+ import path from 'node:path';
4
+ import {fileURLToPath} from 'node:url';
5
+ const root = path.dirname(fileURLToPath(import.meta.url));
6
+ const indexChapter = ['README.md', 'read-the-guide', 'Guide index'];
7
+ const groups = [
8
+ ['Get started', 'start', [
9
+ ['install.md', 'install', 'Install'],
10
+ ['get-started.md', 'first-fit', 'Gravity walkthrough'],
11
+ ['help/prepare-data.md', 'prepare-data', 'Prepare data'],
12
+ ['examples/README.md', 'examples', 'Run the examples'],
13
+ ]],
14
+ ['Fit a model', 'fit-a-model', [
15
+ ['methods/model.md', 'model', 'Mean and variance'],
16
+ ['methods/fixed-effects.md', 'fixed-effects', 'Fixed effects'],
17
+ ['methods/cancellation.md', 'cancellation', 'Cancel one block'],
18
+ ['methods/numerical-methods.md', 'numerical-methods', 'Numerical methods'],
19
+ ]],
20
+ ['Read and report results', 'read-and-report', [
21
+ ['examples/compare-samples.md', 'compare-samples', 'Compare samples'],
22
+ ['examples/reuse-a-fit.md', 'reuse-a-fit', 'Explore and export results'],
23
+ ['methods/proportional-effects.md', 'proportional-changes', 'Proportional changes'],
24
+ ]],
25
+ ['Panel designs and inference', 'panel-and-inference', [
26
+ ['examples/nonlinear-did.md', 'nonlinear-did', 'Nonlinear panel DiD'],
27
+ ['methods/inference.md', 'uncertainty', 'Inference'],
28
+ ['methods/bias-correction.md', 'bias-correction', 'Coefficient bias'],
29
+ ['methods/covariance-refinements.md', 'covariance-refinements', 'WZ pair covariance'],
30
+ ['from-ppmlhdfe.md', 'compare-ppmlhdfe', 'Compare with ppmlhdfe'],
31
+ ]],
32
+ ['Reference and help', 'reference-and-help', [
33
+ ['reference/api.md', 'api', 'Function index'],
34
+ ['availability.md', 'availability', 'Supported methods'],
35
+ ['reference/options.md', 'options', 'Options'],
36
+ ['reference/results.md', 'results', 'Results'],
37
+ ['reference/tables.md', 'tables', 'Tables'],
38
+ ['reference/solver-options.md', 'solver-options', 'Solver options'],
39
+ ['reference/experimental-fixed-effects.md', 'experimental-fe', 'Advanced FE options'],
40
+ ['reference/iols_options.md', 'iols-options', 'IOLS options'],
41
+ ['iols_installation.md', 'iols-installation', 'IOLS installation'],
42
+ ['help/troubleshooting.md', 'troubleshooting', 'Troubleshooting'],
43
+ ['help/report-a-problem.md', 'report-a-problem', 'Report a problem'],
44
+ ['validation.md', 'validation', 'Validation'],
45
+ ['references.md', 'references', 'Papers and methods'],
46
+ ['BUILD_GUIDE.md', 'build-the-guide', 'Build the guide'],
47
+ ]],
48
+ ];
49
+ const chapters = [indexChapter, ...groups.flatMap(([, , entries]) => entries)];
50
+ const check = process.argv.includes('--check');
51
+ const navStart = '<!-- guide-navigation:start -->';
52
+ const navEnd = '<!-- guide-navigation:end -->';
53
+ const tick = String.fromCharCode(96);
54
+ const fence = tick.repeat(3);
55
+ const slug = text => text.replaceAll(tick, '').toLowerCase()
56
+ .replace(/[^\p{L}\p{N}_\-\s]/gu, '').replace(/ /g, '-');
57
+ const texts = new Map();
58
+ const targets = new Map();
59
+ for (const [index, [file, prefix]] of chapters.entries()) {
60
+ const source = path.join(root, file);
61
+ const original = fs.readFileSync(source, 'utf8');
62
+ const body = original.split(navStart)[0].trim();
63
+ const neighbors = [];
64
+ const add = ([target, , title], label) => {
65
+ const relative = path.posix.relative(path.posix.dirname(file), target);
66
+ neighbors.push('[' + label + title + '](' + relative + ')');
67
+ };
68
+ if (index > 1) add(chapters[index - 1], 'Previous: ');
69
+ if (index > 0) add(chapters[0], '');
70
+ if (index < chapters.length - 1) add(chapters[index + 1], 'Next: ');
71
+ const updated = index === 0 ? body + '\n' : [
72
+ body, '', navStart, neighbors.join(' · '), navEnd, '',
73
+ ].join('\n');
74
+ if (check && updated !== original) throw Error('Stale chapter navigation: ' + file);
75
+ if (!check && updated !== original) fs.writeFileSync(source, updated);
76
+ const seen = new Map();
77
+ let fenced = false;
78
+ const headings = [];
79
+ for (const line of body.split('\n')) {
80
+ if (line.startsWith(fence)) { fenced = !fenced; continue; }
81
+ if (!fenced && /^#{1,6} /.test(line)) {
82
+ const key = slug(line.replace(/^#+ /, ''));
83
+ const count = seen.get(key) || 0;
84
+ seen.set(key, count + 1);
85
+ headings.push([key + (count ? '-' + count : ''), headings.length ? prefix + '--' + key + (count ? '-' + count : '') : prefix]);
86
+ }
87
+ }
88
+ targets.set(file, new Map(headings));
89
+ texts.set(file, {body, headings});
90
+ }
91
+ function link(file, url) {
92
+ if (/^(?:https?:|mailto:|data:)/.test(url)) return url;
93
+ const [name, fragment] = url.split('#');
94
+ const target = path.posix.normalize(path.posix.join(path.posix.dirname(file), name || path.posix.basename(file)));
95
+ if (targets.has(target)) {
96
+ if (!fragment) return '#' + targets.get(target).values().next().value;
97
+ const id = targets.get(target).get(decodeURIComponent(fragment));
98
+ if (!id) throw Error('Unknown anchor: ' + file + ' -> ' + url);
99
+ return '#' + id;
100
+ }
101
+ if (target === 'guide.html') return '#read-the-guide';
102
+ const repoPath = path.posix.normalize(path.posix.join('docs', target));
103
+ if (repoPath === '..' || repoPath.startsWith('../')) throw Error('Link escapes repository: ' + url);
104
+ return target + (fragment ? '#' + fragment : '');
105
+ }
106
+ const header = [
107
+ '---',
108
+ 'title: "Powermean"',
109
+ 'subtitle: "User guide for proportional regression and fixed effects"',
110
+ 'lang: en',
111
+ 'format:',
112
+ ' html:',
113
+ ' theme: default',
114
+ ' mainfont: system-ui',
115
+ ' toc: true',
116
+ ' toc-title: "In this guide"',
117
+ ' toc-depth: 2',
118
+ ' toc-location: left',
119
+ ' toc-expand: 1',
120
+ ' number-sections: false',
121
+ ' html-math-method: mathml',
122
+ ' embed-resources: true',
123
+ ' code-copy: true',
124
+ ' code-overflow: wrap',
125
+ ' anchor-sections: true',
126
+ ' smooth-scroll: false',
127
+ ' css: guide.css',
128
+ 'execute:',
129
+ ' enabled: false',
130
+ '---',
131
+ '',
132
+ '<!-- Generated from the chapter Markdown files by build-guide.mjs.',
133
+ ' Edit those files, regenerate, then render; do not hand-edit the HTML. -->',
134
+ '',
135
+ ].join('\n');
136
+ const assembleChapter = ([file], index = false) => {
137
+ const {body, headings} = texts.get(file);
138
+ let headingIndex = 0;
139
+ let fenced = false;
140
+ return body.split('\n').map(line => {
141
+ if (line.startsWith(fence)) { fenced = !fenced; return line; }
142
+ if (fenced) return line;
143
+ if (/^#{1,6} /.test(line)) {
144
+ const [, id] = headings[headingIndex++];
145
+ if (index) return line + ' {#' + id + ' .unlisted}';
146
+ return '#' + line + ' {#' + id + '}';
147
+ }
148
+ return line.replace(/\]\(([^)\s]+)\)/g, (_, url) => '](' + link(file, url) + ')');
149
+ }).join('\n');
150
+ };
151
+ const index = texts.get(indexChapter[0]).body;
152
+ const indexedGroups = [...index.matchAll(/^## (.+)\n([\s\S]*?)(?=^## |$(?![\s\S]))/gm)];
153
+ if (indexedGroups.length !== groups.length) throw Error('Guide outline group count differs from the offline navigation.');
154
+ for (const [i, [title, , entries]] of groups.entries()) {
155
+ const [, label, body] = indexedGroups[i];
156
+ const linked = [...body.matchAll(/\]\(([^)#\s]+\.md)\)/g)].map(match => match[1]);
157
+ if (label !== title || linked.join() !== entries.map(([file]) => file).join()) {
158
+ throw Error('Guide outline links differ from the offline navigation in ' + title);
159
+ }
160
+ }
161
+ const assembled = [
162
+ assembleChapter(indexChapter, true),
163
+ ...groups.map(([heading, id, entries]) => [
164
+ '# ' + heading + ' {#' + id + '}',
165
+ ...entries.map(entry => assembleChapter(entry)),
166
+ ].join('\n\n')),
167
+ ].join('\n\n');
168
+ const output = header + '\n' + assembled + '\n';
169
+ const destination = path.join(root, 'guide.qmd');
170
+ if (check) {
171
+ if (!fs.existsSync(destination) || fs.readFileSync(destination, 'utf8') !== output)
172
+ throw Error('guide.qmd differs from its chapter sources; regenerate it.');
173
+ console.log('PASS: guide.qmd matches all ' + chapters.length + ' chapter sources.');
174
+ } else {
175
+ fs.writeFileSync(destination, output);
176
+ console.log('Assembled ' + chapters.length + ' chapters in docs/guide.qmd. Render it with Quarto.');
177
+ }
178
+
@@ -0,0 +1,25 @@
1
+ # Run the examples
2
+
3
+ Start with the [12-observation conditional-mean example](../methods/model.md#fit-one-conditional-mean-three-ways) to compare PPML, Gamma PML and an intermediate working variance.
4
+
5
+ Run the scripts from the source checkout or unpacked source distribution
6
+ after installing Powermean. The datasets are generated locally
7
+ from fixed seeds. The gravity and DiD chapters show the returned tables and
8
+ include optional figure code using Matplotlib. To run the figure snippets,
9
+ install Matplotlib in the same Python environment.
10
+
11
+ | Example | Script | What to read |
12
+ | --- | --- | --- |
13
+ | Gravity with zeros | [`examples/first_fit.py`](../../examples/first_fit.py) | [Three-way PPML](../get-started.md) and [WZ adjustments](../methods/bias-correction.md) |
14
+ | Firm sales over four years | [`examples/short_panel.py`](../../examples/short_panel.py) | [Joint and firm-cancelled Gamma equations](../methods/cancellation.md) |
15
+ | Nonlinear panel DiD | [`examples/nonlinear_did.py`](../../examples/nonlinear_did.py) | [Common and cohort-period effects](nonlinear-did.md) |
16
+ | No-FE PPML with IOLS | [`docs/examples/iols_first_fit.py`](iols_first_fit.py) | [Check the IOLS installation](../iols_installation.md) |
17
+
18
+ The [sample comparison](compare-samples.md) uses two fits of the same frame
19
+ to show retained rows, exclusions, sample summaries and estimates. The
20
+ [prepared-fit example](reuse-a-fit.md) reuses a design across solvers,
21
+ changes the covariance after estimation and reports a proportional contrast.
22
+
23
+ <!-- guide-navigation:start -->
24
+ [Previous: Prepare data](../help/prepare-data.md) · [Guide index](../README.md) · [Next: Mean and variance](../methods/model.md)
25
+ <!-- guide-navigation:end -->