:py:mod:`cars.pipelines.pipeline_template`
==========================================

.. py:module:: cars.pipelines.pipeline_template

.. autoapi-nested-parse::

   This module contains class pipeline template for
   templating the pipeline concept.



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

Classes
~~~~~~~

.. autoapisummary::

   cars.pipelines.pipeline_template.PipelineTemplate



Functions
~~~~~~~~~

.. autoapisummary::

   cars.pipelines.pipeline_template._merge_pipeline_conf_rec



.. py:class:: PipelineTemplate


   Class for general specification of an pipeline

   .. py:method:: check_orchestrator(conf)

      Check the configuration of orchestrator

      :param conf: configuration of orchestrator
      :type conf: dict
      :return: overloaded orchestrator conf
      :rtype: dict


   .. py:method:: check_global_schema(conf)

      Check the given global configuration

      :param conf: configuration
      :type conf: dict


   .. py:method:: merge_pipeline_conf(config1, config2)

      Merge two pipeline dict, generating a new configuration

      :param conf1: configuration
      :type conf1: dict
      :param conf2: configuration
      :type conf2: dict

      :return: merged conf
      :rtype: dict



   .. py:method:: check_inputs(conf, config_json_dir=None)
      :abstractmethod:

      Check the inputs given

      :param conf: configuration of inputs
      :type conf: dict
      :param config_json_dir: directory of used json, if
          user filled paths with relative paths
      :type config_json_dir: str

      :return: overloader inputs
      :rtype: dict


   .. py:method:: check_output(conf, pipeline)
      :abstractmethod:

      Check the output given

      :param conf: configuration of output
      :type conf: dict
      :param pipeline: name of corresponding pipeline
      :type pipeline_name: str

      :return overloader output
      :rtype : dict


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

      Check the given configuration for applications

      :param conf: configuration of applications
      :type conf: dict


   .. py:method:: run()
      :abstractmethod:

      Run pipeline



.. py:function:: _merge_pipeline_conf_rec(conf1, conf2)

   Merge secondary configuration on primary one

   :param conf1: configuration
   :type conf1: dict
   :param conf2: configuration
   :type conf2: dict

   :return: merged conf
   :rtype: dict