esgf_playground_utils.models.item
=================================

.. py:module:: esgf_playground_utils.models.item

.. autoapi-nested-parse::

   Models relating to STAC Items for the ESGF-Playground.



Classes
-------

.. autoapisummary::

   esgf_playground_utils.models.item.ESGFItem
   esgf_playground_utils.models.item.ESGFItemProperties
   esgf_playground_utils.models.item.CMIP6Item


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

.. py:class:: ESGFItem(/, **data: Any)

   Bases: :py:obj:`stac_pydantic.item.Item`


   https://github.com/radiantearth/stac-spec/blob/v1.0.0/item-spec/item-spec.md


   .. py:attribute:: stac_version
      :type:  str
      :value: '1.0.0'



.. py:class:: ESGFItemProperties(/, **data: Any)

   Bases: :py:obj:`stac_pydantic.item.ItemProperties`


   https://github.com/radiantearth/stac-spec/blob/v1.0.0/item-spec/item-spec.md#properties-object


   .. py:attribute:: access
      :type:  Optional[List[str]]
      :value: []



   .. py:attribute:: activity_id
      :type:  List[str]


   .. py:attribute:: cf_standard_name
      :type:  str


   .. py:attribute:: citation_url
      :type:  Optional[pydantic.HttpUrl]
      :value: None



   .. py:attribute:: data_spec_version
      :type:  Optional[str]
      :value: None



   .. py:attribute:: experiment_id
      :type:  str


   .. py:attribute:: experiment_title
      :type:  str


   .. py:attribute:: frequency
      :type:  str


   .. py:attribute:: further_info_url
      :type:  pydantic.HttpUrl


   .. py:attribute:: grid
      :type:  str


   .. py:attribute:: grid_label
      :type:  str


   .. py:attribute:: institution_id
      :type:  str


   .. py:attribute:: mip_era
      :type:  str


   .. py:attribute:: model_cohort
      :type:  Optional[str]
      :value: None



   .. py:attribute:: nominal_resolution
      :type:  str


   .. py:attribute:: pid
      :type:  Optional[str]
      :value: None



   .. py:attribute:: product
      :type:  Optional[str]
      :value: None



   .. py:attribute:: project
      :type:  Optional[str]
      :value: None



   .. py:attribute:: realm
      :type:  Optional[List[str]]
      :value: []



   .. py:attribute:: retracted
      :type:  Optional[bool]
      :value: False



   .. py:attribute:: source_id
      :type:  str


   .. py:attribute:: source_type
      :type:  List[str]


   .. py:attribute:: sub_experiment_id
      :type:  str


   .. py:attribute:: table_id
      :type:  str


   .. py:attribute:: title
      :type:  str


   .. py:attribute:: variable
      :type:  Optional[str]
      :value: None



   .. py:attribute:: variable_id
      :type:  str


   .. py:attribute:: variable_long_name
      :type:  str


   .. py:attribute:: variable_units
      :type:  Optional[str]
      :value: None



   .. py:attribute:: variant_label
      :type:  str


   .. py:attribute:: version
      :type:  Optional[str]
      :value: None



   .. py:attribute:: model_config

      Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].



.. py:class:: CMIP6Item(/, **data: Any)

   Bases: :py:obj:`stac_pydantic.item.Item`


   https://github.com/radiantearth/stac-spec/blob/v1.0.0/item-spec/item-spec.md


   .. py:attribute:: properties
      :type:  ESGFItemProperties