Org-level Statistics Page #4946

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open

kflemin wants to merge 23 commits into develop from org-stats

seed/api/v3/urls.py

-Original file line number
+Diff line change
@@ Expand Up / @@ -67,6 +67,7 @@ @@
     from seed.views.v3.salesforce_mappings import SalesforceMappingViewSet
     from seed.views.v3.sensors import SensorViewSet
     from seed.views.v3.services import ServiceViewSet
+    from seed.views.v3.statistics import StastisticsSetupViewSet
     from seed.views.v3.systems import SystemViewSet
     from seed.views.v3.tax_lot_properties import TaxLotPropertyViewSet
     from seed.views.v3.taxlot_views import TaxlotViewViewSet
@@ Expand Down Expand Up / @@ -120,6 +121,7 @@ @@
     api_v3_router.register(r"report_configurations", ReportConfigurationViewSet, basename="report_configurations")
     api_v3_router.register(r"salesforce_configs", SalesforceConfigViewSet, basename="salesforce_configs")
     api_v3_router.register(r"salesforce_mappings", SalesforceMappingViewSet, basename="salesforce_mappings")
+    api_v3_router.register(r"statistics", StastisticsSetupViewSet, basename="statistics")
     api_v3_router.register(r"tax_lot_properties", TaxLotPropertyViewSet, basename="tax_lot_properties")
     api_v3_router.register(r"taxlot_views", TaxlotViewViewSet, basename="taxlot_views")
     api_v3_router.register(r"taxlots", TaxlotViewSet, basename="taxlots")
@@ Expand Down @@

seed/migrations/0243_statisticssetup.py

-Original file line number
+Diff line change
@@ -0,0 +1,104 @@
+    # Generated by Django 3.2.25 on 2025-02-27 20:06
+    import django.db.models.deletion
+    from django.db import migrations, models
+    class Migration(migrations.Migration):
+        dependencies = [
+            ("orgs", "0041_add_at_tracking_fields"),
+            ("seed", "0242_add_meter_types"),
+        ]
+        operations = [
+            migrations.CreateModel(
+                name="StatisticsSetup",
+                fields=[
+                    ("id", models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
+                    ("gfa_units", models.CharField(choices=[("ft2", "ft2"), ("m2", ",2")], default="ft2", max_length=20)),
+                    (
+                        "electricity_units",
+                        models.CharField(
+                            choices=[("GJ", "GJ"), ("kBtu", "kBtu"), ("kWh", "kWh"), ("MBtu/MMBtu", "MBtu/MMBtu"), ("MWh", "MWh")],
+                            default=None,
+                            max_length=50,
+                        ),
+                    ),
+                    (
+                        "natural_gas_units",
+                        models.CharField(
+                            choices=[
+                                ("GJ", "GJ"),
+                                ("kBtu", "kBtu"),
+                                ("MBtu/MMBtu", "MBtu/MMBtu"),
+                                ("therms", "therms"),
+                                ("kWh", "kWh"),
+                                ("kcf", "kcf"),
+                                ("Mcf", "Mcf"),
+                            ],
+                            default=None,
+                            max_length=50,
+                        ),
+                    ),
+                    (
+                        "electricity_eui_units",
+                        models.CharField(
+                            choices=[
+                                ("kBtu/ft2", "kBtu/ft2"),
+                                ("kBtu/m2", "kBtu/m2"),
+                                ("kWh/ft2", "kWh/ft2"),
+                                ("kWh/m2", "kWh/m2"),
+                                ("GJ/m2", "GJ/m2"),
+                                ("GJ/ft2", "GJ/ft2"),
+                            ],
+                            default="kBtu/ft2",
+                            max_length=50,
+                        ),
+                    ),
+                    (
+                        "natural_gas_eui_units",
+                        models.CharField(
+                            choices=[
+                                ("kBtu/ft2", "kBtu/ft2"),
+                                ("kBtu/m2", "kBtu/m2"),
+                                ("kWh/ft2", "kWh/ft2"),
+                                ("kWh/m2", "kWh/m2"),
+                                ("GJ/m2", "GJ/m2"),
+                                ("GJ/ft2", "GJ/ft2"),
+                            ],
+                            default="kBtu/ft2",
+                            max_length=50,
+                        ),
+                    ),
+                    (
+                        "electricity_column",
+                        models.ForeignKey(
+                            null=True, on_delete=django.db.models.deletion.SET_NULL, related_name="electricity_column", to="seed.column"
+                        ),
+                    ),
+                    (
+                        "electricity_eui_column",
+                        models.ForeignKey(
+                            null=True, on_delete=django.db.models.deletion.SET_NULL, related_name="electricity_eui_column", to="seed.column"
+                        ),
+                    ),
+                    (
+                        "gfa_column",
+                        models.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, related_name="gfa_column", to="seed.column"),
+                    ),
+                    (
+                        "natural_gas_column",
+                        models.ForeignKey(
+                            null=True, on_delete=django.db.models.deletion.SET_NULL, related_name="natural_gas_column", to="seed.column"
+                        ),
+                    ),
+                    (
+                        "natural_gas_eui_column",
+                        models.ForeignKey(
+                            null=True, on_delete=django.db.models.deletion.SET_NULL, related_name="natural_gas_eui_column", to="seed.column"
+                        ),
+                    ),
+                    ("organization", models.OneToOneField(on_delete=django.db.models.deletion.CASCADE, to="orgs.organization")),
+                ],
+            ),
+        ]

