Skip to content

Adding DotBot examples#208

Open
genkimiyauchi wants to merge 7 commits intoDotBots:mainfrom
genkimiyauchi:develop-examples
Open

Adding DotBot examples#208
genkimiyauchi wants to merge 7 commits intoDotBots:mainfrom
genkimiyauchi:develop-examples

Conversation

@genkimiyauchi
Copy link

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.

Copy link
Contributor

@geonnave geonnave left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this PR!

Could you add a very basic README to each new example folder explaining:

  1. what it does
  2. 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",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

@genkimiyauchi
Copy link
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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants