Tweaks 'genConstruction' (tested) by brgix · Pull Request #7 · rd2/pyOSut

brgix · 2025-08-05T15:18:35Z

Around 40-odd typos (and other oddities) were identified in the original Ruby implementation of OSut, while developing this Python counterpart. In some cases, these are simple fixes in the Ruby code (no impact on the Python implementation). In other cases (like this first commit), they reveal weaknesses (to fix), such as not adequately catching bad user input. Over the next day or so, a number of such fixes are expected to be introduced, before re-releasing an upcoming pyOSut v0.6.1.

brgix · 2025-08-05T15:33:17Z

src/osut/osut.py


    elif specs["type"] == "window":
-        a["glazing"]["u"   ]  = specs["uo"]
+        a["glazing"]["u"   ]  = u if u else uo()["window"]


A user could set a glazing assembly's specs["uo"] to None. This is caught and reset here.

brgix · 2025-08-05T15:36:32Z

src/osut/osut.py

-    if not a["glazing"]:
-        ro = 1 / specs["uo"] - film()[specs["type"]] if specs["uo"] else 0
+    if u and not a["glazing"]:
+        ro = 1 / u - flm


For opaque construction, adjusting insulating layer thickness (to meet a requested assembly Uo factor) is skipped entirely if the requested Uo isn't:

successfully converted to a float

within postulated (acceptable) range

brgix · 2025-08-05T15:38:36Z

tests/test_osut.py

+        self.assertEqual(len(c.layers()), 1)
+        self.assertEqual(c.layers()[0].nameString(), "OSut.skylight.U3.5.SHGC45")
+        r = osut.rsi(c)
+        self.assertAlmostEqual(r, 1/osut.uo()["skylight"], places=3)


In the case of fenestrated assemblies, an invalid Uo request is ignored and the glazing assembly inherits a default OSut Uo (here 3.5 W/m2.K for a skylight).

brgix · 2025-08-06T13:57:03Z

