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 instructions are hosted on ReadtheDocs.
![rtd](https://private-user-images.githubusercontent.com/8688665/314619007-744fcd33-2e6a-4b8d-a727-634bb8295124.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjM5NjI4NTEsIm5iZiI6MTcyMzk2MjU1MSwicGF0aCI6Ii84Njg4NjY1LzMxNDYxOTAwNy03NDRmY2QzMy0yZTZhLTRiOGQtYTcyNy02MzRiYjgyOTUxMjQucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI0MDgxOCUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNDA4MThUMDYyOTExWiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9NzM5NTg2NjU4MDYwNDAyZWMyZTQ1MDEyYTM0YTI3MjkwNTExN2RhODYxNGVkZmUxMDVjZTEzNjg4MDhhZjU1YiZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QmYWN0b3JfaWQ9MCZrZXlfaWQ9MCZyZXBvX2lkPTAifQ.vKojBHg5t1Tx0p81QVOmzTMTJNbeVv1j-esFocCk_Xo)
All learning resources are found on Read the Docs.
Quick links:
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.
See CONTRIBUTING.md.
I have blogged about many aspects of this project. Read the detailed account here.
If you use Pooltool in your research/project/product, please cite it.
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