Skip to content

Add README for scratch-core#206

Merged
laurensWe merged 7 commits intomainfrom
feature/create_readme_scratch_core
Mar 30, 2026
Merged

Add README for scratch-core#206
laurensWe merged 7 commits intomainfrom
feature/create_readme_scratch_core

Conversation

@laurensWe
Copy link
Copy Markdown
Member

Adds packages/scratch-core/README.md as an entry point for developers working with or integrating against the core library.

Features:

  • Repository context — diagram showing where scratch-core fits in the full request flow (scan upload → preprocessing → scoring → LR), and how it relates to the FastAPI service in src/.
  • Package structure — annotated directory tree of all modules.
  • Data model — overview of ScanImage, Mark, and the full MarkType enum (striation and impression variants).
  • Main pipelines — step-by-step description of both preprocessing pipelines and their comparison counterparts (correlate_profiles / compare_surfaces), including the output fields returned by each.

Comment thread packages/scratch-core/README.md
Comment thread packages/scratch-core/README.md Outdated
Copy link
Copy Markdown
Collaborator

@vergep vergep left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nicely done!

Comment thread packages/scratch-core/README.md Outdated
Comment thread packages/scratch-core/README.md Outdated
@github-actions
Copy link
Copy Markdown

Diff Coverage

Diff: origin/main..HEAD, staged and unstaged changes

No lines with coverage information in this diff.

@github-actions
Copy link
Copy Markdown

Code Coverage

Package Line Rate Branch Rate Health
. 96% 92%
computations 85% 50%
container_models 99% 100%
conversion 96% 89%
conversion.export 100% 100%
conversion.filter 97% 89%
conversion.leveling 100% 100%
conversion.leveling.solver 100% 75%
conversion.plots 99% 88%
conversion.preprocess_impression 99% 91%
conversion.preprocess_striation 90% 62%
conversion.profile_correlator 96% 82%
conversion.surface_comparison 99% 89%
conversion.surface_comparison.cell_registration 100% 90%
extractors 97% 75%
mutations 100% 100%
parsers 97% 50%
parsers.patches 89% 60%
preprocessors 99% 91%
processors 100% 83%
renders 99% 50%
utils 71% 100%
Summary 98% (3265 / 3338) 86% (335 / 388)

Minimum allowed line rate is 50%

@laurensWe laurensWe merged commit 59db5fb into main Mar 30, 2026
4 checks passed
@laurensWe laurensWe deleted the feature/create_readme_scratch_core branch March 30, 2026 10:53
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.

3 participants