API reference

The reference is generated from type annotations and docstrings in src/vic3_analysis. All package-level exports are documented exactly once and grouped by workflow.

The data dictionary is the column reference for the tables returned by these APIs.

• Parsing and utilities — locate game data and construct tables.
• Economy and production — matrices, states, prices, and reports.
• Optimization — scenario definitions and the nominal solver.
• Supply chains — graphs, attribution, bottlenecks, and comparison.

If you are learning the package, begin with Getting started or the task-focused guides.