Code documentation
¶
This is the code documentation
Main functionalities
¶
libvhc
– Definitions
The
VCheck
object
The check function prototype
vhc
– The entry point
factories
– The factory functions
Examples
common
– Common checks
arc
– Arc files checks
bias
– Bias files checks
flat
– Flat files checks
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
HTML
¶
HTML result recap
html
– The interface
html.fplane
– Focal plane containers
collate_html_recaps
– Quickly collate the VHC output from a whole night
Virus Health Check
Navigation
Installation
Use VHC
VHC configuration
The directory structure
collate_html - Review a whole night of VHC recap files
Create and use a drivers
Contribute to VHC
Extend VHC
Code documentation
Main functionalities
Helpers
HTML
Authors
LICENCE
Changelog
TODO
Quick search
Enter search terms or a module, class or function name.