simstadt 0.2.0__tar.gz → 0.2.2__tar.gz

{simstadt-0.2.0 → simstadt-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: simstadt
-Version: 0.2.0
+Version: 0.2.2
 Summary: Python library for using and testing SimStadt workflows.
 Author: Eric Duminil
 Author-email: Eric Duminil <eric.duminil@hft-stuttgart.de>

{simstadt-0.2.0 → simstadt-0.2.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "simstadt"
-version = "0.2.0"
+version = "0.2.2"
 description = "Python library for using and testing SimStadt workflows."
 readme = "README.md"
 authors = [

{simstadt-0.2.0 → simstadt-0.2.2}/src/simstadt/results/energy_grid.py

@@ -56,11 +56,11 @@ class EnergyGridResults(SimStadtResults):
             KPI("Number of inhabitants", df.attrs["number_of_people"], precision=0),
             KPI("Most common archetype", archetype_share, f"% ({most_common_archetype})", precision=0),
             KPI("Total heated area", total_heated_area, "m²", precision=0),
-            KPI("Total electricity demand", total_elec_kwh / 1000, "MWh / a", precision=1),
-            KPI("Specific electricity demand", total_elec_kwh / total_heated_area, "kWh / (m² · a)", precision=1),
-            KPI("Total heat demand", total_heat_kwh / 1000, "MWh / a", precision=1),
-            KPI("Specific heat demand", total_heat_kwh / total_heated_area, "kWh / (m² · a)", precision=1),
-            KPI("Total PV production", df["pv_production"].sum() / 1000, "MWh / a", precision=1),
+            KPI("Total electricity demand", total_elec_kwh / 1000, "MWh / a", precision=0),
+            KPI("Specific electricity demand", total_elec_kwh / total_heated_area, "kWh / (m² · a)", precision=0),
+            KPI("Total heat demand", total_heat_kwh / 1000, "MWh / a", precision=0),
+            KPI("Specific heat demand", total_heat_kwh / total_heated_area, "kWh / (m² · a)", precision=0),
+            KPI("Total PV production", df["pv_production"].sum() / 1000, "MWh / a", precision=0),
             KPI("Average temperature", float(df["ambient_temperature"].mean()), "°C", precision=1),
         ]
 

{simstadt-0.2.0 → simstadt-0.2.2}/src/simstadt/results/heat_demand.py

@@ -12,7 +12,7 @@ from .providers import Providers
 
 @dataclass(repr=False)
 class HeatDemandResults(SimStadtResults):
-    """Results for Heat Demand (and Heat+Cool Demand) workflows."""
+    """Results for Heat demand (and Heat+Cool demand) workflows."""
 
     MAX_FLAT_ROOF_DIFFERENCE = 0.1  # [m]
     TOTAL_DEMAND = "Total Yearly Heating + DHW demand"
@@ -47,7 +47,7 @@ class HeatDemandResults(SimStadtResults):
             custom_kpis.extend(
                 [
                     KPI("Number of heated buildings", heated_buildings, precision=0),
-                    KPI("Specific Heating Demand", specific_heat_demand, "kWh / (m² · a)", precision=0),
+                    KPI("Specific Heating demand", specific_heat_demand, "kWh / (m² · a)", precision=0),
                 ]
             )
             sums.extend(
@@ -59,7 +59,7 @@ class HeatDemandResults(SimStadtResults):
 
         if df.attrs["Cooling"]:
             specific_cooling_demand = df["Yearly Cooling demand"].sum() / df["Heated area"].sum()
-            custom_kpis.append(KPI("Specific Cooling Demand", specific_cooling_demand, "kWh / (m² · a)", precision=0))
+            custom_kpis.append(KPI("Specific Cooling demand", specific_cooling_demand, "kWh / (m² · a)", precision=0))
             sums.append(("Yearly Cooling demand", "kWh / a"))
 
         # TODO: rename to average year of construction?
@@ -73,7 +73,7 @@ class HeatDemandResults(SimStadtResults):
             rot=0,
             ylabel="[MWh]",
             width=0.8,
-            color={"Monthly Heating Demand": "darkred", "Monthly Cooling Demand": "darkblue"},
+            color={"Monthly Heating demand": "darkred", "Monthly Cooling demand": "darkblue"},
         )
         plt.savefig(heat_png, bbox_inches="tight", dpi=300)
         plt.close(ax.figure)
@@ -89,5 +89,5 @@ class HeatDemandResults(SimStadtResults):
                 col for col in df.columns if search_str in col and "Yearly" not in col and "Specific" not in col
             ]
             if found_cols:
-                monthly_df[f"Monthly {mode} Demand"] = (df[found_cols].sum() / 1000).values
+                monthly_df[f"Monthly {mode} demand"] = (df[found_cols].sum() / 1000).values
         return monthly_df

simstadt-0.2.2/src/simstadt/results/load_profile.py

@@ -0,0 +1,57 @@
+from dataclasses import dataclass
+from typing import ClassVar
+
+import pandas as pd
+
+from .base import SimStadtResults, detect_decimal
+from .kpi import KPI
+from .providers import Providers
+
+
+@dataclass(repr=False)
+class LoadProfileResults(SimStadtResults):
+    """Results for LoadProfile workflows.
+
+    The dataframe has one column per building (building GML ID as column name)
+    and 8760 rows of hourly energy demand [kWh/h].
+    """
+
+    supported_providers: ClassVar[list[str]] = [Providers.LOAD_PROFILE]
+    csv_identifier = "_load_profile_Hourly"
+
+    def _parse_results(self) -> pd.DataFrame:
+        csv_decimal = detect_decimal(self.csv_path, 6, "Area")
+
+        header = pd.read_csv(
+            self.csv_path, nrows=9, sep=";", header=None, index_col=0, decimal=csv_decimal
+        )
+        header.index = header.index.str.lstrip("# ")
+
+        def _header_sum(label: str) -> float:
+            return pd.to_numeric(header.loc[label]).fillna(0).sum()
+
+        df = pd.read_csv(self.csv_path, skiprows=range(1, 12), sep=";", decimal=csv_decimal)
+        df = df.drop(columns=[df.columns[0]])
+
+        df.attrs["number_of_households"] = int(_header_sum("Number of Households"))
+        df.attrs["number_of_people"] = int(_header_sum("Number of Occupants"))
+        df.attrs["total_heated_area"] = float(_header_sum("Heated Area"))
+
+        return df
+
+    @property
+    def kpis(self) -> list[KPI]:
+        df = self.dataframe
+        total = df.sum().sum()
+        total_heated_area = df.attrs["total_heated_area"]
+        result = [
+            KPI("Number of buildings", df.shape[1], precision=0),
+            KPI("Number of households", df.attrs["number_of_households"], precision=0),
+            KPI("Number of inhabitants", df.attrs["number_of_people"], precision=0),
+            KPI("Total heated area", total_heated_area, "m²", precision=0),
+            KPI("Total load", total, "kWh / a", precision=1),
+            KPI("Average load", total / 8760, "kWh / h", precision=1),
+        ]
+        if total_heated_area > 0:
+            result.append(KPI("Specific load", total / total_heated_area, "kWh / (m² · a)", precision=1))
+        return result

{simstadt-0.2.0 → simstadt-0.2.2}/src/simstadt/runner.py

@@ -38,17 +38,18 @@ log = logging.getLogger(__name__)
 
 
 def find_simstadt(parent_folder: Path, simstadt_glob: str = SIMSTADT2_GLOB) -> Path:
-    try:
-        found = next(parent_folder.glob(simstadt_glob))
+    simstadts = sorted(parent_folder.glob(simstadt_glob))
+    if len(simstadts) > 0:
+        found = simstadts[-1]
         log.info("# SimStadt found in %s\n", found)
         return found
-    except StopIteration as e:
+    else:
         raise ValueError(
             f"SimStadt not found in {parent_folder}/{simstadt_glob}.\n"
             "Please Set the SIMSTADT_FOLDER environment variable, "
             "or install SimStadt on the Desktop.\n\n"
             "See https://simstadt.hft-stuttgart.de/getting-started/install-software/"
-        ) from e
+        )
 
 
 def get_simstadt_folder() -> Path:

