# Overview

Pooltool is a general **purpose billiards simulator** crafted specifically for science and engineering.

Its core design principles focus on speed, flexibility, and the ease of visualization and analysis. With an interactive 3D interface, a robust API, and extensive documentation, pooltool aims to be a **systemic tool in billiards-related research**. Continuously evolving through active maintenance and bolstered by a growing community, this vision for pooltool emphasizes not just its current capabilities, but also its potential for growth and adaptation within billiards simulation.

Pooltool is peer-reviewed and published in the **Journal of Open Source Software** (JOSS) and **pyOpenSci**.

[![DOI](https://joss.theoj.org/papers/10.21105/joss.07301/status.svg)](https://doi.org/10.21105/joss.07301)
[![pyOpenSci Peer-Reviewed](https://pyopensci.org/badges/peer-reviewed.svg)](https://github.com/pyOpenSci/software-review/issues/173)

```{eval-rst}
.. toctree::
   :caption: Home
   :hidden:
   :maxdepth: 1

   self
   GitHub <https://github.com/ekiefl/pooltool>
```

```{eval-rst}
.. toctree::
   :caption: Getting Started
   :hidden:
   :maxdepth: 1

   getting_started/install 
   getting_started/interface
   getting_started/hello_world
```

```{eval-rst}
.. toctree::
   :caption: Contents
   :hidden:
   :maxdepth: 3

   examples/index
   resources/index
```

```{eval-rst}
.. toctree::
   :caption: API Reference
   :hidden:
   :maxdepth: 1

   autoapi/pooltool/index
```

```{eval-rst}
.. toctree::
   :caption: Meta
   :hidden:
   :maxdepth: 1

   meta/contributing
   meta/license
   PyPI <https://pypi.org/project/pooltool-billiards/>
```