[PRE REVIEW]: Pooltool: A Python package for realistic billiards simulation

[editorialbot]

Submitting author: !--author-handle-->@ekiefl<!--end-author-handle-- (Evan Kiefl) Repository: https://github.com/ekiefl/pooltool Branch with paper.md (empty if default branch): Version: v0.4.1 Editor: !--editor-->@danielskatz<!--end-editor-- Reviewers: !--reviewers-list-->@danielskatz<!--end-reviewers-list-- Managing EiC: Daniel S. Katz

Status

Status badge code:

HTML: <a href="https://joss.theoj.org/papers/3dc82db4f7a284ff0cff22fcd926cbe5"><img src="https://joss.theoj.org/papers/3dc82db4f7a284ff0cff22fcd926cbe5/status.svg"></a>
Markdown: [![status](https://joss.theoj.org/papers/3dc82db4f7a284ff0cff22fcd926cbe5/status.svg)](https://joss.theoj.org/papers/3dc82db4f7a284ff0cff22fcd926cbe5)

Author instructions

Thanks for submitting your paper to JOSS @ekiefl. Currently, there isn't a JOSS editor assigned to your paper.

@ekiefl if you have any suggestions for potential reviewers then please mention them here in this thread (without tagging them with an @). You can search the list of people that have already agreed to review and may be suitable for this submission.

Editor instructions

The JOSS submission bot @editorialbot is here to help you find and assign reviewers and start the main review. To find out what @editorialbot can do for you type:

@editorialbot commands

[editorialbot]

Hello human, I'm @editorialbot, a robot that can help you with some common editorial tasks.

For a list of things I can do to help you, just type:

@editorialbot commands

For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:

@editorialbot generate pdf

[editorialbot]

Software report:

github.com/AlDanial/cloc v 1.90  T=0.27 s (881.0 files/s, 149582.3 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                         158           5075           4533          14611
SVG                             26              1              1          13056
TeX                              1             38              2            936
Markdown                        19            394              0            732
reStructuredText                11             59             69            191
YAML                             6             26             29            185
JSON                             8              2              0            140
TOML                             1             18             19            123
XML                              4              0              0             79
make                             2             10              8             42
CSS                              1              1              0             14
Oracle PL/SQL                    1              5              0              9
-------------------------------------------------------------------------------
SUM:                           238           5629           4661          30118
-------------------------------------------------------------------------------

Commit count by author:

  1735  Evan Kiefl
     5  Sergey Lukin
     3  TeXnicians
     2  Ido david
     2  unknown
     1  Chao

[editorialbot]

Paper file info:

📄 Wordcount for paper.md is 882

✅ The paper includes a Statement of need section

[editorialbot]

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

✅ OK DOIs

- 10.5281/zenodo.11642058 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: Design of an efficient multi-objective recognition...
- No DOI given, and none found for title: Automatic Snooker-playing Robot with Speech Recogn...
- No DOI given, and none found for title: Automating Skills Using a Robot Snooker Player
- No DOI given, and none found for title: Roboshark: A gantry pool player robot
- No DOI given, and none found for title: A fuzzy pool player robot with learning ability
- No DOI given, and none found for title: DX182739.pdf
- No DOI given, and none found for title: [No title]
- No DOI given, and none found for title: Spin Shots for a Robotic Billiard Player
- No DOI given, and none found for title: Learning Visual Predictive Models of Physics for P...
- No DOI given, and none found for title: Simulateur de billard réaliste
- No DOI given, and none found for title: Mathematical Theory of Spin, Friction, and Collisi...
- No DOI given, and none found for title: MiniPool: Real-time artificial player for an 8-Bal...
- No DOI given, and none found for title: Billiards: an optimization challenge
- No DOI given, and none found for title: A virtual billiard assistant
- No DOI given, and none found for title: FastFiz

❌ MISSING DOIs

- 10.12988/ces.2017.79116 may be a valid DOI for title: Billiard game parameters calculation using a depth...
- 10.1109/tocs56154.2022.10015948 may be a valid DOI for title: Visual aided training of billiards based on depth ...
- 10.1109/tocs56154.2022.10015948 may be a valid DOI for title: Visual aided training of billiards based on depth ...
- 10.1109/ssci44817.2019.9003085 may be a valid DOI for title: Toward Human-like Billiard AI Bot Based on Backwar...
- 10.1109/arso.2012.6213402 may be a valid DOI for title: Strategic play for a pool-playing robot
- 10.1109/tmech.2015.2461547 may be a valid DOI for title: Ball Positioning in Robotic Billiards: A Nonprehen...
- 10.1109/mc.2008.33 may be a valid DOI for title: Toward a Competitive Pool-Playing Robot
- 10.1007/s41095-016-0047-3 may be a valid DOI for title: Augmented reality system to assist inexperienced p...
- 10.1007/s41095-016-0047-3 may be a valid DOI for title: Augmented reality system to assist inexperienced p...
- 10.1109/ispan-fcst-iscc.2017.36 may be a valid DOI for title: Computer-Assisted Billiard Self-Training Using Int...
- 10.1016/j.artint.2007.04.011 may be a valid DOI for title: PickPocket: A computer billiards shark
- 10.1177/17298806221118865 may be a valid DOI for title: Intelligent Carom Billiards Assistive System for a...
- 10.1007/s10489-023-04542-3 may be a valid DOI for title: 3D reconstruction system and multiobject local tra...
- 10.3389/fpsyg.2021.691043 may be a valid DOI for title: Can a Good Break Shot Determine the Game Outcome i...
- 10.1137/1.9781611977172.13 may be a valid DOI for title: On Predicting and Generating a Good Break Shot in ...
- 10.1109/tciaig.2013.2284385 may be a valid DOI for title: A Heuristic-Based Planner and Improved Controller ...
- 10.1109/cig.2019.8848113 may be a valid DOI for title: Macro and Micro Reinforcement Learning for Playing...
- 10.1109/tciaig.2016.2549748 may be a valid DOI for title: A Distributed Agent for Computational Pool
- 10.1609/aimag.v31i4.2312 may be a valid DOI for title: Computational Pool: A New Challenge for Game Theor...
- 10.1007/s11071-021-07117-4 may be a valid DOI for title: Modelling multiple-simultaneous impact problems wi...
- 10.1243/09544062jmes1964 may be a valid DOI for title: A theoretical analysis of billiard ball dynamics u...
- 10.1007/bf02919180 may be a valid DOI for title: Dynamics in carom and three cushion billiards
- 10.1007/11922155_19 may be a valid DOI for title: An Event-Based Pool Physics Simulator

❌ INVALID DOIs

- None

[editorialbot]

License info:

✅ License found: Apache License 2.0 (Valid open source OSI approved license)

[editorialbot]

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

[editorialbot]

Five most similar historical JOSS papers:

Abmarl: Connecting Agent-Based Simulations with Multi-Agent Reinforcement Learning Submitting author: @rusu24edward Handling editor: @drvinceknight (Active) Reviewers: @seba-1511, @abhiramm7 Similarity score: 0.6862

The o80 C++ templated toolbox: Designing customized Python APIs for synchronizing realtime processes Submitting author: @vincentberenz Handling editor: @gkthiruvathukal (Active) Reviewers: @traversaro, @vissarion Similarity score: 0.6860

sbp-env: A Python Package for Sampling-based Motion Planner and Samplers Submitting author: @soraxas Handling editor: @danielskatz (Active) Reviewers: @KanishAnand, @OlgerSiebinga Similarity score: 0.6643

AgentPy: A package for agent-based modeling in Python Submitting author: @JoelForamitti Handling editor: @sbenthall (Active) Reviewers: @jamesdamillington, @martibosch Similarity score: 0.6518

SiSyPHE: A Python package for the Simulation of Systems of interacting mean-field Particles with High Efficiency Submitting author: @antoinediez Handling editor: @pdebuyl (Active) Reviewers: @lorenzo-rovigatti, @junghans Similarity score: 0.6514

⚠️ Note to editors: If these papers look like they might be a good match, click through to the review issue for that paper and invite one or more of the authors before considering asking the reviewers of these papers to review again for JOSS.

[danielskatz]

👋 @ekiefl - thanks for your submission. From the title, I was wondering if this was research software as defined by JOSS, but I think you make a solid case in the paper.

So I will next work on finding an editor.

I see you don't have an acknowledgments section, so I assume you don't have any funding or other activities you want to acknowledge?

In addition, you could work on the possibly missing DOIs that editorialbot suggests, but note that some may be incorrect. Please feel free to make changes to your .bib file, then use the command @editorialbot check references to check again, and the command @editorialbot generate pdf when the references are right to make a new PDF. editorialbot commands need to be the first entry in a new comment.

[danielskatz]

Actually, looking at our current editor load, I'll assign myself to be the editor for this one.

Please suggest ~5 potential reviewers. You can search the list of people that have already agreed to review and may be suitable for this submission. Or people who aren't in the JOSS system would also be ok. If you know their GitHub usernames, then please mention them here in this thread (without tagging them with an @).

[danielskatz]

@editorialbot assign me as editor

[editorialbot]

Assigned! @danielskatz is now the editor

[ekiefl]

Hi @danielskatz, it's very nice to meet you. Thanks for getting things up and running so quickly!

👋 @ekiefl - thanks for your submission. From the title, I was wondering if this was research software as defined by JOSS, but I think you make a solid case in the paper.

🎊

Actually, looking at our current editor load, I'll assign myself to be the editor for this one.

Nice, thanks for volunteering your time 🙏

I see you don't have an acknowledgments section, so I assume you don't have any funding or other activities you want to acknowledge?

That's right.

In addition, you could work on the possibly missing DOIs that editorialbot suggests, but note that some may be incorrect. Please feel free to make changes to your .bib file, then use the command @editorialbot check references to check again, and the command @editorialbot generate pdf when the references are right to make a new PDF. editorialbot commands need to be the first entry in a new comment.

Sounds good, I'll work on this.

@ekiefl if you have any suggestions for potential reviewers then please mention them here in this thread (without tagging them with an @)

My understanding was that projects accepted in pyOpenSci are processed differently during the JOSS review, although the details of how is what I'm not clear about. Given this, I just wanted to double check that you are aware that pooltool has been accepted in pyOpenSci (submission/review here: https://github.com/pyOpenSci/software-submission/issues/173). I'll wait to hear from you before I start looking for yet more reviewers.

[danielskatz]

Thanks for mentioning the pyOpenSci part - I missed that. Yes, then we don't need new reviewers and this will happen much more quickly...

[danielskatz]

Please do ping me when the DOIs are fixed, then we can move this along.

[ekiefl]

That sounds great, will do 🙂

[ekiefl]

@editorialbot check references

[editorialbot]

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

✅ OK DOIs

- 10.1109/SSCI44817.2019.9003085 is OK
- 10.1109/ARSO.2012.6213402 is OK
- 10.1109/TMECH.2015.2461547 is OK
- 10.1109/MC.2008.33 is OK
- 10.1007/s41095-016-0047-3 is OK
- 10.1016/j.artint.2007.04.011 is OK
- 10.1007/s10489-023-04542-3 is OK
- 10.48550/arXiv.1511.07404 is OK
- 10.34627/RCC.V12IESPECIAL.13 is OK
- 10.1109/CIG.2019.8848113 is OK
- 10.1109/TCIAIG.2016.2549748 is OK
- 10.1609/aimag.v31i4.2312 is OK
- 10.1007/11922155_19 is OK
- 10.5281/zenodo.11642058 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: Automatic Snooker-playing Robot with Speech Recogn...
- No DOI given, and none found for title: Automating Skills Using a Robot Snooker Player
- No DOI given, and none found for title: Roboshark: A gantry pool player robot

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None

[ekiefl]

@editorialbot generate pdf

[editorialbot]

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

[editorialbot]

Five most similar historical JOSS papers:

The o80 C++ templated toolbox: Designing customized Python APIs for synchronizing realtime processes Submitting author: @vincentberenz Handling editor: @gkthiruvathukal (Active) Reviewers: @traversaro, @vissarion Similarity score: 0.6902

Abmarl: Connecting Agent-Based Simulations with Multi-Agent Reinforcement Learning Submitting author: @rusu24edward Handling editor: @drvinceknight (Active) Reviewers: @seba-1511, @abhiramm7 Similarity score: 0.6812

sbp-env: A Python Package for Sampling-based Motion Planner and Samplers Submitting author: @soraxas Handling editor: @danielskatz (Active) Reviewers: @KanishAnand, @OlgerSiebinga Similarity score: 0.6636

AgentPy: A package for agent-based modeling in Python Submitting author: @JoelForamitti Handling editor: @sbenthall (Active) Reviewers: @jamesdamillington, @martibosch Similarity score: 0.6529

SiSyPHE: A Python package for the Simulation of Systems of interacting mean-field Particles with High Efficiency Submitting author: @antoinediez Handling editor: @pdebuyl (Active) Reviewers: @lorenzo-rovigatti, @junghans Similarity score: 0.6482

⚠️ Note to editors: If these papers look like they might be a good match, click through to the review issue for that paper and invite one or more of the authors before considering asking the reviewers of these papers to review again for JOSS.

[ekiefl]

@editorialbot check references

[ekiefl]

@editorialbot generate pdf

[editorialbot]

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

✅ OK DOIs

- 10.1109/ssci44817.2019.9003085 is OK
- 10.1109/arso.2012.6213402 is OK
- 10.1109/tmech.2015.2461547 is OK
- 10.1109/mc.2008.33 is OK
- 10.1007/s41095-016-0047-3 is OK
- 10.1016/j.artint.2007.04.011 is OK
- 10.1007/s10489-023-04542-3 is OK
- 10.48550/arxiv.1511.07404 is OK
- 10.34627/rcc.v12iespecial.13 is OK
- 10.1109/cig.2019.8848113 is OK
- 10.1109/tciaig.2016.2549748 is OK
- 10.1609/aimag.v31i4.2312 is OK
- 10.1007/11922155_19 is OK
- 10.5281/zenodo.11642058 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: Automatic Snooker-playing Robot with Speech Recogn...
- No DOI given, and none found for title: Automating Skills Using a Robot Snooker Player
- No DOI given, and none found for title: Roboshark: A gantry pool player robot

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None

[editorialbot]

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

[editorialbot]

Five most similar historical JOSS papers:

DynamicalBilliards.jl: An easy-to-use, modular and extendable Julia package for Dynamical Billiard systems in two dimensions. Submitting author: @Datseris Handling editor: @kyleniemeyer (Active) Reviewers: @ahwillia Similarity score: 0.6814

Abmarl: Connecting Agent-Based Simulations with Multi-Agent Reinforcement Learning Submitting author: @rusu24edward Handling editor: @drvinceknight (Active) Reviewers: @seba-1511, @abhiramm7 Similarity score: 0.6808

sbp-env: A Python Package for Sampling-based Motion Planner and Samplers Submitting author: @soraxas Handling editor: @danielskatz (Active) Reviewers: @KanishAnand, @OlgerSiebinga Similarity score: 0.6616

AgentPy: A package for agent-based modeling in Python Submitting author: @JoelForamitti Handling editor: @sbenthall (Active) Reviewers: @jamesdamillington, @martibosch Similarity score: 0.6450

OTTO: A Python package to simulate, solve and visualize the source-tracking POMDP Submitting author: @auroreloisy Handling editor: @VivianePons (Retired) Reviewers: @11michalis11, @RomainAzais Similarity score: 0.6403

⚠️ Note to editors: If these papers look like they might be a good match, click through to the review issue for that paper and invite one or more of the authors before considering asking the reviewers of these papers to review again for JOSS.

[ekiefl]

Hey @danielskatz, I've updated the references with DOIs and they are looking good in the PDF. Thanks for your patience, and please let me know of any next steps.

[danielskatz]

@editorialbot assign @danielskatz as reviewer

[editorialbot]

I'm sorry human, I don't understand that. You can see what commands I support by typing:

@editorialbot commands

[danielskatz]

@editorialbot add @danielskatz as reviewer

[editorialbot]

@danielskatz added to the reviewers list!

[danielskatz]

@editorialbot start review

[editorialbot]

OK, I've started the review over in https://github.com/openjournals/joss-reviews/issues/7301.