.. dompap documentation master file, created by
   sphinx-quickstart on Mon Feb  5 17:24:14 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

####################
dompap Documentation
####################

The dompap package focuses on simulations of point-like particles in any dimension with any pair potential.
The package uses NumPy and Numba for efficient calculations and SymPy to implement any pair potentials.
The user is not expected to be familiar with these packages but only basic Python syntax.

Quick Start
===========

.. toctree::
   :caption: Contents
   :maxdepth: 2

   quick_start

Tutorials
=========

.. toctree::
   :caption: Contents
   :maxdepth: 2

   tutorial
   examples

API
===

.. toctree::
   :caption: Contents
   :maxdepth: 2

   api


Indices and tables
==================

* :ref:`genindex`
* :ref:`search`