crt1d.variables
===============

.. py:module:: crt1d.variables

.. autoapi-nested-parse::

   Variable metadata from the ``variables.yml`` file.



Attributes
----------

.. autoapisummary::

   crt1d.variables.VMD


Classes
-------

.. autoapisummary::

   crt1d.variables.Vmd
   crt1d.variables.VmdEntry


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

.. py:class:: Vmd(vmdes)

   Container for variable metadata of multiple variables.

   :param vmdes:
   :type vmdes: :class:`list` of :class:`VmdEntry`


   .. py:method:: intent(intent='in')

      Return filtered set of variables that have the specified `intent`.

      :param intent:
      :type intent: :class:`str`, ``{'in', 'out', 'none'}``

      :returns: :class:`dict` -- ``name: VmdEntry``



.. py:class:: VmdEntry(name, params, param_defaults)

   Variable metadata for one variable.

   :param name: Code variable name associated with the variable.
                Used as the ``name`` for :class:`xarray.DataArray`\s.
   :type name: :class:`str`
   :param params: Parameters for this variable.
   :type params: :class:`dict`
   :param param_defaults: Default parameters (to use if `params` is missing any of the needed).
   :type param_defaults: :class:`dict`


   .. py:method:: da_attrs()

      Return dict of attributes to use when creating an :class:`xarray.DataArray`
      for this variable.



   .. py:method:: details_sec(*, heading_level=3) -> str

      Construct details section for docs variables page.



   .. py:method:: dv_tuple(data)

      Construct an :class:`xarray.Dataset` ``data_vars`` tuple.



   .. py:method:: list_table_entry(fields) -> str

      Construct a MyST list-table entry for the docs variable summary table.

      :param fields: Parameters to include (in desired order).
      :type fields: :class:`list` of :class:`str`



   .. py:method:: param_entry(optional=False) -> str

      Construct an un-indented NumPy docstring Parameters entry.



.. py:data:: VMD

   :class:`Vmd` instance with all the variables from ``variables.yml``.