Kom igång

Välj ett verktyg och följ stegen för att få en fungerande applikation på din maskin.

Förutsättningar

  • Node.js 18+: För API:et och Explorer-frontend
  • Python 3.9+: För generatorn
  • DuckDB: Installeras automatiskt via Node-paketet
1

Forka och klona

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

Konfigurera

Redigera config.yaml för att definiera dina scenarier, geografier, segment och parametrar. Den enda filen driver hela stacken.

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

Generera data

Kör generatorn för att skapa prognosdata. Använd den medföljande Jupyter-notebooken eller bygg din egen pipeline.

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

Bygg och servera

Generera de statiska API-endpointerna, starta API-servern och lansera 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

Driftsätt

Stacken har två driftsättbara delar: en statisk frontend byggd från Explorer, och en Docker-container för API:et. Kör dem på din egen infrastruktur. Se driftsättningsavsnittet på Demand-sidan för detaljer.