Skip to content

Add formal Phase 0 plan document#6

Merged
TUstudents merged 3 commits intomainfrom
claude/review-scatter-brain-docs-SwvfP
Feb 21, 2026
Merged

Add formal Phase 0 plan document#6
TUstudents merged 3 commits intomainfrom
claude/review-scatter-brain-docs-SwvfP

Conversation

@TUstudents
Copy link
Copy Markdown
Owner

Captures all Phase 0 (Foundation & Planning) deliverables, tasks, and
their completion status in a single actionable checklist. Includes the
domain survey, scope definition, architecture overview, data structure
spec, technology stack decisions, testing/documentation strategies, risk
register, and transition criteria to Phase 1.

https://claude.ai/code/session_01SSdbmodGkPH5K3gbYQn86e

Captures all Phase 0 (Foundation & Planning) deliverables, tasks, and
their completion status in a single actionable checklist. Includes the
domain survey, scope definition, architecture overview, data structure
spec, technology stack decisions, testing/documentation strategies, risk
register, and transition criteria to Phase 1.

https://claude.ai/code/session_01SSdbmodGkPH5K3gbYQn86e
Documents the full current state of Phase 1 implementation (137 tests
passing) and identifies the 10 remaining tasks: packaging sub-package
discovery fix, save_ascii_1d, subtract_background, three unimplemented
visualization functions (plot_guinier/porod/fit), artifact cleanup,
tutorial notebook, GitHub Actions CI, and associated tests.

Includes priority order, per-task specs, and completion criteria.

https://claude.ai/code/session_01SSdbmodGkPH5K3gbYQn86e
…zation, CI

- pyproject.toml: switch to find-packages discovery so all sub-packages
  (processing, analysis, modeling, …) are included in the installed wheel
- scatterbrain/processing/background.py: new subtract_background() supporting
  constant offsets and curve backgrounds with optional interpolation and
  scale_factor; error propagation in quadrature
- scatterbrain/processing/__init__.py: expose subtract_background
- scatterbrain/io.py: implement save_ascii_1d() with auto-generated comment
  header, optional error column, configurable delimiter/format, and full
  round-trip compatibility with load_ascii_1d()
- scatterbrain/visualization.py: replace three NotImplementedError stubs with
  working implementations of plot_guinier, plot_porod, and plot_fit; each
  accepts an optional analysis/fit result dict for overlay and annotation
- scatterbrain/visualization_renamed/: remove stale artifact (git rm)
- notebooks/01_basic_workflow.ipynb: end-to-end tutorial covering load →
  background subtraction → Guinier → Porod → sphere fit → save
- .github/workflows/ci.yml: GitHub Actions CI matrix (py3.10/3.11/3.12)
  with black, flake8, mypy, pytest+coverage, and Sphinx docs build steps
- tests/test_processing.py: 20 unit tests for subtract_background
- tests/test_io.py: 7 new tests for save_ascii_1d including round-trip check
- tests/test_visualization.py: replace skipped placeholder tests with 25
  working tests for plot_guinier, plot_porod, and plot_fit

All 183 tests pass.

https://claude.ai/code/session_01SSdbmodGkPH5K3gbYQn86e
@TUstudents TUstudents merged commit 5faa0ab into main Feb 21, 2026
0 of 4 checks passed
@TUstudents TUstudents deleted the claude/review-scatter-brain-docs-SwvfP branch February 21, 2026 14:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants