Skip to main content

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

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.

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

DOI pyOpenSci Peer-Reviewed

Gallery

Installation & Documentation

rtd

All resources are hosted at https://pooltool.readthedocs.io.

Quick links:

  1. 🛠️ Installation
  2. 📚 Examples
  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 the Contributing page in the documentation.

Blog

Many aspects of this project have been blogged about. Read the detailed account here.

Citation

If you use pooltool in your research/project/product, please cite the JOSS publication:

DOI

@article{Kiefl2024,
    doi = {10.21105/joss.07301},
    url = {https://doi.org/10.21105/joss.07301},
    year = {2024},
    publisher = {The Open Journal},
    volume = {9},
    number = {101},
    pages = {7301},
    author = {Evan Kiefl},
    title = {Pooltool: A Python package for realistic billiards simulation},
    journal = {Journal of Open Source Software}
}

Metadata

Release files for pooltool-billiards 0.6.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pooltool-billiards 0.6.0
File Size Uploaded
pooltool_billiards-0.6.0.tar.gz 31.5 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for pooltool-billiards 0.6.0
File Interpreter ABI Platform
pooltool_billiards-0.6.0-py3-none-any.whl Python 3 none any Details

Total release size: 63.1 MB

Release files / pooltool_billiards-0.6.0.tar.gz

Download URL pooltool_billiards-0.6.0.tar.gz
Size 31.5 MB
Tags Source
SHA-256 checksum
How to use checksums
1915bfabd429603da12de0d3d55a15bc4147859b4585376dd12f7239c631e3b0
BLAKE2b-256 checksum
How to use checksums
f837624c6803ed3e61a2fa79e113195efc8df63100fb551644361f60e708dcc2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.10.10 {"installer":{"name":"uv","version":"0.10.10","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / pooltool_billiards-0.6.0-py3-none-any.whl

Download URL pooltool_billiards-0.6.0-py3-none-any.whl
Size 31.6 MB
Tags Python 3
SHA-256 checksum
How to use checksums
c47a46aeeeac6eea645e5c1610211ce0f0ae350e4b77909b8dd55b66e77b3bd5
BLAKE2b-256 checksum
How to use checksums
7c14bf4fac0e16abf8245399a2d0e14444c717722299684f6e319a0117baf8d8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.10.10 {"installer":{"name":"uv","version":"0.10.10","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page