Open
Conversation
geonnave
reviewed
Feb 12, 2026
Contributor
geonnave
left a comment
There was a problem hiding this comment.
Thanks for this PR!
Could you add a very basic README to each new example folder explaining:
- what it does
- how to run it (and specific dependencies to install, if applicable)
pyproject.toml
Outdated
| "pydotbot-utils >= 0.3.0", | ||
| "toml >= 0.10.2", | ||
| "pyyaml >= 6.0.3", | ||
| "scipy >= 1.17.0", |
Contributor
There was a problem hiding this comment.
Can we make these dependencies optional, since they are only used by the examples? (or, specify that a pip install pyyaml scipy is needed in a example-specific README)
Author
|
I've added a README for the two examples and removed optional dependencies from pyproject.toml. The dependencies are now mentioned in each of the example's README |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adding two examples for the PyDotBot.
1. Minimum naming game (with and without motion): From a list of potential words, a swarm of DotBots runs a distributed algorithm to agree on a single word using local communication.
2. Work and charge: A swarm of DotBots alternate moving between a work region to perform work and a charge region to recharge.