.. _sphx_glr_examples_neighbors:

Neighbor Lists
==============

Examples demonstrating efficient O(N) neighbor list construction using GPU-accelerated
cell list algorithms.

These examples show how to:

* Build neighbor lists for single and batched systems
* Use dense or sparse COO output formats
* Detect when neighbor lists need rebuilding
* Optimize performance with ``torch.compile``
* Integrate with molecular dynamics workflows



.. raw:: html

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

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates how to use the basic neighbor list functions in nvalchemiops on random systems. We&#x27;ll cover:">

.. only:: html

  .. image:: /examples/neighbors/images/thumb/sphx_glr_01_simple_neighbor_list_thumb.png
    :alt:

  :doc:`/examples/neighbors/01_simple_neighbor_list`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Simple Neighbor List Example</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates how to use the batch neighbor list functions in nvalchemiops with multiple molecular and crystalline systems. We&#x27;ll cover:">

.. only:: html

  .. image:: /examples/neighbors/images/thumb/sphx_glr_02_batch_neighbor_list_thumb.png
    :alt:

  :doc:`/examples/neighbors/02_batch_neighbor_list`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Batch Neighbor List Example</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates how to use rebuild detection functions in nvalchemiops to efficiently determine when neighbor lists need to be reconstructed during molecular dynamics simulations. We&#x27;ll cover:">

.. only:: html

  .. image:: /examples/neighbors/images/thumb/sphx_glr_03_rebuild_neighborlist_detection_thumb.png
    :alt:

  :doc:`/examples/neighbors/03_rebuild_neighborlist_detection`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Neighbor List Rebuild Detection Example</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates the significant performance benefits of using torch.compile with nvalchemiops neighbor list routines in a realistic molecular dynamics simulation. We&#x27;ll cover:">

.. only:: html

  .. image:: /examples/neighbors/images/thumb/sphx_glr_04_neighbors_list_torch_compile_performance_thumb.png
    :alt:

  :doc:`/examples/neighbors/04_neighbors_list_torch_compile_performance`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Torch.compile Performance Benefits Example</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates how to use the JAX neighbor list API in nvalchemiops for computing neighbor lists in periodic systems.">

.. only:: html

  .. image:: /examples/neighbors/images/thumb/sphx_glr_05_jax_neighbor_list_thumb.png
    :alt:

  :doc:`/examples/neighbors/05_jax_neighbor_list`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">JAX Neighbor List Example</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /examples/neighbors/01_simple_neighbor_list
   /examples/neighbors/02_batch_neighbor_list
   /examples/neighbors/03_rebuild_neighborlist_detection
   /examples/neighbors/04_neighbors_list_torch_compile_performance
   /examples/neighbors/05_jax_neighbor_list