docs: add comprehensive project documentation#96
Merged
FIrgolitsch merged 0 commit intopr-a-build-toolingfrom Apr 23, 2026
Merged
docs: add comprehensive project documentation#96FIrgolitsch merged 0 commit intopr-a-build-toolingfrom
FIrgolitsch merged 0 commit intopr-a-build-toolingfrom
Conversation
5ad244c to
2490949
Compare
2490949 to
a48129d
Compare
e4c127f to
a48129d
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 descriptiondocs/PIPELINE_PERFORMANCE_ANALYSIS.md— benchmarks and tuning notesdocs/LIBRARY_MODULES.md— library module referencedocs/SCRIPTS_REFERENCE.md— CLI scripts reference (everylinum_*entry point)docs/GPU_ACCELERATION.md— GPU acceleration guide (CuPy / JAX,--use_gpuflag, device detection)docs/NEXTFLOW_WORKFLOWS.md— preproc and 3D-reconstruction workflow docsdocs/MOSAIC_GRID_FORMAT.md— mosaic-grid OME-Zarr layoutdocs/SHIFTS_FILE_FORMAT.md— shifts CSV/JSON schemadocs/SLICE_CONFIG_FEATURE.md—slice_config.csvschema and lifecycledocs/SLICE_INTERPOLATION_FEATURE.md— physical model,zmorphparameters, failure handlingdocs/RECONSTRUCTION_DIAGNOSTICS.md— diagnostics scripts and outputsdocs/AI_DOCUMENTATION_INDEX.md— index of all docsCommits
docs: add comprehensive project documentation— initial draftdocs: 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 #97–feat: add manual-alignment export, refinement, and global-transform tools #104 (notablySLICE_INTERPOLATION_FEATURE.md,SCRIPTS_REFERENCE.md,NEXTFLOW_WORKFLOWS.md,SLICE_CONFIG_FEATURE.md)Dependencies