Skip to main content

A sandbox billiards game that emphasizes realistic physics.

Project description

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}
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pooltool_billiards-0.6.0.tar.gz (31.5 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pooltool_billiards-0.6.0-py3-none-any.whl (31.6 MB view details)

Uploaded Python 3

File details

Details for the file pooltool_billiards-0.6.0.tar.gz.

File metadata

  • Download URL: pooltool_billiards-0.6.0.tar.gz
  • Upload date:
  • Size: 31.5 MB
  • Tags: Source
  • Uploaded using 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}

File hashes

Hashes for pooltool_billiards-0.6.0.tar.gz
Algorithm Hash digest
SHA256 1915bfabd429603da12de0d3d55a15bc4147859b4585376dd12f7239c631e3b0
MD5 3603ec09ef3104c27d70ab646b26485b
BLAKE2b-256 f837624c6803ed3e61a2fa79e113195efc8df63100fb551644361f60e708dcc2

See more details on using hashes here.

File details

Details for the file pooltool_billiards-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: pooltool_billiards-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 31.6 MB
  • Tags: Python 3
  • Uploaded using 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}

File hashes

Hashes for pooltool_billiards-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c47a46aeeeac6eea645e5c1610211ce0f0ae350e4b77909b8dd55b66e77b3bd5
MD5 d80137cbc3694fe50b7ceed2a195fbef
BLAKE2b-256 7c14bf4fac0e16abf8245399a2d0e14444c717722299684f6e319a0117baf8d8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page