A pipeline for research-driven, personalized curricula using Perplexity and OpenRouter.
See Environment: ./environment.md. Then run:
uv sync --all-extras --dev
uv run start-gate fast
See Getting Started: ./getting_started.md and Pipeline: ./pipeline.md.
Research in data/audience_research/ and data/domain_research/; curricula in data/written_curriculums/; visuals in data/visualizations/; translations in data/translated_curriculums/. See Data & Outputs for directory purposes and artifact descriptions.
Run ./run_docs.sh --serve (local) or visit GitHub Pages at the project site.
See Contributing: ./CONTRIBUTING.md.
See Examples: ./examples.md and tests in tests/.
Required: PERPLEXITY_API_KEY and OPENROUTER_API_KEY. Optional: OPENAI_API_KEY. Copy .env.example to .env and fill in values.
No external provider calls run by default. Provider behavior is exercised with local HTTP servers; live connectivity requires credentials and an explicit probe invocation. See Testing.
Use ./run_docs.sh --serve. Ensure mkdocs.yml exists at repo root. The
script runs MkDocs through the locked project environment with uv.
Run uv run start-curriculum --non-interactive --stages visualizations --json. If running headless (servers/CI), set MPLBACKEND=Agg.
Use the module entrypoints from the repository root; numbered scripts remain available for staged workflows.