Skip to content

Conversation

@dkuegler
Copy link
Member

@dkuegler dkuegler commented Jan 19, 2026

This PR has various changes and updates to the fastsurfer documentation.

Two example:

  • consistently mount/bind shared folders for singularity and docker in the same location as on the host file system (to simplify the documentation)
  • move the singularity example into position 1 (instead of the docker example)

Todos:

  • rebase the changes onto dev (currently on ClePol/CC_doc)
  • review and test the documentation for consistency and completeness

Add help to building from docker archive files

Clean up doc/conf.py

Add list of used packages to license document in documentation

Update requirements link

Update Singularity doc

Update PYTHONPATH is only required for direct calls to python scripts (shell scripts define the PYTHONPATH as well)

Fix links to SINGULARITY.md

Add FASTSURFER_VERSION as a substitution ({{ FASTSURFER_VERSION }})

Update docs to use same path inside container as outside

image does not need to be pulled if docker, docker does that automatically
Remove (outdated) manual edits description from recon_surf/README.md (but reference doc/overview/EDITING.md)

doc fixes

Fixes to the documentation.

- slurm-help: does not change between different runs (on github actions)
- most documentation files
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates FastSurfer documentation to improve consistency and clarity. The main changes include:

  • Standardizing mount/bind paths between Docker and Singularity to use the same locations as the host file system (using $HOME instead of mapping to different paths like /data, /output)
  • Reordering examples to show Singularity first, then Docker
  • Updating formatting and structure across documentation files

Changes:

  • Unified path mounting approach: Docker and Singularity now mount folders to the same path inside containers as on the host
  • Reordered examples: Singularity examples moved to position 1 throughout documentation
  • Improved documentation structure with consistent headers and formatting

Reviewed changes

Copilot reviewed 34 out of 34 changed files in this pull request and generated 7 comments.

Show a summary per file
File Description
tools/Docker/README.md Updated Docker examples to use $HOME paths consistently, fixed flag descriptions
doc/overview/SINGULARITY.md Major restructuring with containerization explanation, updated examples
doc/overview/EXAMPLES.md Swapped example order (Singularity first), updated paths to use $HOME
doc/overview/INSTALL.md Updated references to example numbers after reordering
doc/scripts/RUN_FASTSURFER.md Restructured flags documentation, added conditionally required section
recon_surf/README.md Updated examples with consistent $HOME paths
README.md Updated usage section with clearer flag explanations and $HOME paths
stools.sh Minor comment typo fix
srun_fastsurfer.sh Updated time limit warnings for CPU processing
Other files Various formatting improvements, typo fixes, and structural updates

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@dkuegler dkuegler force-pushed the feature/doc-update branch 4 times, most recently from aafcf3a to 08b4164 Compare January 21, 2026 18:36
@dkuegler dkuegler marked this pull request as ready for review January 21, 2026 20:23
@m-reuter
Copy link
Member

Maybe try adding this:

numpydoc_validation_exclude = {
    r'\.WarmupCosineLR\.step$',  # Exclude only WarmupCosineLR.step
}

to conf.py and undo the "Ignore warning" commit.

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