Skip to content

Document MATLAB/Simulink dependency for CIF simulation#64

Merged
iahncajigas merged 2 commits intomainfrom
docs/matlab-simulink-readme
Mar 14, 2026
Merged

Document MATLAB/Simulink dependency for CIF simulation#64
iahncajigas merged 2 commits intomainfrom
docs/matlab-simulink-readme

Conversation

@iahncajigas
Copy link
Copy Markdown
Contributor

Summary

  • Add a new README section documenting the MATLAB/Simulink dependency for CIF.simulateCIF().
  • Explain the three backend flag options ('auto', 'matlab', 'python') and their behaviour.
  • Provide step-by-step setup instructions for the MATLAB Engine API for Python and NSTAT_MATLAB_PATH configuration.
  • Explain why the Simulink backend matters (continuous-time thinning vs discrete-time Bernoulli approximation).
  • Include a call for contributions to implement a pure-Python continuous-time thinning solver (Ogata's algorithm).

Test plan

  • Verify README renders correctly on GitHub
  • Confirm all links and code blocks are valid

🤖 Generated with Claude Code

Iahn Cajigas and others added 2 commits March 14, 2026 13:18
Add a new section explaining that CIF.simulateCIF() relies on Simulink
models for exact point-process simulation, with a native Python Bernoulli
fallback for approximate results. Documents the backend flag ('auto',
'matlab', 'python'), step-by-step MATLAB Engine setup instructions, and
a call for contributions to implement a pure-Python thinning solver.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Remove non-existent pages.yml badge (workflow doesn't exist)
- Fix 5 GitHub Pages URLs to match deployed site structure (help/*)
- Fix parity report link: parity/parity_report.md -> parity/report.md

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@iahncajigas iahncajigas merged commit 5883622 into main Mar 14, 2026
13 checks passed
@iahncajigas iahncajigas deleted the docs/matlab-simulink-readme branch March 14, 2026 22:22
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.

1 participant