:orphan:

.. _fundamentals:


Fundamentals
==============================

Below is a gallery of examples illustrating the fundamental components 
within ``dman``. If you want to use the package to its fullest extend 
this is a good read.


.. raw:: html

    <div class="sphx-glr-thumbnails">


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example describes the various ways in which one  can construct new serializable objects.">

.. only:: html

  .. image:: /gallery/fundamentals/images/thumb/sphx_glr_example0_serializables_thumb.png
    :alt: Defining Serializables

  :ref:`sphx_glr_gallery_fundamentals_example0_serializables.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Defining Serializables</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example describes ways in which one can define storable objects.">

.. only:: html

  .. image:: /gallery/fundamentals/images/thumb/sphx_glr_example1_storables_thumb.png
    :alt: Defining Storables

  :ref:`sphx_glr_gallery_fundamentals_example1_storables.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Defining Storables</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="We show how to use records to serialize storables.">

.. only:: html

  .. image:: /gallery/fundamentals/images/thumb/sphx_glr_example2_records_thumb.png
    :alt: Using Records

  :ref:`sphx_glr_gallery_fundamentals_example2_records.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Using Records</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The objects you will use most frequently in dman are models. ">

.. only:: html

  .. image:: /gallery/fundamentals/images/thumb/sphx_glr_example3_models_thumb.png
    :alt: Model Types

  :ref:`sphx_glr_gallery_fundamentals_example3_models.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Model Types</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="To keep track of files internally dman has some custom path specifications.">

.. only:: html

  .. image:: /gallery/fundamentals/images/thumb/sphx_glr_example4_path_thumb.png
    :alt: Mounting and Targets

  :ref:`sphx_glr_gallery_fundamentals_example4_path.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Mounting and Targets</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="We illustrate basic dman logging functionality.">

.. only:: html

  .. image:: /gallery/fundamentals/images/thumb/sphx_glr_example5_logging_thumb.png
    :alt: Logging

  :ref:`sphx_glr_gallery_fundamentals_example5_logging.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Logging</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="We show how errors are handled within dman.">

.. only:: html

  .. image:: /gallery/fundamentals/images/thumb/sphx_glr_example6_errors_thumb.png
    :alt: Error handling

  :ref:`sphx_glr_gallery_fundamentals_example6_errors.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Error handling</div>
    </div>


.. raw:: html

    </div>


.. toctree::
   :hidden:

   /gallery/fundamentals/example0_serializables
   /gallery/fundamentals/example1_storables
   /gallery/fundamentals/example2_records
   /gallery/fundamentals/example3_models
   /gallery/fundamentals/example4_path
   /gallery/fundamentals/example5_logging
   /gallery/fundamentals/example6_errors


.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-gallery

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download all examples in Python source code: fundamentals_python.zip </gallery/fundamentals/fundamentals_python.zip>`

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download all examples in Jupyter notebooks: fundamentals_jupyter.zip </gallery/fundamentals/fundamentals_jupyter.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_