Core BEAT components

This user guide contains information about BEAT core components, defining experiments, toolchains and user algorithms among others.

• Introduction
  • A Simple Example
  • Design
• Data formats
  • Definition
  • Simple types
  • Complex types
  • Aggregation
  • Arrays
  • Extensions
  • Python API
• Algorithms
  • Definition
    • JSON Declaration
    • Analyzer
    • Source Code
  • Examples
    • Simple algorithm (no parametrization)
    • Parametrizable algorithm
  • Handling input data
    • Input list
    • Input
    • Input naming
    • Inputs synchronization
    • Additional input methods for unsynchronized channels
    • Feedback inputs
  • Handling output data
    • Output list
    • Output
    • Output naming
    • Example 1: Write one block of data for each received block of data
    • Example 2: Skip some blocks of data
    • Example 3: Write one block of data related to several received blocks of data
• Libraries
  • Definition
  • Usage
• Toolchains
  • Declaration of a toolchain
  • Declaration of the datasets
  • Declaration of the processing blocks
  • Declaration of the connections between the processing blocks
  • Declaration of the outputs to use as results
  • Putting it all together: a complete example
• Experiments
  • Declaration of an experiment
  • Declaration of the dataset(s)
  • Declaration of the block(s)
  • Declaration of the analyzer(s)
  • Global parameters
• Databases
  • Structure of a database
  • Evaluation protocols
  • Database set templates
• Inputs/Outputs
  • Introduction
  • Binary Format
• Backend API
  • Filesystem Organization
  • Message Passing
    • Command: has-more-data (hmd)
    • Command: is-dataunit-done (idd)
    • Command: next (nxt)
    • Command: write (wrt)
    • Command: is-data-missing (idm)
    • Command: output-is-connected (oic)
    • Command: done (don)
    • Command: error (err)
• Local Development
  • Docker
    • Docker Setup
  • Documentation
  • Testing
  • Other bits
• Profiling
• API
  • algorithm
  • baseformat
  • data
  • data_loaders
  • database
  • dataformat
  • dock
  • drawing
  • environment
  • base
  • docker
  • local
  • remote
  • subprocess
  • experiment
  • hash
  • inputs
  • library
  • loader
  • message_handler
  • outputs
  • plotter
  • stats
  • toolchain
  • utils
  • worker

Indices and tables

• Index
• Module Index
• Search Page