ensemble_eval
=============

.. py:module:: ensemble_eval


Attributes
----------

.. autoapisummary::

   ensemble_eval.description


Functions
---------

.. autoapisummary::

   ensemble_eval.evaluate
   ensemble_eval.do_eval
   ensemble_eval._do_standard_eval_on_variable
   ensemble_eval._do_special_eval_on_variable
   ensemble_eval.get_data
   ensemble_eval.check_rollout_files


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

.. py:function:: evaluate(num_files, forecast_save_loc, conf, model_conf, p)

.. py:function:: do_eval(forecast_save_loc, conf, model_conf, fh)

   compute ensemble verification per forecast hour across all ICs
   returns None values for special metrics when fh not in detailed_eval_hours


.. py:function:: _do_standard_eval_on_variable(w_lat, da_pred, da_true, variable, level)

.. py:function:: _do_special_eval_on_variable(w_lat, conf, fh, da_pred, da_true, variable, level)

.. py:function:: get_data(sampler, rollout_files, variable, level)

   uses a XRSamplerByYear object to sample the true data


.. py:function:: check_rollout_files(forecast_save_loc)

   checks that all subfolders in forecast_save_loc has the same number of files


.. py:data:: description
   :value: 'evaluate ensemble rollouts'