docs(publish): curate repository and add GitHub Pages report

Author: m0wer

.github/workflows/pages.yml

@@ -0,0 +1,56 @@
+name: Publish Pages
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install package
+        run: pip install -e .
+
+      - name: Build curated docs
+        run: |
+          PYTHONPATH=src python -m coinjoin_simulator.publish_site \
+            --mitigation mitigation_experiments.json \
+            --longrun longrun_policy_results.json \
+            --daily daily_cost_study_results.json \
+            --output docs/index.html \
+            --data-output docs/publish_summary.json
+
+      - name: Upload pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -0,0 +1,35 @@
+# Python
+__pycache__/
+*.py[cod]
+*.so
+
+# Virtual environments
+.venv/
+venv/
+
+# Tool caches
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/
+
+# Local scratch space
+tmp/*
+!tmp/.gitkeep
+
+# Generated reports not kept for publish
+daily_cost_report.html
+longrun_policy_report.html
+network_report.html
+report.html
+
+# Extra experiment dumps not kept for publish
+extreme_attack_recovery_results.json
+followup_strategy_experiments.json
+merge_sustainability_results.json
+network_experiments_grid.json
+network_sweep_default.json
+
+# OS/editor noise
+.DS_Store
+.idea/
+.vscode/

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,95 @@
+# CoinJoin Simulator
+
+Compact simulation toolkit for analyzing CoinJoin privacy under probing and adversarial taker pressure.
+
+This repository is curated for publishing: it keeps the key datasets, a focused GitHub Pages report, and the core simulation code.
+
+## What This Repository Shows
+
+The published report focuses on four high-signal views:
+
+1. Mitigation impact at fixed CoinJoin size (8 makers/CJ)
+2. Long-run sustained attack outcomes (baseline vs recommended policy)
+3. Probe-intensity privacy/cost trade-off
+4. Attack-to-recovery timeline
+
+Published output:
+
+- `docs/index.html`
+- `docs/publish_summary.json`
+
+## Quick Start
+
+```bash
+pip install -e ".[dev]"
+```
+
+Requires Python 3.11+.
+
+Generate the curated publish page from the tracked datasets:
+
+```bash
+PYTHONPATH=src python -m coinjoin_simulator.publish_site \
+  --mitigation mitigation_experiments.json \
+  --longrun longrun_policy_results.json \
+  --daily daily_cost_study_results.json \
+  --output docs/index.html \
+  --data-output docs/publish_summary.json
+```
+
+You can also run it through the CLI:
+
+```bash
+PYTHONPATH=src python -m coinjoin_simulator publish-site
+```
+
+## Reproduce Input Datasets
+
+These scripts regenerate the three datasets consumed by the publish page:
+
+- `run_mitigation_experiments.py` -> `mitigation_experiments.json`
+- `run_longrun_policy_study.py` -> `longrun_policy_results.json`
+- `run_daily_cost_study.py` -> `daily_cost_study_results.json`
+
+Note: these studies sample from the live JoinMarket orderbook URL configured in `src/coinjoin_simulator/network.py`.
+
+## Core CLI Commands
+
+```bash
+# list built-in scenarios
+coinjoin-sim list
+
+# run one scenario
+coinjoin-sim run --scenario naive_baseline
+
+# run all scenarios
+coinjoin-sim benchmark
+
+# run realistic network sweep
+coinjoin-sim network --makers 100 --rounds 1000 --evil-fractions 0.0,0.2,0.4,0.6
+```
+
+## Repository Layout
+
+```text
+src/coinjoin_simulator/
+  network.py         realistic maker/probing simulator
+  publish.py         curated metric extraction
+  publish_site.py    GitHub Pages report generation
+  ...                core anonymity/sybil/role/surveillance modules
+
+tests/               unit tests
+docs/                publish-ready report assets for GitHub Pages
+```
+
+## Development Checks
+
+```bash
+PYTHONPATH=src ruff check .
+PYTHONPATH=src mypy src/
+PYTHONPATH=src pytest
+```
+
+## License
+
+MIT