Refactor header layout, fix weather data URLs, and update version

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.10.1
+current_version = 0.10.2
 commit = True
 tag = True
 

.gitignore

@@ -1,6 +1,10 @@
 # This pickle file is produced by test runs:
 epw_test.pkl
 
+# Data maintenance scripts
+check_links.py
+fix_broken_urls.py
+
 venv
 .idea
 cache-directory

Pipfile

@@ -16,6 +16,7 @@ pandas = "==2.2.0"
 numpy = "==1.26.3"
 dash-iconify = "*"
 scipy = "==1.12.0"
+kgcpy = "*"
 
 [dev-packages]
 cleanpy = "*"

assets/manifest.json

@@ -467,7 +467,7 @@
   "orientation": "portrait",
   "background_color": "#ffffff",
   "display": "standalone",
-  "id": "0.10.1",
+  "id": "0.10.2",
   "description": "CBE Clima Tool: a free and open-source web application for climate analysis tailored to sustainable building design",
   "start_url": "/",
   "scope": "/",

docs/contributing/run-project-locally.md

@@ -114,7 +114,10 @@ docker logs -f clima-test
 
 # if everything is ok push to google container registry
 docker push us-central1-docker.pkg.dev/clima-316917/cloud-run-source-deploy/clima:latest
-gcloud run deploy clima-test --image us-central1-docker.pkg.dev/clima-316917/cloud-run-source-deploy/clima:latest --region us-central1 --memory 4Gi --cpu 2 --platform managed --allow-unauthenticated
+gcloud run deploy clima-test --image us-central1-docker.pkg.dev/clima-316917/cloud-run-source-deploy/clima:latest --region us-central1 --memory 4Gi --cpu 2 --platform managed --allow-unauthenticated --tag "v0-10-2"
+
+# you can then deploy the main version changing the name and tag
+gcloud run deploy clima --image us-central1-docker.pkg.dev/clima-316917/cloud-run-source-deploy/clima:latest --region us-central1 --memory 4Gi --cpu 2 --platform managed --allow-unauthenticated --tag "v0-10-2"
 ```
 
 ### Deploy test version of the project

docs/documentation/tabs-explained/temperature-and-humidity/relative-humidity-explained.md

@@ -4,15 +4,15 @@
 
 The annual graph allows the different months' relative humidity ranges to be evaluated. Moreover, overlaying the average value trend for each day helps visualize the differences between the minimum and maximum daily values for the investigated location.
 
-The humidity comfort band is overlaid, considering 30-70% RH the comfortable range. With these trends, climates can be assessed, whether too dry or too humid, then evaluating design solutions that include humidification or dehumidification system.
+The humidity band, defined as 30–70% RH per [ANSI/ASHRAE Standard 160](https://webstore.ansi.org/standards/ashrae/ansiashrae1602021), is overlaid to provide a baseline for analysis. These trends allow users to assess whether a climate is excessively dry or humid and evaluate design solutions, such as integrated humidification or dehumidification systems, to control for mold, static electricity, skin comfort, and other potential humidity-related issues.
 
 <figure><img src="../../../.gitbook/assets/RH yearly.png" alt=""><figcaption><p>Yearly relative humidity trend in four common climatic conditions: hot dry, tropical, temperate, and continental</p></figcaption></figure>
 
 Outdoor relative humidity varies greatly depending on the amount of rainfall. As expected, hot dry and tropical climates have diametrically opposite trends, always outside the comfort range, and some measures must be taken to recreate comfortable situations in buildings.
 
 ### Daily chart
 
-Monthly [scatterplots](https://en.wikipedia.org/wiki/Scatter\_plot) show all hourly relative humidity. The humidity excursion is much more evident than in the annual graphs. Daily medians, i.e., the most frequently occurring values, help evaluate the outliers.
+Monthly [scatterplots](https://en.wikipedia.org/wiki/Scatter_plot) show all hourly relative humidity. The humidity excursion is much more evident than in the annual graphs. Daily medians, i.e., the most frequently occurring values, help evaluate the outliers.
 
 <figure><img src="../../../.gitbook/assets/RH daily.png" alt=""><figcaption><p>Daily relative humidity trend in four common climatic conditions: hot dry, tropical, temperate, and continental</p></figcaption></figure>
 
@@ -31,10 +31,12 @@ The four heatmaps give a clear idea of the comparison of the four climate types.
 The last tool for relative humidity assessment is the statistics table. The earlier graphically made evaluations can be supported by the numbers. The following are listed, for each month:
 
 * the relative humidity means;
-* the [standard deviations](https://en.wikipedia.org/wiki/Standard\_deviation);
+* the [standard deviations](https://en.wikipedia.org/wiki/Standard_deviation);
 * the minimum values;
 * the [percentiles values](https://en.wikipedia.org/wiki/Percentile) (1%, 25%, 50%, 75%, 99%);
 * the maximum values.
 *
 
-    <figure><img src="../../../.gitbook/assets/Desc stat RH.png" alt=""><figcaption><p>Descriptive statistics of relative humidity trend in a temperate climate, Berkeley (USA)</p></figcaption></figure>
+```
+<figure><img src="../../../.gitbook/assets/Desc stat RH.png" alt=""><figcaption><p>Descriptive statistics of relative humidity trend in a temperate climate, Berkeley (USA)</p></figcaption></figure>
+```

pages/lib/import_one_building_files.py

@@ -12,6 +12,9 @@ def import_kml_files(file_name):
 
     data = []
     for location in locations:
+        url_match = re.findall(r"<td>URL (.+?)<\/td>", location)
+        if not url_match:
+            continue
         location_info = []
         # lat
         location_info.append(
@@ -26,7 +29,7 @@ def import_kml_files(file_name):
         # url
         location_info.append(
             "<a href="
-            + re.findall(r"<td>URL (.+?)<\/td>", location)[0]
+            + url_match[0]
             + ' style="color: #fff">Climate.OneBuilding.Org</a>'
         )
         # description

pages/lib/layout.py

@@ -260,8 +260,14 @@ def create_navbar():
 
 
 def create_header():
-    return dmc.Group(
-        [
+    return dmc.Flex(
+        justify="flex-start",
+        align="center",
+        gap={"base": "xs", "md": "lg"},
+        wrap="nowrap",
+        direction="row",
+        p="xs",
+        children=[
             dmc.Burger(
                 id=ElementIds.BURGER_BUTTON,
                 size="sm",
@@ -282,14 +288,13 @@ def create_header():
                         c="white",
                     ),
                     dmc.Text(
-                        "Current Location: N/A",
+                        "Location: N/A",
                         id=ElementIds.ID_SELECT_BANNER_SUBTITLE,
                         size="sm",
-                        style={"overflow": "hidden"},
+                        truncate="end",
                         c="white",
                     ),
                 ],
-                p="xs",
             ),
             dmc.Alert(
                 [
@@ -318,7 +323,6 @@ def create_header():
                 style={"zIndex": 1002, "display": "none"},
             ),
         ],
-        pl="md",
     )
 
 
@@ -331,7 +335,7 @@ def create_footer():
 
     footer_links = [
         (
-            "Version: 0.10.1",
+            "Version: 0.10.2",
             "https://center-for-the-built-environment.gitbook.io/clima/version/changelog",
         ),
         ("Contributors", "https://cbe-berkeley.gitbook.io/clima/#contributions"),

pages/lib/template_graphs.py

@@ -425,7 +425,7 @@ def yearly_profile(df, var, global_local, si_ip):
             x=all_dates,
             y=np.array(hi_rh) - np.array(lo_rh),
             base=lo_rh,
-            name="humidity comfort band",
+            name="ASHRAE 160 humidity range",
             marker_opacity=0.3,
             marker_color="silver",
         )

pages/lib/utils.py

@@ -2,9 +2,10 @@
 import functools
 import time
 import math
+from typing import Optional, Tuple, List
 
 import pandas as pd
-from dash import html, dash_table, dcc
+from dash import html, dcc
 import dash_mantine_components as dmc
 
 from config import UnitSystem
@@ -274,27 +275,36 @@ def summary_table_tmp_rh_tab(df, value, si_ip):
         .replace("<sup>", "")
         .replace("</sup>", "")
     )
-    return dash_table.DataTable(
-        columns=[
-            (
-                {"name": i, "id": i}
-                if i == Variables.MONTH.col_name
-                else {"name": f"{i} ({unit})", "id": i}
-            )
-            for i in df_summary.columns
-        ],
-        style_table={"overflowX": "auto"},
-        data=df_summary.to_dict("records"),
-        style_cell={"textAlign": "center", "padding": "5px 10px"},
-        style_cell_conditional=[{"if": {"column_id": "month"}, "textAlign": "right"}],
-        style_header={"backgroundColor": "rgb(220, 220, 220)", "fontWeight": "bold"},
-        style_data_conditional=[
-            {"if": {"row_index": "odd"}, "backgroundColor": "white"},
-            {"if": {"row_index": "even"}, "backgroundColor": "rgb(250, 250, 250)"},
-            {"if": {"row_index": [12]}, "backgroundColor": "rgb(220, 220, 220)"},
-        ],
-        style_as_list_view=True,
-    )
+
+    # Build Mantine table head (add unit to non-month headers)
+    header_cells = []
+    for col in df_summary.columns:
+        if col == Variables.MONTH.col_name:
+            header_cells.append(dmc.TableTh(col))
+        else:
+            header_cells.append(dmc.TableTh(f"{col} ({unit})"))
+    head = dmc.TableThead(dmc.TableTr(header_cells))
+
+    # Build rows from the DataFrame records
+    records = df_summary.round(1).to_dict("records")
+    rows = []
+    for rec in records:
+        cells = []
+        for col in df_summary.columns:
+            val = rec.get(col, "")
+            # Convert NaN to empty string to avoid 'nan' in table
+            if pd.isna(val):
+                display_val = ""
+            else:
+                display_val = val
+            cells.append(dmc.TableTd(display_val))
+        rows.append(dmc.TableTr(cells, tableProps={"align": "center"}))
+
+    body = dmc.TableTbody(rows)
+
+    # Wrap table in a ScrollArea to mimic overflowX:auto behavior
+    table = dmc.Table([head, body], striped=True, highlightOnHover=True)
+    return dmc.ScrollArea(table, style={"width": "100%"})
 
 
 def determine_month_and_hour_filter(month, hour, invert_month, invert_hour):
@@ -359,7 +369,7 @@ def get_default_global_filter_store_data() -> dict:
     }
 
 
-def get_global_filter_state(filter_store_data: dict | None) -> dict:
+def get_global_filter_state(filter_store_data: Optional[dict]) -> dict:
     """Normalize filter store data into a consistent, easy-to-use structure.
 
     Ensures defaults are applied and types are coerced to booleans where appropriate.
@@ -380,8 +390,8 @@ def get_global_filter_state(filter_store_data: dict | None) -> dict:
 
 
 def get_time_filter_from_store(
-    filter_store_data: dict | None,
-) -> tuple[bool, list[int], list[int], bool, bool]:
+    filter_store_data: Optional[dict],
+) -> Tuple[bool, List[int], List[int], bool, bool]:
     """Return normalized time filter arguments from the global filter store.
 
     Returns (time_filter, month, hour, invert_month, invert_hour).

pages/select.py

@@ -265,34 +265,23 @@ def switch_si_ip(_, si_ip_input, url_store, lines):
 )
 def enable_tabs_when_data_is_loaded(meta, data):
     """Hide tabs when data are not loaded"""
-    default = "Current Location: N/A"
-    if data is None:
-        return (
-            True,
-            True,
-            True,
-            True,
-            True,
-            True,
-            True,
-            True,
-            default,
-        )
-    else:
-        return (
-            False,
-            False,
-            False,
-            False,
-            False,
-            False,
-            False,
-            False,
-            "Current Location: "
-            + meta[Variables.CITY.col_name]
-            + ", "
-            + meta[Variables.COUNTRY.col_name],
-        )
+    location_string = "Location: N/A"
+    disable_links = True
+    if data is not None:
+        location_string = f"Location: {meta[Variables.CITY.col_name]}, {meta[Variables.COUNTRY.col_name]}"
+        disable_links = False
+
+    return (
+        disable_links,
+        disable_links,
+        disable_links,
+        disable_links,
+        disable_links,
+        disable_links,
+        disable_links,
+        disable_links,
+        location_string,
+    )
 
 
 @callback(

pages/summary.py

@@ -2,7 +2,7 @@
 import pandas as pd
 import dash_mantine_components as dmc
 import plotly.graph_objects as go
-import requests
+from kgcpy import lookupCZ
 
 from dash.exceptions import PreventUpdate
 from dash_extensions.enrich import dcc, Output, Input, State, callback
@@ -24,6 +24,41 @@
 )
 
 
+KG_DESCRIPTIONS = {
+    "Af": "Tropical rainforest",
+    "Am": "Tropical monsoon",
+    "Aw": "Tropical savanna, dry winter",
+    "As": "Tropical savanna, dry summer",
+    "BWh": "Hot desert",
+    "BWk": "Cold desert",
+    "BSh": "Hot semi-arid steppe",
+    "BSk": "Cold semi-arid steppe",
+    "Csa": "Hot-summer Mediterranean",
+    "Csb": "Warm-summer Mediterranean",
+    "Csc": "Cold-summer Mediterranean",
+    "Cwa": "Monsoon-influenced humid subtropical",
+    "Cwb": "Subtropical highland",
+    "Cwc": "Cold subtropical highland",
+    "Cfa": "Humid subtropical, no dry season",
+    "Cfb": "Temperate oceanic",
+    "Cfc": "Subpolar oceanic",
+    "Dsa": "Hot-summer continental",
+    "Dsb": "Warm-summer continental",
+    "Dsc": "Subarctic",
+    "Dsd": "Extremely cold subarctic",
+    "Dwa": "Monsoon-influenced hot-summer continental",
+    "Dwb": "Monsoon-influenced warm-summer continental",
+    "Dwc": "Monsoon-influenced subarctic",
+    "Dwd": "Monsoon-influenced extremely cold subarctic",
+    "Dfa": "Hot-summer humid continental",
+    "Dfb": "Warm-summer humid continental",
+    "Dfc": "Subarctic boreal",
+    "Dfd": "Extremely cold subarctic boreal",
+    "ET": "Tundra",
+    "EF": "Ice cap",
+}
+
+
 dash.register_page(
     __name__,
     name=PageInfo.SUMMARY_NAME,
@@ -228,12 +263,12 @@ def update_location_info(ts, df, meta, si_ip):
 
     climate_text = ""
     try:
-        r = requests.get(
-            f"http://climateapi.scottpinkelman.com/api/v1/location/{meta[Variables.LAT.col_name]}/{meta[Variables.LON.col_name]}"
+        zone = lookupCZ(
+            float(meta[Variables.LAT.col_name]), float(meta[Variables.LON.col_name])
         )
-        if r.status_code == 200:
-            j = r.json()["return_values"][0]
-            climate_text = f"Köppen-Geiger climate zone: {j['koppen_geiger_zone']}. {j['zone_description']}."
+        desc = KG_DESCRIPTIONS.get(zone, "")
+        if zone and desc:
+            climate_text = f"Köppen-Geiger climate zone: {zone}. {desc}."
     except Exception:
         pass
 

pages/t_rh.py

@@ -86,7 +86,7 @@ def layout():
             ),
             dmc.Skeleton(
                 visible=False,
-                h=450,
+                h=550,
                 children=dmc.Stack(id=ElementIds.TABLE_TMP_HUM),
             ),
         ],