Getting Started

Pick a tool and follow the steps to get a working application on your machine.

Prerequisites

  • Node.js 18+: For the API and Explorer frontend
  • Python 3.9+: For the Generator
  • DuckDB: Installed automatically via Node package
1

Fork and clone

git clone https://github.com/aidotse/energy-toolkit-demand.git
cd energy-toolkit-demand
npm install
2

Configure

Edit config.yaml to define your scenarios, geographies, segments, and parameters. This single file drives the entire stack.

scenarios:
  - id: base
    name: Base Scenario
    description: Reference projection

geographies:
  - id: total
    name: National Total

segments:
  - id: residential
    name: Residential
  - id: industry
    name: Industry
3

Generate data

Run the Generator to create forecast data. Use the included Jupyter notebook or build your own pipeline.

cd generator
pip install -r requirements.txt
jupyter notebook notebooks/example.ipynb
4

Build and serve

Generate the static API endpoints, start the API server, and launch the Explorer.

# Build static endpoints
cd api && node generate-api.js --defaults

# Start API server (port 4010)
npm start

# In a new terminal, start Explorer (port 5173)
cd explorer && npm run dev
5

Deploy

The stack has two deployable pieces: a static frontend built from the Explorer, and a Docker container for the API. Run them on your own infrastructure. See the deployment section on the Demand page for details.