emflow: Open-source energy modelling framework

▶️ Introduction

• Introduction
• Purpose
• Features
• Installation
• Contributing
• Support and Contact

🪜 Walkthrough

• Walkthrough of the emflow framework
• Step 1: Define Your Energy Assets
• Step 2: Specify Dynamic State Variables
• Step 3: Define Action Variables
• Step 4: Create the Environment
• Step 5: Establish the Objective Function
• Step 6: Design Agents’ Policies
• Step 7: Run the Simulated Environment
• Conclusion

📝 Notebook Examples

• Notebook title
  • Load problem
  • Create prediction model
  • Run the sequential decision loop
• HEFTCom2024
  • Load data
  • Create and plot energy system
  • Create Environment
  • Create Objective
  • Create Predictor
  • Create Agent
• Temperature Autoregression — a leak-free evaluation walkthrough
  • 1. Load the problem
  • 2. Explore the data
  • 3. The evaluation contract — what the model is (and isn’t) allowed to see
  • 4. The autoregressive model
  • 5. Forecast and evaluate on 2026
  • 6. No data leakage — demonstrated
  • 7. Recap & next steps

🔋 Assets

• Base
• Solar
• Wind
• Battery
• Hydro
• Heatpump
• Power Grid
• Energy Collection

🗄️ Data

• Field
  • Field
• Dataset
  • Dataset
• DataFeed
  • DataFeed
  • TimeView

🧩 Problems

• Problem
  • Splits
  • RefScore
  • Problem
• IssueSchedule
  • Origin
  • IssueSchedule
• Metrics
  • quantile_columns()
  • Metric
  • MeanAbsoluteError
  • MeanSquaredError
  • RootMeanSquaredError
  • MeanAbsolutePercentageError
  • PinballLoss
  • TradingRevenue
  • PeakTimingError
• Objective
  • Objective
  • Metric
  • MeanAbsoluteError
  • MeanSquaredError
  • RootMeanSquaredError
  • MeanAbsolutePercentageError
  • PinballLoss
  • PeakTimingError
• Registry
  • ProblemNotIngestedError
  • list_problems()
  • cache_problem_data()
  • load_problem()

🌍 Environments

• ForecastEnv
  • Observation
  • SettlementRecord
  • ForecastEnv
• TradingEnv
  • TradingEnv

🧮 Features

• Feature specs
  • Lag
  • Rolling
  • ForecastField
  • Calendar
• Materialize
  • materialize()
  • materialize_observation()
  • supervised_frame()

📦 Spaces

• DataFrameSpace
  • DataFrameSpace

🤖 Models

• Model
  • Model
• Simulator
  • Simulator
• Predictor
  • Contract
  • Predictor
  • FeaturePredictor
• Optimizer
  • Optimizer
• Agent
  • Agent

♻️ Runs

• Experiment
  • Experiment
• Result
  • Result
• Analyzers
  • Analyzer
  • PersistenceSkill
  • QuantileCalibration
  • default_analyzers()
• Verifier
  • Verifier