credit.ocean.samudra_constants
==============================

.. py:module:: credit.ocean.samudra_constants


Attributes
----------

.. autoapisummary::

   credit.ocean.samudra_constants.DEPTH_LEVELS
   credit.ocean.samudra_constants.DEPTH_I_LEVELS
   credit.ocean.samudra_constants.MASK_VARS
   credit.ocean.samudra_constants.PROG_VARS_MAP
   credit.ocean.samudra_constants.BOUND_VARS_MAP
   credit.ocean.samudra_constants.default_metadata


Classes
-------

.. autoapisummary::

   credit.ocean.samudra_constants.TensorMap


Functions
---------

.. autoapisummary::

   credit.ocean.samudra_constants.construct_metadata


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

.. py:data:: DEPTH_LEVELS
   :value: [2.5, 10.0, 22.5, 40.0, 65.0, 105.0, 165.0, 250.0, 375.0, 550.0, 775.0, 1050.0, 1400.0, 1850.0,...


.. py:data:: DEPTH_I_LEVELS
   :value: ['0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13', '14', '15', '16', '17', '18']


.. py:data:: MASK_VARS
   :value: ['mask_0', 'mask_1', 'mask_2', 'mask_3', 'mask_4', 'mask_5', 'mask_6', 'mask_7', 'mask_8',...


.. py:data:: PROG_VARS_MAP

.. py:data:: BOUND_VARS_MAP

.. py:data:: default_metadata

.. py:function:: construct_metadata(data: xarray.Dataset) -> Dict[str, Dict[str, str]]

.. py:class:: TensorMap

   .. py:attribute:: _instance
      :type:  Optional[TensorMap]
      :value: None



   .. py:method:: get_instance() -> TensorMap
      :classmethod:



   .. py:method:: init_instance(prognostic_vars_key: str, boundary_vars_key: str) -> TensorMap
      :classmethod:



   .. py:method:: _initialize(prognostic_vars_key: str, boundary_vars_key: str)

      Maps input variables / depth levels to their indices in the input tensor.

      VAR_3D_IDX maps the input variables to their indices in the input tensor
      DP_3D_IDX maps the depth levels to their indices in the input tensor



   .. py:method:: _populate_var_3d_idx()


   .. py:method:: _populate_dp_3d_idx()