Examples for the ParquetDB package
==========================================

Welcome to the ParquetDB examples! This collection of notebooks demonstrates various use cases and practical applications of ParquetDB, a lightweight database system built on Apache Parquet files.

These examples are automatically generated from the `examples
directory`_ of the package and showcase how to effectively use ParquetDB's features for data storage, querying, and management. Feel free to download and run these notebooks to explore the functionality firsthand.

.. _examples directory: https://github.com/lllangWV/ParquetDB/tree/main/examples/notebooks
.. _benchmarks directory: https://github.com/lllangWV/ParquetDB/tree/main/examples/notebooks/benchmarks
.. _graphdb directory: https://github.com/lllangWV/ParquetDB/tree/main/examples/graphdb

.. nblinkgallery::
    :caption: Example Gallery
    :name: rst-link-gallery

    notebooks/Example 1 - 3D Alexandria Database
    notebooks/Example 2 - 3D Alexandria Advanced
    notebooks/Example 3 - Jarvis-dft_3d
    notebooks/Example 4 - Jarvis-dft_pbe_2d

.. nblinkgallery::
    :caption: Benchmark Gallery
    :name: rst-benchmark-gallery

    benchmarks/Needle-in-Haystack Benchmark
    benchmarks/Input Update Benchmark
    benchmarks/Create and Read Benchmark
    benchmarks/Update Into Constant Rows Benchmark
    benchmarks/Full DB Updates Benchmark
    benchmarks/Small Benchmark


.. nblinkgallery::
    :caption: GraphDB Gallery
    :name: rst-graphdb-gallery

    graphdb/01 - Managing Graphs in ParquetGraphDB
    graphdb/02 - Graph Generators in ParquetGraphDB



Contents
--------

.. toctree::
   :maxdepth: 2
   :caption: Example Gallery

   notebooks/Example 1 - 3D Alexandria Database
   notebooks/Example 2 - 3D Alexandria Advanced
   notebooks/Example 3 - Jarvis-dft_3d
   notebooks/Example 4 - Jarvis-dft_pbe_2d

.. toctree::
   :maxdepth: 2
   :caption: Benchmark Gallery

   benchmarks/Needle-in-Haystack Benchmark
   benchmarks/Input Update Benchmark
   benchmarks/Create and Read Benchmark
   benchmarks/Update Into Constant Rows Benchmark
   benchmarks/Full DB Updates Benchmark
   benchmarks/Small Benchmark

.. toctree::
   :maxdepth: 2
   :caption: GraphDB Gallery

    graphdb/01 - Managing Graphs in ParquetGraphDB
    graphdb/02 - Graph Generators in ParquetGraphDB