{simstadt-0.2.0 → simstadt-0.2.2}/src/simstadt/workflows.py

@@ -4,8 +4,6 @@ Each function wraps run_workflow_with_citygml() with a pre-built parameter dict
 for a specific workflow type (PV, heat demand, green water).
 """
 
-# TODO: Actually use and test them
-
 from pathlib import Path
 
 from .results import SimStadtResults

simstadt-0.2.0/src/simstadt/results/load_profile.py

@@ -1,38 +0,0 @@
-from dataclasses import dataclass
-from typing import ClassVar
-
-import pandas as pd
-
-from .base import SimStadtResults, detect_decimal
-from .kpi import KPI
-from .providers import Providers
-
-
-@dataclass(repr=False)
-class LoadProfileResults(SimStadtResults):
-    """Results for LoadProfile workflows.
-
-    The dataframe has one column per building (building GML ID as column name)
-    and 8760 rows of hourly energy demand [kWh/h].
-    """
-
-    supported_providers: ClassVar[list[str]] = [Providers.LOAD_PROFILE]
-    csv_identifier = "_load_profile_Hourly"
-
-    def _parse_results(self) -> pd.DataFrame:
-        csv_decimal = detect_decimal(self.csv_path, 6, "Area")
-        df = pd.read_csv(self.csv_path, skiprows=range(1, 12), sep=";", decimal=csv_decimal)
-        # First column is the timestamp; remaining columns are per-building loads
-        return df.drop(columns=[df.columns[0]])
-
-    @property
-    def kpis(self) -> list[KPI]:
-        # TODO: Add sum, average. Add timestep too?
-        # TODO: Add people? Add total heated area?
-        df = self.dataframe
-        total = df.sum().sum()
-        return [
-            KPI("Number of buildings", df.shape[1], precision=0),
-            KPI("Total load", total, "kWh / a", precision=1),
-            KPI("Average load", total / 8760, "kWh / h", precision=1),
-        ]