-
Notifications
You must be signed in to change notification settings - Fork 144
Various updates and changes to the documentation #765
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: dev
Are you sure you want to change the base?
Conversation
f01be1c to
10a9762
Compare
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
0fc9a39 to
8d4abcf
Compare
There was a problem hiding this 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
$HOMEinstead 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.
aafcf3a to
08b4164
Compare
improve instructions for issue submission
Fix heading level in consistency in FastSurferCNN/README.md
08b4164 to
0b22293
Compare
657f75a to
ded6114
Compare
|
Maybe try adding this: to |
This PR has various changes and updates to the fastsurfer documentation.
Two example:
Todos:
rebase the changes onto dev (currently on ClePol/CC_doc)review and test the documentation for consistency and completeness