Skip to content

Add run scripts and detailed how-to-run README section - #1

Merged
Kavin-Charles merged 1 commit into
mainfrom
feat/run-scripts-and-readme
Apr 24, 2026
Merged

Add run scripts and detailed how-to-run README section#1
Kavin-Charles merged 1 commit into
mainfrom
feat/run-scripts-and-readme

Conversation

@Kavin-Charles

Copy link
Copy Markdown
Owner
  • scripts/: cross-platform launchers (.bat + .sh) for setup, tests, CLI demo, capsize simulator, Streamlit UI, and full pipeline
  • scripts/capsize_demo.py: headless 3-scenario KCS capsize demo (free decay, resonant beam sea, rogue pulse)
  • README section 2: expanded "How to run" with prerequisites, install, sample regeneration, validation, CLI examples, Streamlit walkthrough, Python API snippet, troubleshooting, smoke test
  • README section 2.0: quick reference table pointing at scripts/

- scripts/: cross-platform launchers (.bat + .sh) for setup, tests,
  CLI demo, capsize simulator, Streamlit UI, and full pipeline
- scripts/capsize_demo.py: headless 3-scenario KCS capsize demo
  (free decay, resonant beam sea, rogue pulse)
- README section 2: expanded "How to run" with prerequisites,
  install, sample regeneration, validation, CLI examples, Streamlit
  walkthrough, Python API snippet, troubleshooting, smoke test
- README section 2.0: quick reference table pointing at scripts/

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@Kavin-Charles
Kavin-Charles merged commit cee744f into main Apr 24, 2026
2 checks passed
Kavin-Charles added a commit that referenced this pull request Apr 24, 2026
Add run scripts and detailed how-to-run README section
Kavin-Charles added a commit that referenced this pull request Apr 25, 2026
Add run scripts and detailed how-to-run README section
Kavin-Charles added a commit that referenced this pull request Apr 25, 2026
Add run scripts and detailed how-to-run README section
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