seed/models/__init__.py

-Original file line number
+Diff line change
@@ Expand Up / @@ -29,6 +29,7 @@ @@
     from .salesforce_mappings import *
     from .sensors import *
     from .simulations import *
+    from .statistics_setups import *
     from .building_file import *
     from .inventory_document import *
     from .inventory_groups import *
@@ Expand Down @@

seed/models/statistics_setups.py

-Original file line number
+Diff line change
@@ -0,0 +1,64 @@
+    """
+    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 django.db import models
+    from seed.data_importer.utils import kbtu_thermal_conversion_factors
+    from seed.lib.superperms.orgs.models import Organization
+    from seed.models.columns import Column
+    logger = logging.getLogger(__name__)
+    class StatisticsSetup(models.Model):
+        # Stores all the configuration needed to calculate organization statistics
+        # Retrieve default values
+        # find the kbtu_thermal_conversion_factors entry under Electric that has "kWh" in it
+        electric_factors = kbtu_thermal_conversion_factors("US").get("Electric", {})
+        electric_default = next((item for item in electric_factors.items() if "kWh" in item), None)
+        # find the value under "Natural Gas" that has "therms" in it
+        gas_factors = kbtu_thermal_conversion_factors("US").get("Natural Gas", {})
+        gas_default = next((item for item in electric_factors.items() if "therms" in item), None)
+        # set area default to 'ft2'
+        area_units_default = "ft2"
+        AREA_UNITS = (
+            ("ft2", "ft2"),
+            ("m2", ",2"),
+        )
+        ELECTRIC_UNITS = (("GJ", "GJ"), ("kBtu", "kBtu"), ("kWh", "kWh"), ("MBtu/MMBtu", "MBtu/MMBtu"), ("MWh", "MWh"))
+        EUI_UNITS = (
+            ("kBtu/ft2", "kBtu/ft2"),
+            ("kBtu/m2", "kBtu/m2"),
+            ("kWh/ft2", "kWh/ft2"),
+            ("kWh/m2", "kWh/m2"),
+            ("GJ/m2", "GJ/m2"),
+            ("GJ/ft2", "GJ/ft2"),
+        )
+        GAS_UNITS = (
+            ("GJ", "GJ"),
+            ("kBtu", "kBtu"),
+            ("MBtu/MMBtu", "MBtu/MMBtu"),
+            ("therms", "therms"),
+            ("kWh", "kWh"),
+            ("kcf", "kcf"),
+            ("Mcf", "Mcf"),
+        )
+        organization = models.OneToOneField(Organization, on_delete=models.CASCADE)
+        gfa_column = models.ForeignKey(Column, related_name="gfa_column", null=True, on_delete=models.SET_NULL)
+        gfa_units = models.CharField(max_length=20, choices=AREA_UNITS, default=area_units_default)
+        electricity_column = models.ForeignKey(Column, related_name="electricity_column", null=True, on_delete=models.SET_NULL)
+        electricity_units = models.CharField(max_length=50, choices=ELECTRIC_UNITS, default=electric_default)
+        natural_gas_column = models.ForeignKey(Column, related_name="natural_gas_column", null=True, on_delete=models.SET_NULL)
+        natural_gas_units = models.CharField(max_length=50, choices=GAS_UNITS, default=gas_default)
+        electricity_eui_column = models.ForeignKey(Column, related_name="electricity_eui_column", null=True, on_delete=models.SET_NULL)
+        electricity_eui_units = models.CharField(max_length=50, choices=EUI_UNITS, default="kBtu/ft2")
+        natural_gas_eui_column = models.ForeignKey(Column, related_name="natural_gas_eui_column", null=True, on_delete=models.SET_NULL)
+        natural_gas_eui_units = models.CharField(max_length=50, choices=EUI_UNITS, default="kBtu/ft2")

seed/serializers/statistics_setups.py

-Original file line number
+Diff line change
@@ -0,0 +1,29 @@
+    """
+    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
+    """
+    from rest_framework import serializers
+    from seed.models.statistics_setups import StatisticsSetup
+    class StatisticsSetupSerializer(serializers.ModelSerializer):
+        organization_id = serializers.IntegerField(required=True)
+        class Meta:
+            model = StatisticsSetup
+            fields = (
+                "id",
+                "organization_id",
+                "gfa_column",
+                "gfa_units",
+                "electricity_column",
+                "electricity_units",
+                "natural_gas_column",
+                "natural_gas_units",
+                "electricity_eui_column",
+                "electricity_eui_units",
+                "natural_gas_eui_column",
+                "natural_gas_eui_units",
+            )

seed/static/seed/js/controllers/organization_stats_controller.js

-Original file line number
+Diff line change
@@ -0,0 +1,169 @@
+    /**
+     * 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
+     */
+    angular.module('SEED.controller.organization_stats', []).controller('organization_stats_controller', [
+      '$scope',
+      'all_columns',
+      'organization_payload',
+      'auth_payload',
+      'statistics_payload',
+      'statistics_service',
+      'Notification',
+      // eslint-disable-next-line func-names
+      function ($scope, all_columns, organization_payload, auth_payload, statistics_payload, statistics_service, Notification) {
+        $scope.fields = all_columns.columns;
+        $scope.org = organization_payload.organization;
+        $scope.auth = auth_payload.auth;
+        $scope.data_fetched = false;
+        $scope.data = [];
+        $scope.conf = {};
+        if (statistics_payload.length > 0) {
+          $scope.conf = statistics_payload[0];
+        }
+        // hardcoding these for now but we should make a service for them at some point
+        $scope.electric_units = [
+          'GJ',
+          'kBtu',
+          'kWh',
+          'MBtu/MMBtu',
+          'MWh'
+        ];
+        $scope.gas_units = [
+          'GJ',
+          'kBtu',
+          'MBtu/MMBtu',
+          'therms',
+          'kWh',
+          'kcf',
+          'Mcf'
+        ];
+        $scope.area_units = ['ft2', 'm2'];
+        $scope.eui_units = [
+          'kBtu/ft2',
+          'kBtu/m2',
+          'kWh/ft2',
+          'kWh/m2',
+          'GJ/m2',
+          'GJ/ft2'
+        ];
+        $scope.btnText = 'Expand Configurations';
+        $scope.changeText = (btnText) => {
+          if (btnText === 'Collapse Configurations') {
+            $scope.btnText = 'Expand Configurations';
+          } else {
+            $scope.btnText = 'Collapse Configurations';
+          }
+        };
+        /* save settings */
+        $scope.save_settings = () => {
+          $scope.settings_updated = false;
+          if ($scope.conf.id) {
+            // update
+            statistics_service
+              .update_statistic($scope.org.id, $scope.conf.id, $scope.conf)
+              .then((response) => {
+                if (response.status === 'error') {
+                  $scope.config_errors = response.errors;
+                } else {
+                  statistics_service.get_statistics($scope.org.id).then((data) => {
+                    $scope.conf = data.length > 0 ? data[0] : {};
+                  });
+                  $scope.settings_updated = true;
+                }
+              })
+              .catch((response) => {
+                if (response.data && response.data.status === 'error') {
+                  $scope.config_errors = response.data.message;
+                } else {
+                  $scope.config_errors = 'An unknown error has occurred';
+                }
+                Notification.error({ message: `Error: ${$scope.config_errors}`, delay: 15000, closeOnClick: true });
+              });
+          } else {
+            // create
+            statistics_service
+              .new_statistic($scope.org.id, $scope.conf)
+              .then(() => {
+                statistics_service.get_statistics($scope.org.id).then((data) => {
+                  $scope.conf = data.length > 0 ? data[0] : {};
+                });
+                $scope.settings_updated = true;
+              })
+              .catch((response) => {
+                if (response.data && response.data.status === 'error') {
+                  $scope.config_errors = response.data.message;
+                } else {
+                  $scope.config_errors = 'An unknown error has occurred';
+                }
+                Notification.error({ message: `Error: ${$scope.config_errors}`, delay: 15000, closeOnClick: true });
+              });
+          }
+        };
+        /* calculate stats and update data display */
+        $scope.calculate = () => {
+          // calculate statistics
+          statistics_service
+            .calculate_statistics($scope.org.id, $scope.conf.id)
+            .then((response) => {
+              if (response.status === 'error') {
+                $scope.config_errors = response.errors;
+              } else {
+                // fetched data
+                $scope.data = response.data.data;
+                // $scope.boxplotData = {};
+                // $scope.elec_chart = $scope.create_chart('canvas_elec', $scope.data.chart_data_elec, 'Electricity Energy Use Intensity');
+                // $scope.gas_chart = $scope.create_chart('canvas_gas', $scope.data.chart_data_gas, 'Natural Gas Energy Use Intensity');
+                $scope.data_fetched = true;
+              }
+            })
+            .catch((response) => {
+              if (response.data && response.status === 'error') {
+                $scope.config_errors = response.data.message;
+              } else {
+                $scope.config_errors = 'An unknown error has occurred';
+              }
+              Notification.error({ message: `Error: ${$scope.config_errors}`, delay: 15000, closeOnClick: true });
+            });
+        };
+        // $scope.create_chart = (chartType, data, title_text) => {
+        //   $scope.boxplotData[chartType] = {
+        //     // define label tree
+        //     // labels are the cycle in $scope.data
+        //     labels: Object.keys(data),
+        //     datasets: []
+        //   };
+        //   // iterate over keys of $scope.chart_data_elec hash and add data to datasets
+        //   for (const key in data) {
+        //     $scope.boxplotData[chartType].datasets.push({
+        //       label: key,
+        //       data: data[key]
+        //     });
+        //   }
+        //   const canvas = document.getElementById(chartType);
+        //   const ctx = canvas.getContext('2d');
+        //   return new Chart(ctx, {
+        //     type: 'boxplot',
+        //     data: $scope.boxplotData[chartType],
+        //     options: {
+        //       responsive: true,
+        //       legend: {
+        //         position: 'top'
+        //       },
+        //       title: {
+        //         display: true,
+        //         text: title_text
+        //       }
+        //     }
+        //   });
+        // };
+      }
+    ]);

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Org-level Statistics Page #4946

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

Org-level Statistics Page #4946

Are you sure you want to change the base?

Uh oh!

Org-level Statistics Page #4946

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!