:py:mod:`km3test.configure`
===========================

.. py:module:: km3test.configure

.. autoapi-nested-parse::

   Managing test setup by reading configurations, handling test objects and performing test in class TestManager.
   Basic test steps include 
   * adding test from test configuration files or manually
   * adding test objects
   * creating the test setup
   * running the tests
   * returning the test results

   ..
       !! processed by numpydoc !!


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

Classes
~~~~~~~

.. autoapisummary::

   km3test.configure.TestManager




.. py:class:: TestManager

   
   Class to manage test execution

   Objects:
      * self.configs: holding configuration for tests
      * self.inputs: holding input objects to be tested (e.g. files paths)
      * self.tests: full test scenarios with according configuration and inputs (of type KM3Test)
      * self.outputs: output objects from tests (e.g. summaries, optional)















   ..
       !! processed by numpydoc !!
   .. py:method:: add_configuration(self, configname, config)

      
















      ..
          !! processed by numpydoc !!

   .. py:method:: add_input(self, inputname, inputconfig)

      
















      ..
          !! processed by numpydoc !!

   .. py:method:: add_report(self, reportname, reportconfig)

      
















      ..
          !! processed by numpydoc !!

   .. py:method:: read_standards(self, folderpath='')

      
















      ..
          !! processed by numpydoc !!

   .. py:method:: read_configfile(self, infilename, prefix='')

      
      Auxiliary to read configurations from yaml file
















      ..
          !! processed by numpydoc !!

   .. py:method:: create(self)

      
      Creates KM3Tests from configurations
















      ..
          !! processed by numpydoc !!

   .. py:method:: run(self)

      
      Runs created tests in self.test
















      ..
          !! processed by numpydoc !!

   .. py:method:: report(self, display=False)

      
      Returns results according to configuration
















      ..
          !! processed by numpydoc !!

   .. py:method:: save_all(self, filepath)

      
      Saves all configurations, tests and reports as python object
















      ..
          !! processed by numpydoc !!

   .. py:method:: read_all(self, filepath)

      
















      ..
          !! processed by numpydoc !!