Skip to content

v0.1.6 — Doc completeness pass

Choose a tag to compare

View all tags
@emcramer emcramer released this 16 May 01:15
· 35 commits to main since this release
v0.1.6
aeb5070

Highlights

Closes the doc gaps flagged in the v0.1.5 reviewer report. No code changes.

Added

  • docs/api/convergence.md — per-symbol reference for adf_test, mann_kendall_test, rolling_cv, find_convergence_time, and MultiMetricConvergence. Worked example verified end-to-end (synthetic transient + AR(1) trajectory, converges at t=99 / 280).
  • docs/api/power-analysis.md — per-symbol reference for cohens_d, coefficient_of_variation, required_replicates, power_curve, compare_initialization_variance, and summarize_power_analysis. Worked example produces a three-method variance / effect-size report.
  • docs/api/physicell.md — dedicated PhysiCell bridge page covering PhysiCellExporter, export_to_physicell, PhysiCellReader, read_physicell_output, and stats_to_target_statistics, plus the round-trip from tissue → CSV → reader → ReplicateGenerator. Includes pyMCDS BSD-3-Clause attribution.

Changed

  • docs/api/core.md trimmed and retitled from a top-level user guide (491 lines) to a focused per-module reference for TissueSection, Cell, and SpherePacker (296 lines). Installation / quickstart prose now lives in docs/quickstart.md only.
  • Decorative checkmark / cross emoji removed from docs/api/slicing.md, docs/api/spatial-analysis.md, docs/api/replicate-generation.md, and docs/guides/mcp.md. Plain-Markdown style now matches CLAUDE.md.

Fixed

  • Non-runnable return-type pseudo-code in docs/api/power-analysis.md is now fenced as text, not python, so automated snippet extraction picks up only the runnable example.

Removed

  • PAPER_PLAN_REPORT.md is no longer tracked on main. The v0.1.5 attempt didn't persist in the commit; this release actually drops it. Local working-copy preserved.

Historical note: the file is still present in tag history v0.1.1 through v0.1.5. A git filter-repo rewrite would be needed to purge it from history.

Validation

  • 120 / 120 tests pass.
Assets 2
Loading