FAQ

Installation

Q: How do I install the package?

pip install sir-epidemic

Q: What Python version do I need?

Python 3.8 or higher.

Q: I get "ModuleNotFoundError: No module named 'sir_simulator'"

Run: pip install -e . from the project root.

Usage

Q: How do I run the Streamlit dashboard?

streamlit run src/sir_simulator/user_interface/app.py

Q: How do I save simulation results?

The CLI automatically saves to simulation_output.csv. In the dashboard, click "Download CSV".

Q: Can I import my own data?

Yes! For parameter optimization, you can upload a CSV with 'day' and 'cases' columns.

Troubleshooting

Q: UnicodeEncodeError on Windows?

The issue is fixed in v1.0.1. Update: pip install --upgrade sir-epidemic

Q: Tests are failing?

Make sure all dependencies are installed:

pip install -r requirements.txt

Q: Streamlit dashboard shows blank page?

Check the console for errors. Try running streamlit run src/sir_simulator/user_interface/app.py from the project root.

Features

Q: Can I use this for real epidemic data?

Yes! The parameter optimization module is designed to fit models to real-world data.

Q: What ML models are supported?

• Random Forest (default)
• XGBoost (if installed)

Q: Can I simulate different intervention strategies?

Yes! The scenario comparison module compares:

• Baseline (no intervention)
• Quarantine
• Vaccination
• Combined (quarantine + vaccination)

Contributing

Q: How can I contribute?

Check CONTRIBUTING.md

Q: How do I run tests locally?

python run_all_tests.py
python -m unittest discover tests/security

Q: How do I build the package locally?

python -m build

Security

Q: How do I report a security vulnerability?

Email: miladvf2014@gmail.com See SECURITY.md

---

Still have questions? Open an issue