Repository navigation
docs: 📝 Add section 1.2 about running a simulation and the tests - #224
Conversation
Part of ShisatoYano#199: a short, practical page for chapter 1 covering how to run a simulation from the repository root, what the show_plot flag does, how --save-gif writes the animation of the simulations that define a GIF output, and how run_test_suites.sh checks the environment.
|
Thank you, @Goldloli, for writing the first section of Chapter 1! The page is short and practical, as the issue asked: one command to run, what the window and the terminal show, the I checked the facts against the code: all 43 simulation scripts have Small requests before merging:
Minor: "the unit tests run the same computation as the animation" could say "the tests", since most of them are smoke tests that run 🤖 Generated with Claude Code |
|
Thanks for the detailed review. All four points are addressed in |
|
Thanks for the quick update! All four points from the last review are addressed:
I also built the book with 🤖 Generated with Claude Code |
Part of #199 (section 1.2).
What this adds
A new page
doc/getting_started/running_simulations.md, linked from the chapter page, covering the three points the issue lists for this section:src/simulations/, run from the repository root (example: the EKF localization simulation), with what the window and the terminal output show.--save-gif: which simulations write a GIF (about half of them define a GIF output), where the file goes (the simulation's own folder), and that these GIF files are the ones the gallery shows. Example with the Hybrid A* planner.show_plotand the tests: each script keeps its animation behind ashow_plotflag, the tests call eachmain()with the flag off, and. run_test_suites.sh(pytest overtest/) confirms the environment is complete.It follows the writing guide: a search-oriented first sentence, one page per section, no theory layer (the page links to Chapter 2 for the simulator itself). The chapter page's note now says the chapter is being written, and section 1.2 links to the new page, so it is nested under the chapter in the sidebar.
Verification
Section 1.2 was claimed in #199.