.. _csdm_api:

--------
CSDM
--------

.. currentmodule:: csdmpy.csdm
.. autoclass:: CSDM
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~CSDM.version
      ~CSDM.description
      ~CSDM.read_only
      ~CSDM.timestamp
      ~CSDM.geographic_coordinate
      ~CSDM.dimensions
      ~CSDM.dependent_variables
      ~CSDM.tags
      ~CSDM.application
      ~CSDM.data_structure
      ~CSDM.filename

   .. rubric:: Methods Summary

   .. autosummary::

      ~CSDM.add_dimension
      ~CSDM.add_dependent_variable
      ~CSDM.to_dict
      ~CSDM.dumps
      ~CSDM.save
      ~CSDM.copy

   .. rubric:: Attributes Documentation

   .. autoattribute:: version
   .. autoattribute:: description
   .. autoattribute:: read_only
   .. autoattribute:: timestamp
   .. autoattribute:: geographic_coordinate
   .. autoattribute:: dimensions
   .. autoattribute:: dependent_variables
   .. autoattribute:: tags
   .. autoattribute:: application
   .. autoattribute:: data_structure
   .. autoattribute:: filename

   .. rubric:: Methods Documentation

   .. automethod:: add_dimension
   .. automethod:: add_dependent_variable
   .. automethod:: to_dict
   .. automethod:: dumps
   .. automethod:: save
   .. automethod:: copy