generated from coulomb/repo-seed
Update README.md
This commit is contained in:
27
README.md
27
README.md
@@ -1,3 +1,26 @@
|
|||||||
# repo-seed
|
# PolyCode Simulator (v0.1)
|
||||||
|
|
||||||
A git repository template to bootstrap coulomb projects from.
|
## Quickstart
|
||||||
|
|
||||||
|
1) Run a single demo simulation:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python simulator.py
|
||||||
|
```
|
||||||
|
|
||||||
|
2) Run a tiny parameter sweep (edit ranges inside `experiments.py` for deeper runs):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python experiments.py
|
||||||
|
```
|
||||||
|
|
||||||
|
Outputs are written to `./runs/`.
|
||||||
|
|
||||||
|
## Files
|
||||||
|
|
||||||
|
- `spec.md` — rigorous protocol description (this repo)
|
||||||
|
- `README.md` — quickstart
|
||||||
|
- `simulator.py` — core engine + one‑run demo
|
||||||
|
- `strategies.py` — pluggable investor/voter strategies
|
||||||
|
- `experiments.py` — grid sweeps and KPI aggregation
|
||||||
|
- `params_default.json` — baseline parameters
|
||||||
|
|||||||
Reference in New Issue
Block a user