Installation

Requirements

Python >= 3.9
NumPy >= 1.24.0
Pandas >= 2.0.0
SciPy >= 1.11.0
Matplotlib >= 3.7.0
Rich >= 14.2.0

From PyPI

Install the package using pip:

pip install election-forecasting

Or with uv (recommended):

uv pip install election-forecasting

From Source

Clone the repository and install in development mode:

git clone https://github.com/cmaloney111/election-forecasting-am215.git
cd election-forecasting
uv pip install -e .

Development Installation

For development, install with test and documentation dependencies:

uv pip install -e .
uv sync --all-extras

Verify Installation

Test that the installation worked:

election-forecast --help

Docker Installation

Run the forecasting models using Docker (no local Python installation required):

# Build the image
docker build -t election-forecasting .

# Run with default settings
docker run -v $(pwd)/predictions:/app/predictions \
           -v $(pwd)/metrics:/app/metrics \
           election-forecasting

# Run with custom options
docker run -v $(pwd)/predictions:/app/predictions \
           -v $(pwd)/metrics:/app/metrics \
           election-forecasting election-forecast --dates 8 --parallel 4

The Docker container includes all dependencies and data files. Volume mounts ensure results are saved to your host machine.