Create Hvac Metrics

seed/analysis_pipelines/hvac_metrics.py

@@ -0,0 +1,148 @@
+# !/usr/bin/env python
+"""
+SEED Platform (TM), Copyright (c) Alliance for Sustainable Energy, LLC, and other contributors.
+See also https://github.com/SEED-platform/seed/blob/main/LICENSE.md
+"""
+
+import logging
+from collections import Counter
+
+from celery import chain, shared_task
+from django.db.models import F
+
+from seed.analysis_pipelines.pipeline import (
+    AnalysisPipeline,
+    AnalysisPipelineError,
+    analysis_pipeline_task,
+    task_create_analysis_property_views,
+)
+from seed.models import Analysis, AnalysisMessage, AnalysisPropertyView, Column, Element, PropertyView
+
+logger = logging.getLogger(__name__)
+
+
+class HVACMetricsPipeline(AnalysisPipeline):
+    def _prepare_analysis(self, property_view_ids, start_analysis=True):
+        # if theres not elements, just exit
+        views = PropertyView.objects.filter(id__in=property_view_ids)
+        if not Element.objects.filter(property__in=views.values_list("property", flat=True)).exists():
+            AnalysisMessage.log_and_create(
+                logger=logger,
+                type_=AnalysisMessage.ERROR,
+                analysis_id=self._analysis_id,
+                analysis_property_view_id=None,
+                user_message="None of the selected properties have elements, which are requied for this analysis.",
+                debug_message="",
+            )
+            analysis = Analysis.objects.get(id=self._analysis_id)
+            analysis.status = Analysis.FAILED
+            analysis.save()
+            raise AnalysisPipelineError("None of the selected properties have elements, which are requied for this analysis.")
+
+        progress_data = self.get_progress_data()
+        progress_data.total = 3
+        progress_data.save()
+
+        chain(
+            task_create_analysis_property_views.si(self._analysis_id, property_view_ids),
+            _finish_preparation.s(self._analysis_id),
+            _run_analysis.s(self._analysis_id),
+        ).apply_async()
+
+    def _start_analysis(self):
+        return None
+
+
+@shared_task(bind=True)
+@analysis_pipeline_task(Analysis.CREATING)
+def _finish_preparation(self, analysis_view_ids_by_property_view_id, analysis_id):
+    pipeline = HVACMetricsPipeline(analysis_id)
+    pipeline.set_analysis_status_to_ready("Ready to run HVAC Metrics analysis")
+
+    # here is where errors would be filtered out
+
+    return list(analysis_view_ids_by_property_view_id.values())
+
+
+@shared_task(bind=True)
+@analysis_pipeline_task(Analysis.READY)
+def _run_analysis(self, analysis_property_view_ids, analysis_id):
+    pipeline = HVACMetricsPipeline(analysis_id)
+    progress_data = pipeline.set_analysis_status_to_running()
+    progress_data.step("Generating Numbers")
+    analysis = Analysis.objects.get(id=analysis_id)
+
+    # get/create relevant columns
+    existing_columns = _create_analysis_columns(analysis)
+
+    analysis_property_views = AnalysisPropertyView.objects.filter(id__in=analysis_property_view_ids)
+    property_views_by_apv_id = AnalysisPropertyView.get_property_views(analysis_property_views)
+    for analysis_property_view in analysis_property_views:
+        # get property view and its elements
+        property_view = property_views_by_apv_id[analysis_property_view.id]
+        elements = Element.objects.filter(property=property_view.property)
+
+        # do calculations
+        cooling_caps = elements.annotate(cooling_cap=F("extra_data__Nominal Cooling Cap. (Tons)")).values_list("cooling_cap", flat=True)
+        total_cooling_cap = sum([c for c in cooling_caps if c is not None])
+        refrigeration_on_types = elements.annotate(refrigeration_on_type=F("extra_data__Refrigeration on Type")).values_list(
+            "refrigeration_on_type", flat=True
+        )
+        most_common_refrigeration_on_type = Counter(refrigeration_on_types).most_common(1)[0][0] if refrigeration_on_types else None
+
+        # update the analysis_property_view
+        analysis_property_view.parsed_results = {
+            "Total Nominal Cooling Cap. (Tons)": total_cooling_cap,
+            "Most Common Refrigeration On Type": most_common_refrigeration_on_type,
+        }
+        analysis_property_view.save()
+
+        # write to property columns
+        if "total_nominal_cooling_cap" in existing_columns:
+            property_view.state.extra_data.update({"total_nominal_cooling_cap": total_cooling_cap})
+        if "most_common_refrigeration_on_type" in existing_columns:
+            property_view.state.extra_data.update({"most_common_refrigeration_on_type": most_common_refrigeration_on_type})
+
+        property_view.state.save()
+
+    # all done!
+    pipeline.set_analysis_status_to_completed()
+
+
+def _create_analysis_columns(analysis):
+    existing_columns = []
+    column_meta = [
+        {
+            "column_name": "total_nominal_cooling_cap",
+            "display_name": "Total Nominal Cooling Cap.",
+            "description": "created by HVAC Metric analysis",
+        },
+        {
+            "column_name": "most_common_refrigeration_on_type",
+            "display_name": "Most Common Refrigeration On Type",
+            "description": "created by HVAC Metric analysis",
+        },
+    ]
+
+    for col in column_meta:
+        try:
+            Column.objects.get(
+                column_name=col["column_name"],
+                organization=analysis.organization,
+                table_name="PropertyState",
+            )
+            existing_columns.append(col["column_name"])
+        except Exception:
+            if analysis.can_create():
+                column = Column.objects.create(
+                    is_extra_data=True,
+                    column_name=col["column_name"],
+                    organization=analysis.organization,
+                    table_name="PropertyState",
+                )
+                column.display_name = col["display_name"]
+                column.column_description = col["description"]
+                column.save()
+                existing_columns.append(col["column_name"])
+
+    return existing_columns

