ACMAD Upload Helper Logo

User guide

  • Installation
  • Command-line usage
  • Configuration
  • Customising the ETL pipeline
  • Architecture and Python use

Python API

  • Python API reference
ACMAD Upload Helper
  • ACMAD Upload Helper
  • View page source

ACMAD Upload Helper

ACMAD Upload Helper extracts clinical and motion-capture data from an ACMAD package, transforms it into validated canonical records, and uploads those records to the ACMAD REST API. It provides a command-line interface, an optional desktop interface, and composable Python ETL components.

User guide

  • Installation
    • pip
    • uv
    • Optional desktop interface
  • Command-line usage
    • Inspect a package
    • Upload a package
    • Work with one record type
    • Upload order and repeat runs
  • Configuration
    • Site acronym
  • Customising the ETL pipeline
    • Choose the appropriate extension point
    • Core contracts
    • Design an institution-specific package
    • Implement a database extractor
    • Implement a source-specific transformer
    • Assemble the complete provider
    • Validate and upload through the provider
    • Run one slice directly
    • Customise destination loading
    • Transactions, repeatability, and incremental reads
    • Biomechanics artefacts
    • Configuration and secrets
    • Testing a custom provider
    • Deployment considerations
    • Implementation checklist
  • Architecture and Python use
    • ETL stages
    • Cross-cutting components
    • Loose coupling
    • Running an ETL pipeline
    • Results and issues

Python API

  • Python API reference
    • Domain models
    • Source extraction
    • Transformers
    • Application services
    • Ports
    • REST API adapters
    • Presentation helpers
    • User interfaces

Indices

  • Index

  • Module Index

  • Search Page

Next

© Copyright 2026, Griffith University.

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