src/osut/osut.py

        - "max" (float): max temperature. (None if invalid inputs - see logs).
    """
-    mth  = "osut.scheduleCompactMinMax"
+    mth  = "osut.scheduleIntervalMinMax"


brgix · 2025-08-06T14:00:09Z

src/osut/osut.py


    # Once joined, re-adjust Z-axis coordinates.
-    if abs(z) > CN.TOL:
+    if round(z, 2) != 0.00:


More appropriate.

brgix · 2025-08-06T14:02:10Z

tests/test_osut.py

+        # Test 'fixed interval' schedule. Annual time series - no variation.
+        start  = model.getYearDescription().makeDate(1, 1)
+        inter  = openstudio.Time(0, 1, 0, 0)
+        values = openstudio.createVector([22.78] * 8760)


OSut enabled ScheduleFixedInterval checks, e.g.:

min/max setpoint temperatures

is space UNCONDITIONED, etc.

Yet no unit test had been in place.

brgix · 2025-08-06T14:02:33Z

tests/test_osut.py

        translator = openstudio.osversion.VersionTranslator()

-        path   = openstudio.path("./tests/files/osms/out/seb2.osm")
+        path   = openstudio.path("./tests/files/osms/out/seb_ext2.osm")


Harmonizing with Ruby test.

brgix · 2025-08-06T14:11:16Z

src/osut/osut.py

        try:
            value = float(values[i])
-            value = vals.append(value)
+            vals.append(value)


brgix · 2025-08-09T12:26:34Z

tests/test_osut.py

+        self.assertTrue("str? expecting dict" in o.logs()[0]["message"])
+        self.assertTrue(isinstance(slab, openstudio.Point3dVector))
+        self.assertFalse(slab)
+        self.assertEqual(o.clean(), DBG)


Stress-test: when requested floor plates (input) aren't dictionaries.

brgix · 2025-08-09T12:27:33Z

src/osut/osut.py

-    # if xa1b2.length() < CN.TOL2:
-    #     if isPointAlongSegment(a1, [a2, b2]): return None
-    #     if isPointAlongSegment(a2, [a1, b2]): return None
-


Now redundant checks.

brgix · 2025-08-09T19:35:45Z

src/osut/osut.py

    except:
-        return oslg.mismatch("n unique points", n, int, mth, CN.DBG, v)
+        oslg.mismatch("n points", n, int, mth, CN.DBG)
+        n = 0


There are 3 OSut functions that take in n as argument:

uniques(pts, n=0):

collinear(pts, n=0)

noncollinears(pts, n=0)

... where n is an (optional) user-requested number of points to return. For instance, a user may request the first 3 points of a hexagon (6 points) to determine a plane equation.

Unfortunately, all three functions did not share the same validation checks and treatment of n - an inconsistency and source of confusion. Furthermore, DEBUG or ERROR messages shouldn't be logged when users incorrectly guess in advance what the admissible range of points may be. So these changes:

reduce the volume a bit

harmonize the treatment of n across all three methods

introduces stress tests

brgix · 2025-08-11T12:20:41Z

src/osut/osut.py

+        for vt in pts.vertices():
+            pt = openstudio.Point3d(vt.x(), vt.y(), vt.z())
+            v.append(pt)
+        return v


No point in validating planar surface .vertices() individually.

brgix · 2025-08-11T12:24:49Z

src/osut/osut.py

-    if not isSegment(sg):
-        return oslg.mismatch("segment", sg, cl2, mth, CN.DBG, False)
-
+    if not isSegment(sg): return False


Lowering the log volume: isPointAlongSegment calls isSegment, which in turn calls p3Dv. The latter will log an inadmissible object.

brgix · 2025-08-11T12:25:31Z

src/osut/osut.py

        return oslg.empty("segments", mth, CN.DBG, False)
    if not isinstance(p0, cl1):
-        return oslg.mismatch("point", p0, cl, mth, CN.DBG, False)
+        return oslg.mismatch("point", p0, cl1, mth, CN.DBG, False)


Oops. No cl variable.

brgix · 2025-08-11T12:26:59Z

tests/test_osut.py

+        # Valid case #1: a single Point3d.
+        vtx = osut.p3Dv(p0)
+        self.assertTrue(isinstance(vtx, openstudio.Point3dVector))
+        self.assertEqual(vtx[0], p0) # same object ID


All 4 valid p3Dv use cases systematically return an openstudio.Point3dVector (and not occasionally a list).

brgix · 2025-08-12T12:26:00Z

src/osut/osut.py


    # A bounded box's 'height', at its narrowest, is its 'width'.
-    return height(box)
+    return height(res["box"])


Missing key piece.

brgix · 2025-08-12T12:30:35Z

tests/test_osut.py

+        # Achtung! The function can be time consuming (multiple iterations) for
+        # very convoluted spaces (e.g. long corridors with multiple concavities).
+        self.assertAlmostEqual(osut.spaceHeight(fine), 8.53, places=2)
+        self.assertAlmostEqual(osut.spaceWidth(fine), 21.33, places=2)


The value returned by spaceHeight (8.53 m) corresponds to the tallest floor-to-ceiling distance (along Z-axis).

The floor section circumscribed (and crisscrossed) with red dotted lines corresponds to the largest bounded box that fits in the (large) L-shaped floor surface. The length of the narrowest edge of this bounded box (21.33 m) is what spaceWidth returns.

brgix · 2025-08-12T12:32:17Z

tests/test_osut.py

+        self.assertAlmostEqual(osut.alignedHeight(floor), 6.88, places=2)
+        self.assertAlmostEqual(osut.alignedWidth(floor), 8.22, places=2)
+        self.assertAlmostEqual(osut.spaceHeight(openarea), 3.96, places=2)
+        self.assertAlmostEqual(osut.spaceWidth(openarea), 3.77, places=2)


in red: full height of space, including skylight wells

in green: width of bounding box of space floor(s) ... outline is very approximate!

in blue: width of largest bounded box that can fit within grouped floor surfaces

The latter is retained here as the most adequate measure of what could be considered a room's width, e.g. for LPD adjustment calculations.

brgix · 2025-08-13T14:00:50Z

pyproject.toml

 maintainers = [ {name = "Denis Bourgeois", email = "denis@rd2.ca"} ]
-dependencies = ["oslg","openstudio>=3.6.1"]
+# dependencies = ["oslg","openstudio>=3.6.1"]
+dependencies = ["oslg"]


Setting aside OpenStudio as a dependency.

brgix · 2025-08-13T14:02:34Z

.github/workflows/pull_request.yml

@@ -22,39 +22,3 @@ jobs:
        run: python -m pip install --upgrade pip setuptools wheel oslg openstudio
      - name: Run unit tests
        run: python -m unittest


Unsuccessful in pulling more than one OpenStudio SDK package/module. Sticking to latest version for now.

Tweaks 'genConstruction' (tested)

31fe98c

brgix self-assigned this Aug 5, 2025

brgix added the enhancement New feature or request label Aug 5, 2025

brgix mentioned this pull request Aug 5, 2025

Tweaks 'genConstruction' (tested) rd2/osut#22

Merged

brgix commented Aug 5, 2025

View reviewed changes

Fixes ScheduleInterval methods/tests

0ca5976

brgix commented Aug 6, 2025

View reviewed changes

src/osut/osut.py

# Once joined, re-adjust Z-axis coordinates.

if abs(z) > CN.TOL:

if round(z, 2) != 0.00:

Copy link

Member Author

brgix Aug 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

More appropriate.

brgix commented Aug 6, 2025

View reviewed changes

Tweaks ScheduleInterval fix

01f0f11

brgix commented Aug 6, 2025

View reviewed changes

src/osut/osut.py

try:

value = float(values[i])

value = vals.append(value)

vals.append(value)

Copy link

Member Author

brgix Aug 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Better.

brgix added 2 commits August 9, 2025 08:08

Tweaks line intersection + tests

f36e9a2

Deletes commented out lines

d4634be

brgix commented Aug 9, 2025

View reviewed changes

Harmonizes n 'uniques' vs n 'collinears'

a57c25c

brgix commented Aug 9, 2025

View reviewed changes

brgix added 2 commits August 10, 2025 14:52

Prep work for further harmonization with Ruby OSut

3c630f9

Tweaks p3Dv (+ stress tests)

02b8023

brgix commented Aug 11, 2025

View reviewed changes

brgix added 3 commits August 11, 2025 08:50

Updates version

ab70a66

Fixes (& tests) space width/height

a33b3b0

Cleanup

efacdf8

brgix commented Aug 12, 2025

View reviewed changes

brgix added 14 commits August 12, 2025 08:34

Renames space height/width unit test

b294f50

Bumps version to v070

8214f2f

Removes OpenStudio as dependency

7a35d64

Removes OpenStudio as dependency (redux)

7fbf1a2

Removes OpenStudio as dependency (p3)

3721304

Cleanup

c212c30

Tests GH Actions matrix (OS versions)

c2129da

Tests GH Actions matrix (OS versions) (redux)

5c33a23

Tests GH Actions matrix (OS versions) (p3)

f24ad09

Reverts to previous GH with OpenStudio versions

10087e1

Simplifies GH Actions

512e84b

Updates README

bb299a7

Adapts GH Actions for older OS versions

e4df93b

Reverts to OpenStudio latest

1c3d672

brgix commented Aug 13, 2025

View reviewed changes

brgix merged commit 240fcac into develop Aug 13, 2025
2 checks passed

brgix deleted the v061 branch August 13, 2025 14:05

Conversation

brgix commented Aug 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

brgix Aug 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

brgix commented Aug 5, 2025 •

edited

Loading

brgix Aug 5, 2025 •

edited

Loading