Skip to content

ekiefl/pooltool

Repository files navigation

Project Status: Active – The project has reached a stable, usable state and is being actively developed. GitHub license Documentation Status GitHub Actions Workflow Status

GitHub stars GitHub forks GitHub commit activity

PyPI - Version PyPI - Python Version codecov

Discord

Description

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.

Installation

Installation instructions are hosted on ReadtheDocs.

Documentation

rtd

All learning resources are found on Read the Docs.

Quick links:

  1. Homepage
  2. Installation
  3. API Reference

Join the community

Discord

If you want to ask questions, get help, or contribute to the codebase, please join the Discord and introduce yourself.

If the Discord link is expired, please make an issue in this repo.

Contributing

See CONTRIBUTING.md.

Blog

I have blogged about many aspects of this project. Read the detailed account here.

Citation

If you use Pooltool in your research/project/product, please cite it.

DOI

For your convenience, here are some common citation file formats:

  • BibTeX: wget https://zenodo.org/records/13119651/export/bibtex -O pooltool.bib
  • Citation File Format: wget https://zenodo.org/records/13119651/export/cff -O pooltool.cff
  • DataCite XML: wget https://zenodo.org/records/13119651/export/datacite-xml -O pooltool.xml