arctichoke.plot.trend_in_time_map
=================================

.. py:module:: arctichoke.plot.trend_in_time_map


Functions
---------

.. autoapisummary::

   arctichoke.plot.trend_in_time_map.make_trend_map


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

.. py:function:: make_trend_map(this_source_id: str, this_var: str, this_variant_label: str, this_modification: str, mask_where_zero_across_time: bool = True, map_projection: str = 'Orthographic', verbose: bool = False)

   Plot the trends of the given data on a map.

   For each grid cell in the dataset, calculate the yearly sum, then find the trend in time for the given variable and plot it on a map.

   :param this_source_id: The source ID of the model to plot.
                          Example: `'EC-Earth3P-HR'`.
   :type this_source_id: `str`
   :param this_var: The variable ID of the variable to plot.
                    Example: `'silandfast'`.
   :type this_var: `str`
   :param this_variant_label: The variant label of the model to plot.
                              Example: `'r1i1p2f1'`.
   :type this_variant_label: `str`
   :param this_modification: The modification of the data to plot.
                             Example: `'trim_CAA_'`.
   :type this_modification: `str`
   :param verbose: Whether to verbosely output information as the function executes.
                   Default is `False`.
   :type verbose: `bool`, optional

   :returns: **sum_year_map** -- The map of the trends in time for the given variable.
   :rtype: `holoviews.core.overlay.Overlay`

   .. rubric:: Examples

   >>> from arctichoke.plot import make_trend_map
   >>> make_trend_map(
   >>>     this_source_id = 'EC-Earth3P-HR',
   >>>     this_var = 'silandfast',
   >>>     this_variant_label = 'r1i1p2f1',
   >>>     this_modification = 'trim_CAA_',
   >>>     verbose = True,
   >>> )