:py:mod:`km3test.client`
========================

.. py:module:: km3test.client

.. autoapi-nested-parse::

   The km3test CLI interface

   Usage:
       km3test [options] [FILENAME]
       km3test (-h | --help)
       km3test --version

   Options:
       FILENAME   Path to the file to be checked [optional if -c is set], can contain parameters
       -t TYPE       Name of the test to be performed if standard test
       -c CONF       Path to configuration file
       -p PARAMS     Path to file holding parameters if filename contains parameters
       -o OUTFILE    Path for the file holding the tabulated results
       --save_all    save all tests and results for reuse ("km3tests.pkl"), default: False
       -h --help     Show this screen.

   Examples:
       km3test -t filechecks_hasevents myfile.root    # perform standard file check on file myfile.root
       km3test -c myconfig.yml          # perform check defined in myconfig.yml on files defined in the same file
       
       # csv-table with column RUNNUMBER to check all files matching the file pattern:
       km3test -p myrunlist.csv -o myresults.csv /where/files/are/filename_{RUNNUMBER}.root           

   ..
       !! processed by numpydoc !!


Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

   km3test.client.main



.. py:function:: main()

   
















   ..
       !! processed by numpydoc !!