Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add setup tool #7

Open
eakirtas opened this issue Apr 26, 2020 · 0 comments
Open

Add setup tool #7

eakirtas opened this issue Apr 26, 2020 · 0 comments
Assignees
Labels
enhancement New feature or request tracker Used to track process of a project

Comments

@eakirtas
Copy link
Member

eakirtas commented Apr 26, 2020

General

Setup tools is a command line wizard in order to create new examples or easily use the existing ones.
Current structure is:

  • ./examples

    • ./examples/torch
    • ./examples/torch/
  • Every should have a description file.

    • Should be either on a markup language or simple text.
  • Every should have a requirement.txt

    • This should have only the imported libraries, anything else.

Interface design

Generally, the deepworlds setup tool is going to be like a common command line tool. Users will use it as an out-of-box wizard in order to create new worlds or use the existing ones.

Consequently, every might have different worlds or even different solutions (supervisor, agent, robots). It is essential that the deepworlds setup tool knows those different aspects of every problem. As result, every should have a formated string that can be interpreted by the setup tools. This string should be in JSON format or even in python dictionary.

  • Name
  • Path
  • Short description
  • Long Description
  • Requirements (or the path only)
  • Authors
    • Name
    • Email
    • (optional) Github Account
  • Webots version
  • Deebots version
  • Worlds
  • Supervisors-Robots (array or dice)
  • (optional) Framework which is used
    • Version of the framework
  • (optional) Future Work
  • (optional) Related papers
  • (optional) Other

This information should be easily accessible by the developers and also by the user. Developers should have the option to add those information when they are about to start a project. This could be happen with a command line wizard. On the other hand, user should have the option to "scroll" on those information in order to choose which fits better to they case. In addition, user should have the ability to start from a template world. This mean that in the deepworlds repository should be added also another directory named as templates

The difference between templates and examples is that templates provides only a basic code structure for a fresh project. Examples are complete solutions of problems.

@eakirtas eakirtas added tracker Used to track process of a project enhancement New feature or request labels Apr 26, 2020
@eakirtas eakirtas changed the title [tracker] Add setup tools Add setup tool Apr 26, 2020
@eakirtas eakirtas self-assigned this Apr 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request tracker Used to track process of a project
Projects
None yet
Development

No branches or pull requests

1 participant