energykit Logo

Getting Started

  • Installation
    • Quick install
    • With optional extras
    • Install extras explained
    • Windows
    • macOS
    • Linux
  • Quickstart
    • One-call financial audit
    • Demand charge analysis
    • Anomaly detection with financial impact
    • Imbalance cost
    • Battery scheduling
    • Load forecasting

API Reference

  • energykit.diagnose
    • energykit.diagnose
      • The “before / after” story
      • Usage
    • DiagnosisReport
      • DiagnosisReport.total_kwh
      • DiagnosisReport.avg_kw
      • DiagnosisReport.peak_kw
      • DiagnosisReport.peak_timestamp
      • DiagnosisReport.demand_charge_annual_usd
      • DiagnosisReport.demand_peak_kw
      • DiagnosisReport.demand_peak_timestamp
      • DiagnosisReport.demand_best_battery_kwh
      • DiagnosisReport.demand_best_battery_savings_usd
      • DiagnosisReport.anomaly_count
      • DiagnosisReport.anomaly_rate_pct
      • DiagnosisReport.anomaly_waste_kwh
      • DiagnosisReport.anomaly_cost_usd
      • DiagnosisReport.der_battery_kwh
      • DiagnosisReport.der_annual_savings_usd
      • DiagnosisReport.der_payback_years
      • DiagnosisReport.total_addressable_savings_usd
      • DiagnosisReport.pct_of_spend
      • DiagnosisReport.raw
      • DiagnosisReport.anomaly_cost_usd
      • DiagnosisReport.anomaly_count
      • DiagnosisReport.anomaly_rate_pct
      • DiagnosisReport.anomaly_waste_kwh
      • DiagnosisReport.avg_kw
      • DiagnosisReport.data_end
      • DiagnosisReport.data_start
      • DiagnosisReport.demand_best_battery_kwh
      • DiagnosisReport.demand_best_battery_savings_usd
      • DiagnosisReport.demand_charge_annual_usd
      • DiagnosisReport.demand_peak_kw
      • DiagnosisReport.demand_peak_timestamp
      • DiagnosisReport.der_annual_savings_usd
      • DiagnosisReport.der_battery_kwh
      • DiagnosisReport.der_payback_years
      • DiagnosisReport.n_readings
      • DiagnosisReport.pct_of_spend
      • DiagnosisReport.peak_kw
      • DiagnosisReport.peak_timestamp
      • DiagnosisReport.raw
      • DiagnosisReport.total_addressable_savings_usd
      • DiagnosisReport.total_kwh
    • diagnose()
  • energykit.cost
    • Modules
    • DemandChargeAnalyzer
      • DemandChargeAnalyzer.analyze()
    • DemandChargeResult
      • DemandChargeResult.peak_events_df
      • DemandChargeResult.peak_events
      • DemandChargeResult.total_annual_charge_usd
      • DemandChargeResult.worst_event
      • DemandChargeResult.battery_savings_df
      • DemandChargeResult.n_periods
      • DemandChargeResult.battery_savings_df
      • DemandChargeResult.n_periods
      • DemandChargeResult.peak_events
      • DemandChargeResult.peak_events_df
      • DemandChargeResult.total_annual_charge_usd
      • DemandChargeResult.worst_event
    • ImbalanceCostCalculator
      • ImbalanceCostCalculator.compute()
    • forecast_value_of_accuracy()
    • Demand Charge Analyzer
      • energykit.cost.demand_charge
      • DemandChargeAnalyzer
      • DemandChargeResult
      • PeakEvent
    • Imbalance Cost Calculator
      • energykit.cost.imbalance
      • ForecastValueReport
      • ImbalanceCostCalculator
      • ImbalanceResult
      • forecast_value_of_accuracy()
  • energykit.anomaly
    • AnomalySummary
      • AnomalySummary.n_anomalies
      • AnomalySummary.anomaly_rate_pct
      • AnomalySummary.total_excess_kwh
      • AnomalySummary.total_estimated_cost_usd
      • AnomalySummary.worst_event
      • AnomalySummary.top_anomalies_df
      • AnomalySummary.anomalies_df
      • AnomalySummary.anomalies_df
      • AnomalySummary.anomaly_rate_pct
      • AnomalySummary.n_anomalies
      • AnomalySummary.top_anomalies_df
      • AnomalySummary.total_estimated_cost_usd
      • AnomalySummary.total_excess_kwh
      • AnomalySummary.worst_event
    • MeterAnomalyDetector
      • MeterAnomalyDetector.detect()
      • MeterAnomalyDetector.fit()
    • Meter Anomaly Detector
      • energykit.anomaly.detector
      • AnomalySummary
      • MeterAnomalyDetector
  • energykit.forecast
    • LoadForecaster
      • LoadForecaster.model_
      • LoadForecaster.feature_extractor_
      • LoadForecaster.train_series_
      • LoadForecaster.is_fitted_
      • LoadForecaster.feature_importance()
      • LoadForecaster.fit()
      • LoadForecaster.predict()
      • LoadForecaster.set_predict_request()
    • Load Forecaster
      • energykit.forecast.load
      • LoadForecaster
  • energykit.optimize
    • BatteryScheduler
      • BatteryScheduler.optimize()
    • EVScheduler
      • EVScheduler.optimize()
    • DER Scheduler
      • energykit.optimize.der
      • BatteryScheduler
      • EVScheduler
      • ScheduleResult
  • energykit.features
    • EnergyFeatureExtractor
      • EnergyFeatureExtractor.feature_names_
      • EnergyFeatureExtractor.fit()
      • EnergyFeatureExtractor.get_feature_names_out()
      • EnergyFeatureExtractor.transform()
    • Temporal Features
      • energykit.features.temporal
      • EnergyFeatureExtractor
  • energykit.benchmark
    • EnergyForecastBenchmark
      • EnergyForecastBenchmark.ashrae_check()
      • EnergyForecastBenchmark.summary()
    • cvrmse()
    • load_factor_error()
    • mae()
    • mape()
    • peak_coincidence()
    • r2()
    • rmse()
    • smape()
  • energykit.datasets
    • load_sample_tou_prices()
    • load_synthetic_load()
    • load_uci_household()
    • Loaders
      • energykit.datasets.loaders
      • load_sample_tou_prices()
      • load_synthetic_load()
      • load_uci_household()

Links

  • GitHub
  • PyPI
  • Muranai.com
energykit
  • Overview: module code

All modules for which code is available

  • energykit.anomaly.detector
  • energykit.benchmark.metrics
  • energykit.cost.demand_charge
  • energykit.cost.imbalance
  • energykit.datasets.loaders
  • energykit.diagnose
  • energykit.features.temporal
  • energykit.forecast.load
  • energykit.optimize.der

© Copyright 2026, Muranai.

Built with Sphinx using a theme provided by Read the Docs.