firecrown.models.cluster.recipes.cluster_recipe
===============================================

.. py:module:: firecrown.models.cluster.recipes.cluster_recipe

.. autoapi-nested-parse::

   Module for defining the ClusterRecipe class.



Classes
-------

.. autoapisummary::

   firecrown.models.cluster.recipes.cluster_recipe.ClusterRecipe


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

.. py:class:: ClusterRecipe(parameter_prefix = None)

   Bases: :py:obj:`firecrown.updatable.Updatable`, :py:obj:`abc.ABC`

   .. autoapi-inheritance-diagram:: firecrown.models.cluster.recipes.cluster_recipe.ClusterRecipe
      :parts: 1


   Abstract class defining a cluster recipe.

   A cluster recipe is a combination of different cluster theoretrical predictions
   and models that produces a single prediction for an observable.


   .. py:attribute:: my_updatables
      :type:  firecrown.updatable.UpdatableCollection


   .. py:method:: evaluate_theory_prediction(cluster_theory, this_bin, sky_area, average_on = None)
      :abstractmethod:


      Evaluate the theory prediction for this cluster recipe.