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

Clarify train sim v3 documentation #205

Open
6 of 20 tasks
Castavo opened this issue Jun 3, 2024 · 0 comments
Open
6 of 20 tasks

Clarify train sim v3 documentation #205

Castavo opened this issue Jun 3, 2024 · 0 comments
Assignees

Comments

@Castavo
Copy link
Contributor

Castavo commented Jun 3, 2024

Already work in progress in #168

Things to improve:

  • add non goals
  • better goals
  • prioritize goals
  • translate diagrams from the slideshow to english, add these here
  • explain how driver behavior modules work exactly
  • give examples of driving instruction sequences for each kind of constraint
  • describe what APIs driver behavior modules need to simulate samples
  • give high level APIs for driver behavior modules and driving instructions
  • give examples of corner cases for driver behavior modules, especially for the "reconciliation step"
  • describe the exact external FFI api, and its differences from the rust library API
  • add a short description of concepts, actors and who does what
  • list parameters present in a train state
  • challenge the assumptions which would allow "combining constraining parameters" (step of the driver behaviour module process)
  • enrich design specifications in _index.en.md
  • the distinction between abstract and concrete driving instructions could be removed
  • Think a bit harder about how the "slowdown coefficient" would be updated (describe how driver behavior modules would use the slowdown coefficient to monotonically generate decisions)
  • Also think a bit harder about the loop over steps

Acceptance criteria

  • Design decisions are properly justified
  • Examples are given on corner cases
  • Overall understandable by a newcomer (maybe upgrade objective to "a newcomer could implement it" ?)
@Castavo Castavo changed the title Add train sim v3 documentation Clarify train sim v3 documentation Jun 5, 2024
@Castavo Castavo self-assigned this Jun 5, 2024
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

No branches or pull requests

1 participant