Documentation¶
This folder is the canonical documentation hub for the repository.
Start here¶
- Getting started — install, orient, and begin the first learning unit
- Overview — a quick-read snapshot of what the repo actually contains, coverage, and gaps
- Mastery guide — learn interactively with
/pmexpertinstead of picking notebooks by hand - Learning paths — choose a route by goal or time horizon
- Rates, credit, and mortgages: zero to hero — a fully sequenced fixed-income path with a reference page, notebook, and verified resources at every step
- Roadmap — long-term curriculum and milestones
- Architecture — repository structure and design intent
- Workflow — branch, checkpoint, PR, and merge discipline
- Progress — current status, milestones, and module completion
Repository map¶
curriculum/— structured learning tracks and bootcampsreference/— durable PM/FICC concept and instrument reference pagesnotebooks/— hands-on learning labs and worked examplessrc/pm/— reusable deterministic analytics librarytests/— correctness checks for formulas and implementationsuse_cases/— realistic PM workflows built from multiple conceptsagents/— agent operating instructions and workflowstutors/— tutor prompts and learning supportresources/— curated external references
Principles¶
- Read before coding
- Do manual derivations before agent help
- Prefer deterministic formulas over API-driven complexity
- Keep reusable logic in
src/pm/ - Preserve notebooks as teaching artifacts
- Test the math, then explain it clearly
Recommended path¶
- Read getting started
- Choose a learning path in learning paths
- Open the matching notebook
- Review the concept page in
reference/ - Implement and test reusable logic in
src/pm/ - Update progress in PROGRESS
Or skip steps 2–4 and let /pmexpert pick the next concept for you — see
the mastery guide.