Skip to content

docs: add comprehensive project documentation#96

Merged
FIrgolitsch merged 0 commit intopr-a-build-toolingfrom
pr-j-documentation
Apr 23, 2026
Merged

docs: add comprehensive project documentation#96
FIrgolitsch merged 0 commit intopr-a-build-toolingfrom
pr-j-documentation

Conversation

@FIrgolitsch
Copy link
Copy Markdown
Contributor

@FIrgolitsch FIrgolitsch commented Apr 1, 2026

PR #96 — Documentation

Adds and then refreshes the project's long-form documentation so it matches the implementation shipped by PRs #87 and #97#104.

Files (12)

  • docs/PIPELINE_OVERVIEW.md — end-to-end pipeline description
  • docs/PIPELINE_PERFORMANCE_ANALYSIS.md — benchmarks and tuning notes
  • docs/LIBRARY_MODULES.md — library module reference
  • docs/SCRIPTS_REFERENCE.md — CLI scripts reference (every linum_* entry point)
  • docs/GPU_ACCELERATION.md — GPU acceleration guide (CuPy / JAX, --use_gpu flag, device detection)
  • docs/NEXTFLOW_WORKFLOWS.md — preproc and 3D-reconstruction workflow docs
  • docs/MOSAIC_GRID_FORMAT.md — mosaic-grid OME-Zarr layout
  • docs/SHIFTS_FILE_FORMAT.md — shifts CSV/JSON schema
  • docs/SLICE_CONFIG_FEATURE.mdslice_config.csv schema and lifecycle
  • docs/SLICE_INTERPOLATION_FEATURE.md — physical model, zmorph parameters, failure handling
  • docs/RECONSTRUCTION_DIAGNOSTICS.md — diagnostics scripts and outputs
  • docs/AI_DOCUMENTATION_INDEX.md — index of all docs

Commits

  1. docs: add comprehensive project documentation — initial draft
  2. docs: update pipeline, GPU, workflow, and script references — synchronises content with the final state of PRs feat: slice interpolation for missing sections (z-morph) #87/feat: utility modules, preprocessing improvements, galvo correction #97feat: add manual-alignment export, refinement, and global-transform tools #104 (notably SLICE_INTERPOLATION_FEATURE.md, SCRIPTS_REFERENCE.md, NEXTFLOW_WORKFLOWS.md, SLICE_CONFIG_FEATURE.md)

Dependencies

@FIrgolitsch FIrgolitsch force-pushed the pr-j-documentation branch 2 times, most recently from 5ad244c to 2490949 Compare April 17, 2026 22:15
@FIrgolitsch FIrgolitsch changed the base branch from main to pr-a-build-tooling April 17, 2026 22:22
@FIrgolitsch FIrgolitsch merged commit a48129d into pr-a-build-tooling Apr 23, 2026
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.

1 participant