Code documentation

This is the code documentation

Main functionalities

• libvhc – Definitions
  • The VCheck object
• vhc – The entry point
• recipes – Builtin recipes
• factories – The factory functions
  • Examples
• drivers – Drivers utilities and implemations

Helpers

• config – Configurations
• loaders – Load modules, get and execute functions
• loggers – Set up the logging system
  • Examples
• reference_file_parser – Parse files storing reference values
• exceptions – Custom exceptions
• utils – Utilities
  • Variables
  • Get channel, amplifier and ids
  • Other utilities

HTML

• HTML result recap
  • html – The interface
  • html.fplane – Focal plane containers
  • html.queue – The queue listener process
• collate_html_recaps – Quickly collate the VHC output from a whole night