Skip to content

Rework POSIM documentation, installation routes and simulation behavior - #54

Merged
woensug-choi merged 36 commits into
mainfrom
audit/posim-docs-and-runtime
Nov 4, 2026
Merged

woensug-choi merged 36 commits into
mainfrom
audit/posim-docs-and-runtime

Conversation

@woensug-choi

@woensug-choi woensug-choi commented Nov 4, 2026 •

Copy link
Copy Markdown
Contributor

POSIM users can choose an operating-system setup, run a graphical simulation, then follow focused guides for sensor data, robot control and custom experiments. POSIM is presented as the complete open-source maritime robotics simulation library.

Documentation and distribution changes:

  • Separate Ubuntu native, Linux Docker, Windows WSL native, Windows WSL Docker and macOS Docker/RDP guides. Explain terminal A/B and workspace setup before the first exercise; end installation with the ocean demo.
  • Move the source-directory table into Features, remove the separate related-libraries chapter, and explain WWW-POSIM only as an application built with POSIM. Embed its introduction video and preserve moved page/section bookmarks.
  • Split control, observation and advanced tutorials; keep plugin quickstarts, SDF and parameter tables near the top. Add world, sensor and robot creation exercises with measurable results.
  • Add full-text section search, highlighted code, overlay copy buttons, larger navigation groups and video buffering/error/retry feedback.
  • Publish architecture images under source-revision tags and promote a complete AMD64/ARM64 manifest to latest only after both builds succeed. PR builds do not publish. Runtime images exclude website sources; unused POSIM runner images expire after two days.

Runtime corrections include sonar build/install/logging/timestamp/teardown fixes; GNSS, DVL, current/coordinate, USBL and pressure validation; camera timestamp pairing and reset handling; REXROV inertia; ArduSub dependency loading; and surface launch readiness failures. The surface image starts its RDP services as root and runs the desktop session under its regular account.

Validation completed:

  • All 23 packages build. The full registered suite reports 342 results across 15 packages with no failures, errors or skips; subsequent runtime fixes have targeted checks. All 81 sensor cases pass.
  • The English/Korean website builds 74 pages and checks 7,393 local links/anchors. All 9 Playwright tests pass, covering desktop/mobile layout, themes, copying, search, language selection, bookmark redirects and video playback/retry. Screenshots were reviewed.
  • World pressure, IMU rates, Python subscription and neutral-thrust shutdown, custom-model creation, BlueROV2/MAVROS connectivity and documented sensor examples have runtime checks. A fresh Ubuntu 26.04 WSL environment completes the dependency installer.

Still in progress in this draft:

  • Full documentation and interface localization into English, Korean, Spanish, French, German, Italian, Japanese and Chinese, using established robotics terminology.
  • Current main image publication and OS-specific image/GUI checks. ARM64 publication has completed; AMD64 and the combined latest manifest are still running.
  • QGroundControl connection and control verification. The WSL simulation connects and supplies vehicle state/location; only fully tested usage will be documented.

Related work: #52 is incorporated with authorship retained. #53 remains a separate optional MAVROS overlay. Internal receipts and temporary verification harnesses are ignored and excluded from this PR.

@woensug-choi woensug-choi changed the title Audit POSIM workflows and improve bilingual documentation Improve POSIM guides and simulation behavior Nov 4, 2026
@woensug-choi
woensug-choi force-pushed the audit/posim-docs-and-runtime branch from b4b4af5 to 9324f19 Compare November 4, 2026 04:40
@woensug-choi
woensug-choi marked this pull request as ready for review November 4, 2026 08:54
@woensug-choi
woensug-choi marked this pull request as draft November 4, 2026 13:42
@woensug-choi woensug-choi changed the title Improve POSIM guides and simulation behavior Improve POSIM learning paths, plugin references and simulation behavior Nov 4, 2026
@woensug-choi
woensug-choi marked this pull request as ready for review November 4, 2026 17:09
@woensug-choi
woensug-choi merged commit 4d2e347 into main Nov 4, 2026
5 checks passed
@woensug-choi woensug-choi changed the title Improve POSIM learning paths, plugin references and simulation behavior Rework POSIM documentation, installation routes and simulation behavior Nov 4, 2026
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