AutoHS

Contents

  • Background and theory
    • Clinical context
    • What AutoHS measures
    • The asymmetry index (AI)
    • Two layers of interpretation
      • Volume laterality (descriptive)
      • HS screening (pathology-oriented)
    • End-to-end workflow (theory view)
    • Segmentation backends
      • FreeSurfer (default)
      • FastSurfer (--fastsurfer)
    • Expected inputs and limitations
    • Scientific reference
    • Further reading in this documentation
  • Installation
    • Architecture
    • Docker Container
    • Apptainer / Singularity Container
    • Python / Source Install
    • External Dependencies
      • FreeSurfer license
  • Quick Start
    • Validate your dataset
    • IDEAS sample (recommended first run)
    • Docker example (one subject)
    • Apptainer example (HPC)
    • FastSurfer (no FreeSurfer license)
  • Sample data
    • Location
    • Download
    • Example run
    • Citations
  • Usage
    • Example
    • Command-Line Arguments
      • Positional Arguments
      • Options for filtering BIDS queries
      • Options to handle performance
      • Workflow configuration
      • Methods boilerplate
    • Participant mode
    • Group level
    • Preparing data for AutoHS
      • Required inputs
      • Supported suffix
      • FreeSurfer license
  • Outputs
    • Directory layout
    • Participant reports
    • Quality control
    • Hippocampal sclerosis classification
    • Provenance
  • Preprocessing
    • Pipeline overview
    • Step 1 — Segmentation
      • Default: FreeSurfer
      • Optional: FastSurfer (--fastsurfer)
    • Step 2 — AI-compute
    • Processing a subject/session pair
    • Enabling and disabling steps
    • What is happening?
    • References
  • Methods boilerplate
    • Generate boilerplate
    • Example output
    • Additional citations
  • FAQ
    • General
    • Data requirements
    • Outputs
    • Containers and HPC
    • Citations
  • Troubleshooting
    • BIDS validation failures
    • No T1w scans found
    • FreeSurfer license errors
    • Container / runtime errors
    • --reports-only failures
    • Partial batch failures
    • Performance
    • Getting help
  • Contributing
    • Report issues
    • Development setup
    • Run tests
    • Build documentation locally
    • Documentation changes
    • Pull requests
  • Citation
    • AutoHS / hippocampal asymmetry
    • Sample dataset (IDEAS)
    • Third-party tools used by AutoHS
    • BibTeX
    • Related software
    • Software citation file
  • Changes
    • Recent releases
    • Full history
  • Roadmap
    • Stage 1 — Publish
    • Stage 2 — BIDS derivatives compliance
    • Stage 3 — Feature completeness
    • Stage 4 — Integration testing
    • Stage 5 — Ecosystem
    • Documentation depth (QSIPrep parity)
  • BIDS Apps hub registration
    • Docker Hub image
    • Apptainer / Singularity
    • List on the BIDS website
    • Optional: BIDS Apps GitHub organization
    • Citation metadata
  • Maintaining AutoHS
    • Release checklist
    • Read the Docs
    • Docker Hub
    • Zenodo
    • BIDS Apps hub
    • Roadmap
  • Privacy and public data
    • What we publish
    • What we do not publish
    • Sample dataset policy
    • HPC configuration
    • Reporting issues
AutoHS
  • Search


© Copyright 2025, University of Rochester.

Built with Sphinx using a theme provided by Read the Docs.