:orphan:

.. sample-data:

Sample Data
===========

Xugrid provides some sample data and ways of generating synthetic data through
the :mod:`xugrid.data` module.

Where are my data files?
------------------------

The sample data files are downloaded automatically by :mod:`pooch` the first
time you load them. The files are saved to the default cache location on your
operating system. The location varies depending on your system and
configuration. We provide the :func:`xugrid.data.locate` function if you
need to find the data storage location on your system.

You can change the base data directory by setting the ``XUGRID_DATA_DIR``
environment variable to the desired path.

Available datasets
------------------

These are the datasets currently available:



.. raw:: html

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

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This is a small vector dataset containing polygons of the provinces of the Netherlands, including water, presented as geopandas GeoDataFrame.">

.. only:: html

  .. image:: /sample_data/images/thumb/sphx_glr_provinces_nl_thumb.png
    :alt:

  :doc:`/sample_data/provinces_nl`

.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This is a small unstructured grid consisting of two unconnected parts. This is downloaded via xugrid.data.xoxo(). The topology data is downloaded to a local directory if it&#x27;s not there already.">

.. only:: html

  .. image:: /sample_data/images/thumb/sphx_glr_xoxo_thumb.png
    :alt:

  :doc:`/sample_data/xoxo`

.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This is a small dataset containing a triangulation of a digital elevation model of the Netherlands.">

.. only:: html

  .. image:: /sample_data/images/thumb/sphx_glr_elevation_nl_thumb.png
    :alt:

  :doc:`/sample_data/elevation_nl`

.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This is small dataset containing the output of a hydraulic simulation.">

.. only:: html

  .. image:: /sample_data/images/thumb/sphx_glr_adh_san_diego_thumb.png
    :alt:

  :doc:`/sample_data/adh_san_diego`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">ADH San Diego</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This is a small synthetic unstructured XugridDataset with topology in the shape of a disk. It contains data on the nodes, faces, and edges.">

.. only:: html

  .. image:: /sample_data/images/thumb/sphx_glr_disk_thumb.png
    :alt:

  :doc:`/sample_data/disk`

.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This is small dataset containing elevation points, cross-section profiles and center lines for a small stream network.">

.. only:: html

  .. image:: /sample_data/images/thumb/sphx_glr_network_thumb.png
    :alt:

  :doc:`/sample_data/network`

.. raw:: html

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


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /sample_data/provinces_nl
   /sample_data/xoxo
   /sample_data/elevation_nl
   /sample_data/adh_san_diego
   /sample_data/disk
   /sample_data/network



.. only:: html

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

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