Clean up resources and upgrade dependencies by jasondegraw · Pull Request #22 · Stor4Build/stor4build

jasondegraw · 2026-05-04T21:07:02Z

This is a PR that's needed to happen for a while, and while I generally want to avoid a bunch of unrelated things in a single PR, the need for pretty much everything arose all at once. Python 3.8 is past end of life, so reliance on that is not great. Moving to newer Ubuntu VMs has lead to a bunch of certificate-related complications and failures, so enabling Windows development of as much as possible is really needed. So this PR does the following:

Enables development of the command-line tool on Windows.
Upgrades to OpenStudio 3.11 and Python 3.12, my development machines are now using hatch to manage the Python version. This closes The current code is locked into an old Python version #21
Reorganizes the resources directory and puts all the plugins in a plugins directory, closing Resources directory cleanup #8
Since moving the demo plugin required checking, that's been added to the "full" command line, closing Add the demo plugin to the command line tools #3
Similarly, it made sense to document the plugin in the docs directory, closing Demonstrate and document the demo plugin #5
Upgraded all of the OSMs in the repo to version 3.11. These will need to be regenerated by 3.11 at some point, but that can be dealt with as the API is transitioned to the new version.

The big caveat here is that the API needs some attention before it will work. That will come in a separate PR. For now, there is now an OpenStudio-3.8 branch where the working version of the API (using Python 3.8 and OpenStudio 3.7) until the API can be updated.

Once this PR goes in, there are two issues that need to be put in:

The models need to be properly regenerated.
The API needs to be updated for OpenStudio 3.11.

Also note that the name of the branch really should have been openstudio-coalition-1-11, but I thought it was too long.

The main thing to "fix" was the idiotic addition of "validation" to the OSW that kills runs that will work fine.

jasondegraw

Walkthrough of the changes.

jasondegraw · 2026-05-04T23:48:37Z

This Markdown file documents the basics of what the demo plugin is doing.

jasondegraw · 2026-05-04T23:50:57Z

    args << strg_medium
+
+    # create argument for custom site packages
+    custom_site = OpenStudio::Measure::OSArgument.makeStringArgument(


The original code was setting the site packages based on the operating system, which is fine, but if we want more flexibility we need a way to use custom locations. This argument provides a way to pass that information in.

jasondegraw · 2026-05-04T23:52:09Z

    strg_medium = runner.getStringArgumentValue('strg_medium', usr_args)
+    custom_site_packages = runner.getStringArgumentValue('custom_site_packages', usr_args).strip()
+
+    if custom_site_packages.length == 0


If nothing is passed in, it falls back to the old locations with the Python 3.8 hardcode.

jasondegraw · 2026-05-04T23:53:26Z

-        )
-      end
-      no.setString(5, File.join(p, 'resources'))
+      no.setString(4, custom_site_packages)


Here's where the custom location is added into the model, then the next two lines take care of the thermal tank code and then any controls that might be needed.

jasondegraw · 2026-05-04T23:54:13Z

All of the OSMs have been updated with the OpenStudio CLI, these are the original 3.7 models.

jasondegraw · 2026-05-04T23:56:33Z

All of the plugin-related Python code has been moved to the plugins directory.

I like the organization

jasondegraw · 2026-05-05T00:01:10Z

+import dataclasses
+from typing import Dict, Union
+
+@dataclasses.dataclass


At some point, a "validation" was introduced into OpenStudio that rejects schema-acceptable workflow files, so I had to add some order to the measures.

jasondegraw · 2026-05-05T00:02:50Z

@@ -50,9 +50,17 @@ def __init__(self, name, pre_steps=None, post_steps=None, **kwargs):
        else:
            self.charge_temp = freezing_temp[self.storage_medium] + charge_temp_delta[self.store_ice]
        self.sizing = kwargs.get('sizing', {})
+        # The plug-in needs some packages, let's find where they SHOULD be


This code uses the Python site package to work out where the site-packages directory is. I'm currently using the presence of numpy as a test, which is a little lame but serviceable.

jasondegraw · 2026-05-05T00:03:41Z

-        output_steps.extend([el.to_dict() for el in self.steps])
+        energyplus_measures = []
+        reporting_measures = []
+        for step in self.steps:


This sorting is a bit of a hack and should probably be done better, but it is good enough for now.

jasondegraw · 2026-05-05T00:10:39Z

@@ -49,6 +49,7 @@ stor4build = "stor4build.cli:s4b"
 path = "src/stor4build/__about__.py"

 [tool.hatch.envs.default]
+python = "3.12"


This is the where the specification of the Python version we need is. When transitioning to this, I needed to rebuild the virtual environments from scratch, just updating didn't seem to work.

Do we want this to be 3.8 so it aligns with the python that E+ is using?

bonnema

Looks good to me, really only one comment that might need a reply.

jasondegraw added 7 commits May 2, 2026 00:28

Fix things for OpenStudio 3.11

91f47f9

The main thing to "fix" was the idiotic addition of "validation" to the OSW that kills runs that will work fine.

Fix tests

7f633c0

Start moving the Python sources to a plugins dir

80344ac

Add a doc file and shift locations around a bit

970cf95

Add images

8ff0b24

Enhance documentation with results

2d9bec3

Add back in the old versions of the files

bc2f984

jasondegraw commented May 5, 2026

View reviewed changes

jasondegraw marked this pull request as ready for review May 5, 2026 00:14

jasondegraw requested a review from bonnema May 5, 2026 00:14

jasondegraw added enhancement New feature or request priority: high Requires attention labels May 5, 2026

bonnema reviewed May 5, 2026

View reviewed changes

Conversation

jasondegraw commented May 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jasondegraw left a comment

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!

bonnema left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

jasondegraw commented May 4, 2026 •

edited

Loading