.. _task-livvkit:

livvkit — Ice Sheet Validation
================================

The ``livvkit`` task runs `LIVVkit
<https://livvkit.github.io/Docs/>`_ (Land Ice Verification and Validation
Toolkit) for ice sheet model evaluation. It compares climatology files
generated by the :doc:`climo` task against reanalysis datasets.

Parameters
----------

These 4 parameters are specific to the ``livvkit`` task.

.. list-table::
   :header-rows: 1
   :widths: 22 10 18 50

   * - Parameter
     - Required
     - Default
     - Description
   * - ``climo_subsections``
     - No
     - ``[""]``
     - List of ``[climo]`` subtasks to depend on.
   * - ``cfg``
     - No
     - ``"inclusions/livvkit/livvkit_r05.jinja"``
     - Path to the LIVVkit configuration template.
   * - ``icesheets``
     - No
     - ``"gis,ais"``
     - Icesheets to analyze: ``gis`` (Greenland), ``ais`` (Antarctica).
   * - ``sets``
     - No
     - ``"cmb,smb,energy_racmo,energy_era5,energy_merra2,energy_ceres"``
     - Validation sets to perform.

Parameters at the top-level
~~~~~~~~~~~~~~~~~~~~~~~~~~~

For top-level parameters, see :ref:`top-level parameters <parameters-top-level>`.

Dependencies
------------

**Upstream (what livvkit depends on):**

- :doc:`climo` — Monthly-lnd climo
- :doc:`ts` -- Monthly-lnd ts.

**Downstream (what depends on livvkit):**

- None.

Climo dependency requirements
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The ``livvkit`` task requires specific ``[climo]`` subtasks to be defined:

- A grid-native climatology must be generated, assumed to be named
  ``land_monthly_climo_native``.
- For each reanalysis comparison, a corresponding
  ``land_monthly_climo_GRID`` subtask is needed, where ``GRID`` is the
  reanalysis grid name.

Available reanalysis comparisons and their grid names:

- ``racmo_gis``, ``racmo_ais``
- ``merra2``
- ``era5``
- ``ceres`` (uses the default CMIP6 grid)