Repository navigation
Add documentation for PDM #15
Description
@astrobatty has done some great work (awhile ago now) showing PDM some love and care after I abandoned it pretty early on. We should revisit this some more and add appropriate documentation to bring it onto level footing with the rest of the algorithms we have here.
Activity
johnh2o2 commentedon Jun 11, 2026
PDM documentation now exists on the v1.0 line (branch
v1.0, tip 39d3367):docs/source/pdm.rst, wired into the Sphinx toctree.It covers the PDM statistic and its sign convention (cuvarbase returns 1 − Θ, so peaks = candidates), all four variants (
binned_step,binned_linterp,binless_tophat,binless_gauss) and their_fastkernels, the new(t, y, err)API from #62 with a worked example, thenbins/dphiknobs, and the deprecated legacy format.Will close this once v1.0 is released and the rendered docs site is rebuilt from it.
johnh2o2 commentedon Sep 28, 2026
Release triage for PR #69 (cuvarbase 1.0.1, source
6b6c48945160).This issue remains open and is listed as related follow-up in PR #69; it is intentionally excluded from automatic closure.
The source guide covers all variants, the statistic, examples, batching and large_run, and it is included in the Sphinx build. The owner’s June 11 comment explicitly retained this issue until release publication and a rebuilt rendered docs site. PR merge alone performs neither action. Remaining: publish the authorized release and deploy the rebuilt docs in a separately authorized publication step.
Evidence: PDM guide · publication remains deferred