User Guide
==========


.. grid:: 3
    :gutter: 2

    .. grid-item-card:: Wrapper
        :img-top: ../_static/icon_wrapper.svg
        :link: wrapper/index
        :link-type: doc

        The wrapper is a thin layer on top of the h5py library. Improves
        interaction with HDF data and provides a set of useful functions.

    .. grid-item-card:: Convention
        :img-top: ../_static/icon_create_convention.svg
        :link: convention/index
        :link-type: doc

        Conventions let you defines standardized attributes and ensure
        consistency across your data.

    .. grid-item-card:: Database
        :img-top: ../_static/icon_database.svg
        :link: database/index
        :link-type: doc

        The database sub-package provides interfaces to database
        solutions, like using the file itself as a database or connection
        it to dedicated database solutions.


.. grid:: 3
    :gutter: 2

    .. grid-item-card:: Layout
        :img-top: ../_static/icon_layout.svg
        :link: layout/index
        :link-type: doc

        The layout sub-package provides a set of tools to organize your
        data in a structured way.

    .. grid-item-card:: Repository
        :img-top: ../_static/icon_repository.svg
        :link: repository/index
        :link-type: doc

        Provides interfaces to data repositories using to store your (HDF5)
        data with persistent identifiers.

    .. grid-item-card:: Misc
        :img-top: ../_static/icon_misc.svg
        :link: misc/index
        :link-type: doc

        Discover what else there is beyond the core functionalities packed
        into the sub-packages.




.. toctree::
    :maxdepth: 2
    :hidden:

    Wrapper <wrapper/index>
    Convention <convention/index>
    Layout <layout/index>
    Database <database/index>
    Repository <repository/index>
    Misc <misc/index>