API Reference¶
The collegeplan package is organized into the following modules:
| Module | Description |
|---|---|
| models | Domain dataclasses: Child, Assumptions, CostProfile, results |
| engine | Year-by-year projection functions |
| solver | Bisection solver for required savings |
| sensitivity | Grid sweep across assumption parameters |
| reporting | Dict and JSON serialization |
| cost_profiles | Built-in cost profile factories |
| glide_path | Age-based equity allocation and presets |
| allocation | Shared fund allocation policies |
| assumptions | Fisher equation and return normalization |
| validators | Input validation |
| exceptions | Custom exception hierarchy |