:orphan:

Example Gallery
===============

This gallery of examples shows a variety of relatively small snippets or
examples of tasks that can be done with the ``zcollection`` package.


.. raw:: html

  <div id='sg-tag-list' class='sphx-glr-tag-list'></div>


.. raw:: html

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

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Builds a float32 dataset on a LocalStore, partitions it, reopens the collection from disk, queries with a filter, and asserts bit-exact equality.">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_ex_walkthrough_thumb.png
    :alt:

  :doc:`/auto_examples/ex_walkthrough`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">End-to-end Walkthrough</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Builds a dataset with nested Zarr groups (``/data_01/ku/...``), persists it through a partitioned :py~zcollection.Collection, and demonstrates the path-based access, dimension inheritance, and the size-aware multi-line __repr__.">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_ex_groups_thumb.png
    :alt:

  :doc:`/auto_examples/ex_groups`

.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="A :py~zcollection.view.View overlays extra variables on top of a read-only base :py~zcollection.Collection. The base data is queried through the view as if it were a single dataset, but the view&#x27;s variables live under its own store and only the view-owned variables are writable.">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_ex_view_thumb.png
    :alt:

  :doc:`/auto_examples/ex_view`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Overview of a View</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="A secondary index lets you find which partitions and row-slices satisfy a key-based query without scanning the whole collection. v3 indices are a single Parquet table with (&lt;key cols...&gt;, _partition, _start, _stop) rows, built by walking the collection with :py:meth:`Indexer.build&lt;zcollection.indexing.Indexer.build&gt;`.">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_ex_indexing_thumb.png
    :alt:

  :doc:`/auto_examples/ex_indexing`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Indexing a Collection</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This section walks through the main features of a v3 :py~zcollection.Collection: building a schema, creating a partitioned collection on a store, inserting data, querying with filters, and updating variables in place.">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_ex_collection_thumb.png
    :alt:

  :doc:`/auto_examples/ex_collection`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Overview of a Collection</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="A pedagogic, end-to-end script that ingests one or more NetCDF granules (here: SWOT nadir altimetry products) into a partitioned :py~zcollection.Collection and maintains a half-orbit Parquet :py~zcollection.indexing.Indexer on top of it.">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_ex_netcdf_to_zcollection_thumb.png
    :alt:

  :doc:`/auto_examples/ex_netcdf_to_zcollection`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Convert NetCDF granules to a ZCollection</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/ex_walkthrough
   /auto_examples/ex_groups
   /auto_examples/ex_view
   /auto_examples/ex_indexing
   /auto_examples/ex_collection
   /auto_examples/ex_netcdf_to_zcollection


.. 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: auto_examples_python.zip </auto_examples/auto_examples_python.zip>`

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

      :download:`Download all examples in Jupyter notebooks: auto_examples_jupyter.zip </auto_examples/auto_examples_jupyter.zip>`


.. only:: html

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

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