Installation

Requires Python 3.9 or higher.

Quick install

pip install energykit

With optional extras

# + LightGBM forecasting (recommended for best accuracy)
pip install "energykit[forecast]"

# + Everything (forecast, DER optimizer, dataset downloaders)
pip install "energykit[all]"

Install extras explained

Extra	What it adds	When to use
`energykit[forecast]`	LightGBM, statsmodels	Better load forecasting accuracy
`energykit[optimize]`	PuLP solver	Advanced DER dispatch
`energykit[datasets]`	requests, tqdm	Auto-download public datasets
`energykit[all]`	Everything above	Development / full feature set

Windows

python --version      # must be 3.9+
pip install energykit
python -c "import energykit; print(energykit.__version__)"

Using Anaconda:

conda create -n energykit-env python=3.11
conda activate energykit-env
pip install "energykit[all]"

macOS

pip3 install energykit
python3 -c "import energykit; print(energykit.__version__)"

Using Homebrew + pyenv:

brew install pyenv
pyenv install 3.11 && pyenv global 3.11
pip install "energykit[all]"

Linux

Ubuntu / Debian:

sudo apt update && sudo apt install python3.11 python3.11-venv python3-pip -y
python3.11 -m venv .venv && source .venv/bin/activate
pip install "energykit[all]"

RHEL / Fedora:

sudo dnf install python3.11 python3-pip -y
python3.11 -m venv .venv && source .venv/bin/activate
pip install "energykit[all]"