arctichoke.dataset.get_min_max
==============================

.. py:module:: arctichoke.dataset.get_min_max


Functions
---------

.. autoapisummary::

   arctichoke.dataset.get_min_max.get_min_max


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

.. py:function:: get_min_max(dataset: (str, xarray.DataArray, xarray.Dataset), var: str = None)

   Get the minimum / maximum of the dataset.

   Opens the given dataset, finds the given variable if `xr.Dataset`, returns the minimum / maximum values of that data.

   :param dataset: The dataset for which to determine the minimum / maximum values.
   :type dataset: `str`, `xarray.DataArray`, `xarray.Dataset`
   :param var: The variable in `dataset` for which to find the minimum / maximum.
               Default is `None`.
   :type var: `str`, `None`, optional

   :returns: * **var_min** (`int`, `float`) -- The minimum value of the data.
             * **var_max** (`int`, `float`) -- The maximum value of the data.

   .. rubric:: Examples

   >>> from arctichoke.dataset.example_dataset import make_example_dataset
   >>> from arctichoke.dataset.get_min_max import get_min_max
   >>> dataset = make_example_dataset(n=3)
   >>> min, max = get_min_max(dataset, var='test_var')
   >>> print('min:',min,'max:',max)
   min: 0.0 max: 8.0