:py:mod:`adi_py.constants`
==================================

.. py:module:: adi_py.constants

.. autoapi-nested-parse::

   
   This module provides a variety of symbolic constants that can be used to
   find/select allowable values without hardcoding strings.





Classes
~~~~~~~

.. autoapisummary::

   adi_py.constants.ADIAtts
   adi_py.constants.ADIDatasetType
   adi_py.constants.BitAssessment
   adi_py.constants.SpecialXrAttributes
   adi_py.constants.SplitMode
   adi_py.constants.TransformAttributes





.. py:class:: ADIAtts


   .. py:attribute:: ANCILLARY_VARIABLES
      :annotation: = ancillary_variables

      

   .. py:attribute:: DESCRIPTION
      :annotation: = description

      

   .. py:attribute:: FILL_VALUE
      :annotation: = ['_FillValue']

      

   .. py:attribute:: LONG_NAME
      :annotation: = long_name

      

   .. py:attribute:: MISSING_VALUE
      :annotation: = missing_value

      

   .. py:attribute:: STANDARD_NAME
      :annotation: = standard_name

      

   .. py:attribute:: UNITS
      :annotation: = units

      

   .. py:attribute:: VALID_MAX
      :annotation: = valid_max

      

   .. py:attribute:: VALID_MIN
      :annotation: = valid_min

      



   .. autoapisummary::
      :nosignatures:






.. py:class:: ADIDatasetType

   Bases: :py:obj:`enum.Enum`

   
   Used to easily reference different types of ADI datasets.



   .. py:attribute:: OUTPUT
      :annotation: = 3

      

   .. py:attribute:: RETRIEVED
      :annotation: = 1

      

   .. py:attribute:: TRANSFORMED
      :annotation: = 2

      



   .. autoapisummary::
      :nosignatures:






.. py:class:: BitAssessment

   Bases: :py:obj:`enum.Enum`

   
   Used to easily reference bit assessment values used in ADI QC



   .. py:attribute:: BAD
      :annotation: = Bad

      

   .. py:attribute:: INDETERMINATE
      :annotation: = Indeterminate

      



   .. autoapisummary::
      :nosignatures:






.. py:class:: SpecialXrAttributes

   
   Enumerates the special XArray variable attributes that are assigned
   temporarily to help sync data between xarray and adi.



   .. py:attribute:: COORDINATE_SYSTEM
      :annotation: = __coordsys_name

      

   .. py:attribute:: DATASET_TYPE
      :annotation: = __dataset_type

      

   .. py:attribute:: DATASTREAM_DSID
      :annotation: = __datastream_dsid

      

   .. py:attribute:: OBS_INDEX
      :annotation: = __obs_index

      

   .. py:attribute:: OUTPUT_TARGETS
      :annotation: = __output_targets

      

   .. py:attribute:: SOURCE_DS_NAME
      :annotation: = __source_ds_name

      

   .. py:attribute:: SOURCE_VAR_NAME
      :annotation: = __source_var_name

      



   .. autoapisummary::
      :nosignatures:






.. py:class:: SplitMode

   Bases: :py:obj:`enum.Enum`

   
   Enumerates the split mode which is used to define the output file size
   used when storing values.  See dsproc.set_datastream_split_mode().



   .. py:attribute:: SPLIT_ON_DAYS
      

      

   .. py:attribute:: SPLIT_ON_HOURS
      

      

   .. py:attribute:: SPLIT_ON_MONTHS
      

      

   .. py:attribute:: SPLIT_ON_STORE
      

      



   .. autoapisummary::
      :nosignatures:






.. py:class:: TransformAttributes

   
   Used to easily reference transformation metadata attrs used in ADI QC



   .. py:attribute:: CELL_TRANSFORM
      :annotation: = cell_transform

      



   .. autoapisummary::
      :nosignatures: