=========
``rgpot``
=========

:Author: `Rohit Goswami <https://rgoswami.me>`_

.. image:: ../../branding/logo/rgpot_logo.webp

Overview
--------

``rgpot`` provides a unified schema for interfacing potential servers across
languages using runtime interoperability. It combines a Rust core with C++
potentials exposed through a Cap'n Proto RPC layer, enabling language-agnostic
access to potential energy surface calculations.

.. code:: bash

    git clone https://github.com/OmniPotentRPC/rgpot.git
    cd rgpot && pixi shell
    meson setup bbdir -Dwith_tests=True --buildtype=debug
    meson compile -C bbdir && meson test -C bbdir

.. toctree::
   :maxdepth: 2
   :caption: Tutorials

   tutorials/quickstart

.. toctree::
   :maxdepth: 2
   :caption: How-To Guides

   howto/embedding
   howto/integration

.. toctree::
   :maxdepth: 2
   :caption: Reference

   reference/architecture
   api/index
   changelog

.. toctree::
   :maxdepth: 2
   :caption: Development

   contributing/index
   code_of_conduct

License
-------

MIT, however note that some of the potentials are adapted from eOn which is
under a BSD 3-Clause License.