Installation¶

Reproducible local environment (recommended)¶

If you’re concerned about cross-platform differences (macOS/Windows/Linux), install into a fresh virtual environment.

python -m venv .venv

# Activate (macOS/Linux)
source .venv/bin/activate

# Activate (Windows PowerShell)
# .venv\Scripts\Activate.ps1

python -m pip install -U pip

# CLI + YAML + FRED fetch
python -m pip install -e ".[cli,fred]"

For development (tests + docs + plotting):

python -m pip install -e ".[dev,cli,fred,docs,plot]"

Install from source¶

pip install -e .

Optional: plotting dependencies¶

pip install -e ".[plot]"

Optional: CLI + YAML config support¶

The config-driven CLI (srvar validate, srvar run) requires PyYAML.

pip install -e ".[cli]"

Optional: FRED/ALFRED data access¶

pip install -e ".[fred]"

Install docs dependencies¶

pip install -e ".[docs]"

Build the docs locally¶

From the repository root:

sphinx-build -b html docs docs/_build/html