diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..0282743 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,42 @@ +# Repository Guidelines + +## Project Structure & Module Organization + +- `*.py`: Standalone analysis/optimization scripts (run directly with Python). + - `kmin_effectiveness.py`: k-min vs effectiveness/fairness analysis; writes artifacts to `data/`. + - `fairness_optimization.py`, `analyze_visits.py`, `plot_sites.py`: additional analyses/plots. +- `prob/`: Problem statement and source dataset (e.g., `prob/MFP Regular Sites 2019.xlsx`). +- `latex-template/`: Report template and compilation assets. +- `data/` (generated): Output CSV/PNG artifacts produced by scripts. + +## Build, Test, and Development Commands + +This repo is script-driven (no package build step). + +- Run k-min analysis: `python3 kmin_effectiveness.py` + - Outputs: `data/kmin_effectiveness.png`, `data/kmin_effectiveness_data.csv`, `data/kmin_effectiveness_sites.csv` +- Run visit analysis: `python3 analyze_visits.py` (generates plots in the workspace) +- Run site map: `python3 plot_sites.py` +- Quick syntax check: `python3 -m py_compile kmin_effectiveness.py` + +Dependencies commonly used: `numpy`, `pandas`, `matplotlib`, plus Excel readers like `openpyxl`. + +## Coding Style & Naming Conventions + +- Python: 4-space indentation; keep scripts runnable as `python3