seed/analysis_pipelines/pipeline.py

@@ -273,6 +273,7 @@ def factory(cls, analysis):
         from seed.analysis_pipelines.eeej import EEEJPipeline
         from seed.analysis_pipelines.element_statistics import ElementStatisticsPipeline
         from seed.analysis_pipelines.eui import EUIPipeline
+        from seed.analysis_pipelines.hvac_metrics import HVACMetricsPipeline
         from seed.analysis_pipelines.upgrade_recommendation import UpgradeRecommendationPipeline
 
         if analysis.service == Analysis.BSYNCR:
@@ -289,6 +290,8 @@ def factory(cls, analysis):
             return ElementStatisticsPipeline(analysis.id)
         elif analysis.service == Analysis.UPGRADERECOMMENDATION:
             return UpgradeRecommendationPipeline(analysis.id)
+        elif analysis.service == Analysis.HVACMETRICS:
+            return HVACMetricsPipeline(analysis.id)
         else:
             raise AnalysisPipelineError(f'Analysis service type is unknown/unhandled. Service ID "{analysis.service}"')
 

seed/analysis_pipelines/tasks.py

@@ -20,4 +20,5 @@
 from seed.analysis_pipelines.eeej import _finish_preparation, _run_analysis  # noqa: F811
 from seed.analysis_pipelines.element_statistics import _finish_preparation, _run_analysis  # noqa: F811
 from seed.analysis_pipelines.eui import _finish_preparation, _run_analysis  # noqa: F811
+from seed.analysis_pipelines.hvac_metrics import _finish_preparation, _run_analysis  # noqa: F811
 from seed.analysis_pipelines.upgrade_recommendation import _finish_preparation, _run_analysis  # noqa: F811, F401

seed/migrations/0248_alter_analysis_service.py

@@ -0,0 +1,28 @@
+# Generated by Django 4.2.24 on 2025-10-09 18:54
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("seed", "0247_aggregatemetersystem"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="analysis",
+            name="service",
+            field=models.IntegerField(
+                choices=[
+                    (1, "BSyncr"),
+                    (2, "BETTER"),
+                    (3, "EUI"),
+                    (4, "CO2"),
+                    (5, "EEEJ"),
+                    (6, "Element Statistics"),
+                    (7, "Building Upgrade Recommendation"),
+                    (8, "HVAC Metrics"),
+                ]
+            ),
+        ),
+    ]

seed/models/analyses.py

@@ -26,6 +26,7 @@ class Analysis(models.Model):
     EEEJ = 5
     ELEMENTSTATISTICS = 6
     UPGRADERECOMMENDATION = 7
+    HVACMETRICS = 8
 
     SERVICE_TYPES = (
         (BSYNCR, "BSyncr"),
@@ -35,6 +36,7 @@ class Analysis(models.Model):
         (EEEJ, "EEEJ"),
         (ELEMENTSTATISTICS, "Element Statistics"),
         (UPGRADERECOMMENDATION, "Building Upgrade Recommendation"),
+        (HVACMETRICS, "HVAC Metrics"),
     )
 
     PENDING_CREATION = 8
@@ -197,6 +199,12 @@ def get_highlights(self, property_id=None):
             return [
                 {"name": "Building Upgrade Recommendation", "value": recommendation},
             ]
+        # HVAC Metrics
+        elif self.service == self.HVACMETRICS:
+            return [
+                {"name": "Total Nominal Cooling Cap. (Tons)", "value": results.get("Total Nominal Cooling Cap. (Tons)")},
+                {"name": "Most Common Refrigeration On Type", "value": results.get("Most Common Refrigeration On Type")},
+            ]
 
         # Unexpected
         return [{"name": "Unexpected Analysis Type", "value": "Oops!"}]

seed/static/seed/js/controllers/inventory_detail_analyses_modal_controller.js

@@ -138,6 +138,9 @@ angular.module('SEED.controller.inventory_detail_analyses_modal', []).controller
             ff_fired_equipment_rsl_threshold: null
           };
           break;
+        case 'HVAC Metrics':
+          $scope.new_analysis.configuration = {};
+          break;
         default:
           $log.error('Unknown analysis type.', $scope.new_analysis.service);
           Notification.error(`Unknown analysis type: ${$scope.new_analysis.service}`);

seed/static/seed/partials/inventory_detail_analyses_modal.html

@@ -60,6 +60,9 @@ <h4 class="modal-title" id="manageLabelsModalLabel" translate>
             >
               Building Upgrade Recommendation
             </option>
+            <option ng-option value="HVAC Metrics" selected="selected">
+              HVAC Metrics
+            </option>
           </select>
         </div>
         <div