Skip to content

Latest commit

 

History

History
108 lines (76 loc) · 3.13 KB

index.rst

File metadata and controls

108 lines (76 loc) · 3.13 KB

Welcome to Enstools-Encoding's documentation! Documentation Status

Attention!

This package is a building block of enstools-compression. The recommendation is to directly use enstools-compression. The only purpose of splitting the package was to provide a way of using compression filters with xarray without adding too much dependencies. It might be the main sound reason to use this package separately.

enstools-encoding is a minimal set of interfaces to convert a string compiling with a Compression Specification Format to the arguments that are actually needed to write files compressed with hdf5 filters from h5py, h5netcdf or xarray.

This package was extracted from enstools, and it's a key piece of enstools-compression.

It has been developed within the framework of Waves to Weather [1].

.. grid:: 2

    .. grid-item-card::
        :columns: 5

        .. image:: ./images/icons/getting_started.svg
            :width: 50%
            :alt: Alternative text
            :align: center

        .. button-ref:: quick-start/index
            :expand:
            :color: secondary
            :click-parent:

            Quick Start!

    .. grid-item-card::
        :columns: 5

        .. image:: ./images/icons/format.svg
            :width: 50%
            :alt: Alternative text
            :align: center

        .. button-ref:: CompressionSpecificationFormat
            :expand:
            :color: secondary
            :click-parent:

            Compression Specification Format

    .. grid-item-card::
        :columns: 5

        .. image:: ./images/icons/api.svg
            :width: 50%
            :alt: Alternative text
            :align: center

        .. button-ref:: api
            :expand:
            :color: secondary
            :click-parent:

            To the API

    .. grid-item-card::
        :columns: 5

        .. image:: ./images/icons/contributor.svg
            :width: 50%
            :alt: Alternative text
            :align: center

        .. button-ref:: contribute
            :expand:
            :color: secondary
            :click-parent:

            Want to contribute?


.. toctree::
    :caption: Enstools-Encoding
    :maxdepth: 1
    :hidden:

    quick-start/index.rst
    CompressionSpecificationFormat.rst
    api.rst
    contribute.rst

.. toctree::
    :caption: Related packages
    :hidden:

    Ensemble Tools <https://enstools.readthedocs.io>
    Ensemble-Compression <https://enstools-compression.readthedocs.io>

[1]Waves to Weather - Transregional Collaborative Research Project (SFB/TRR165) https://wavestoweather.de w2wlogo