.. _api:

datamodel Reference
===================

.. _api-genearate:

Generate
--------

.. automodule:: datamodel.generate.datamodel
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: datamodel.generate.parse
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: datamodel.generate.stub
   :members:
   :undoc-members:
   :show-inheritance:

Filetypes
^^^^^^^^^

.. automodule:: datamodel.generate.filetypes.base
   :members:
   :undoc-members:
   :show-inheritance:
   :private-members: _generate_new_cache, _update_partial_cache, _get_designed_object

.. automodule:: datamodel.generate.filetypes.fits
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: datamodel.generate.filetypes.par
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: datamodel.generate.filetypes.hdf5
   :members:
   :undoc-members:
   :show-inheritance:

Changelog
^^^^^^^^^

.. automodule:: datamodel.generate.changelog.core
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: datamodel.generate.changelog.yaml
   :members:
   :undoc-members:
   :show-inheritance:
   :private-members: _get_changes

.. automodule:: datamodel.generate.changelog.filetypes.catalog
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: datamodel.generate.changelog.filetypes.fits
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: datamodel.generate.changelog.filetypes.par
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: datamodel.generate.changelog.filetypes.hdf5
   :members:
   :undoc-members:
   :show-inheritance:

Git
---

.. automodule:: datamodel.gitio.gitio
   :members:
   :undoc-members:
   :show-inheritance:

Io
--

.. automodule:: datamodel.io.loaders
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: datamodel.io.move
   :members:
   :undoc-members:
   :show-inheritance:

Models
------

.. automodule:: datamodel.models.base
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: datamodel.models.releases
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: datamodel.models.yaml
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: datamodel.models.surveys
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: datamodel.models.versions
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: datamodel.models.vacs
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: datamodel.models.filetypes.fits
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: datamodel.models.filetypes.par
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: datamodel.models.filetypes.hdf5
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: datamodel.models.validators
   :members:
   :undoc-members:
   :show-inheritance:


Products
--------

.. automodule:: datamodel.products.product
   :members:
   :undoc-members:
   :show-inheritance:


Validate
--------

.. automodule:: datamodel.validate.add
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: datamodel.validate.check
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: datamodel.validate.models
   :members:
   :undoc-members:
   :show-inheritance: