cars.applications.application_template
======================================

.. py:module:: cars.applications.application_template

.. autoapi-nested-parse::

   This module contains class application template for
   templating the application concept.
   Useful for shared parameters and functions in all applications
   Beware: argument-differ is activated in pylintrc for run parameters different
   in sub application classes



Classes
-------

.. autoapisummary::

   cars.applications.application_template.ApplicationTemplate
   cars.applications.application_template.ScalingApplicationTemplate


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

.. py:class:: ApplicationTemplate(conf=None)

   Class for general specification of an application
   Empty for the moment because there is no any common method or function


   .. py:attribute:: used_config
      :type:  cars.conf.input_parameters.ConfigType


   .. py:method:: run(*args, **kwargs)
      :abstractmethod:


      Generic run() function to be defined in subclasses



   .. py:method:: check_conf(conf)
      :abstractmethod:


      Check configuration

      :param conf: configuration to check
      :type conf: dict

      :return: overloaded configuration
      :rtype: dict




   .. py:method:: print_config()

      Print used application configuration




   .. py:method:: get_conf()

      Get used conf

      :return: used conf



   .. py:method:: generate_unknown_dump_dir(orchestrator)

      Generate dump dir from orchestrator

      :param orchestrator: orchestrator

      :return: dump dir



.. py:class:: ScalingApplicationTemplate(scaling_coeff, conf=None)

   Bases: :py:obj:`ApplicationTemplate`


   Template for applications requiring resolution scaling.

   Inherits from ApplicationTemplate and adds the scaling coefficient
   as a required argument.


   .. py:attribute:: scaling_coeff