Logo

Getting Started

  • Getting Started
    • Overview & Installation Video
    • Installation
    • Usage
      • Single-File Mode
      • Regular Mode
    • File Format
      • Sample File
  • Installation
    • PyPI
    • Building from Source
  • Example Notebooks
    • Getting Documentation via Help()
      • Load AUViewer API & Print Help for API
      • Load Project & Print Help for Project
      • Load File & Print Help for File
      • And so forth…
    • Create a Pattern Set
      • Note
      • Load AUViewer API
      • Load Project
      • Create a New Pattern Set
      • Get & Populate the Patterns DataFrame
      • Add the Patterns to the Pattern Set
      • We can confirm it’s added!

Documentation

  • Data Directory
  • Project Templates
  • Dynamic Annotation
    • Why does this exist?
    • How can I use this?
    • Implementation
  • Python API
    • Submodules
      • auviewer.api module
        • downsampleFile()
        • getProject()
        • getProjects()
        • getProjectsPayload()
        • instantiatePool()
        • listAvailableProjects()
        • listLoadedProjects()
        • listUsers()
        • loadProject()
        • loadProjects()
        • scaffoldProjectFolder()
        • setDataPath()
        • validateProjectFolder()
      • auviewer.file module
        • File
      • auviewer.patternset module
        • PatternSet
        • getAssignmentsPayload()
      • auviewer.project module
        • Project
      • auviewer.series module
        • Series
        • simpleSeriesName()
      • auviewer.serve module
        • createApp()
        • main()

Contributing

  • Motivation
    • Motivation
    • Contributing
  • Getting Started Developing
    • Initial Setup
  • Building & Publishing
    • Build from source & install locally
    • Clean up source builds
    • Generate Sphinx documentation
    • Build from source and publish Linux (wheels and source)
    • Build from source and publish Mac wheel
  • Technical Overview
    • Introduction
    • Viewer Use Cases
      • Detailed Viewer Use Cases
    • Technical Architecture
    • Strategies
    • Patterns & Conventions
    • Backend Configuration

About

  • About
    • Created & Maintained for You By
      • Additional Contributors
      • Interested in Contributing?
    • Design Choices
    • Tradeoffs & Implications
  • License

Discussion

  • User Group

Source Code

  • GitHub
Auton Universal Viewer
  • Overview: module code

All modules for which code is available

  • auviewer.api
  • auviewer.file
  • auviewer.patternset
  • auviewer.project
  • auviewer.series
  • auviewer.serve

© Copyright 2020, Auton Lab, Carnegie Mellon University.

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