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

Missing documentation #12

Open
leo-desbureaux-tellae opened this issue Jun 1, 2021 · 0 comments
Open

Missing documentation #12

leo-desbureaux-tellae opened this issue Jun 1, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@leo-desbureaux-tellae
Copy link
Contributor

Sections of Starling's documentation that are missing or incomplete

  • Understanding Starling: a section that explains the functioning of Starling, its different parts (SimulationModel, Environment, DynamicInput, Scheduler, etc) and how they interact. Ideas of subsections:

    • Global structure of a multi-agent simulator
    • Simulation model
    • Environment
    • Agent population
    • Agents
    • Scheduler
    • Dynamic input
    • Output factory
  • Creating your own models: a section that explains how to create your own model. The classes to create, the methods and attributes to implement, etc.

  • Algorithms: a section that describes the existing algorithms and explains the interface used for the integration of new algorithms.

@leo-desbureaux-tellae leo-desbureaux-tellae added the documentation Improvements or additions to documentation label Jun 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant