openstudio-ee 0.12.0 → 0.12.4

data/lib/measures/window_enhancement/resources/calculate_perimeter.py

@@ -0,0 +1,39 @@
+# save this function for wall construction
+def calculate_geometry(self, sub_surface):
+    """
+    Calculate the length, width, perimeter, and area of the window from its vertices.
+    Assumes the window is a quadrilateral (typically a rectangle).
+    """
+    vertices = sub_surface.vertices()
+    if len(vertices) != 4:
+        return {
+            "length": 0.0,
+            "width": 0.0,
+            "perimeter": 0.0,
+            "area": 0.0
+        }
+
+    # Calculate all edge lengths
+    edge_lengths = []
+    perimeter = 0.0
+    for i in range(4):
+        v1 = vertices[i]
+        v2 = vertices[(i + 1) % 4]
+        edge = v2 - v1
+        length = edge.length()
+        edge_lengths.append(length)
+        perimeter += length
+
+    # Assume opposite edges are equal, so we can group into two unique lengths
+    length = max(edge_lengths)
+    width = min(edge_lengths)
+
+    # Area = length × width
+    area = length * width
+
+    return {
+        "length": length,
+        "width": width,
+        "perimeter": perimeter,
+        "area": area
+    }

data/lib/measures/window_enhancement/test_output.log

@@ -0,0 +1,39 @@
+**************API_TOKEN*************
+"5fk7wP4cJg6pcmx6ncZN0ftMdoVR8u"
+**************IGU_URL*************
+"https://api.buildingtransparency.org/api/materials?page_number=1&page_size=100&mf=!EC3%20search(%22InsulatingGlazingUnits%22)%20WHERE%20%0A%20%20jurisdiction%3A%20IN(%22021%22)%20AND%0A%20%20epd__date_validity_ends%3A%20%3E%20%222024-12-05%22%20AND%0A%20%20epd_types%3A%20IN(%22Product%20EPDs%22)%20!pragma%20eMF(%222.0%2F1%22)%2C%20lcia(%22TRACI%202.1%22)"
+**************WFRAME_URL*************
+"aaa"
+**********************HEADERS**************************
+{'Accept': 'application/json', 'Authorization': 'Bearer 5fk7wP4cJg6pcmx6ncZN0ftMdoVR8u'}
+test_number_of_arguments_and_argument_names() method level...
+test_good_argument_values() method level...
+user_arguments:  igu_component_name (IGU Component Name)
+String, Required
+Value: 
+
+user_arguments:  frame_cross_section_area (Frame Cross Section Area (m�))
+Double, Required
+Value: 
+
+user_arguments:  frame_perimeter_length (Frame Perimeter Length (m))
+Double, Required
+Value: 
+
+user_arguments:  declared_unit (Declared Unit for GWP)
+String, Required
+Value: 
+
+user_arguments:  gwp (Global Warming Potential (GWP) Value)
+Double, Required
+Value: 
+
+user_argument: declared_unit = m2
+user_argument: frame_cross_section_area = 0.02
+user_argument: frame_perimeter_length = 10
+user_argument: gwp = 0
+user_argument: igu_component_name = TestIGU
+Measure result: Success
+Modified model saved to: C:\All_repos\openstudio-ee-gem\lib\measures\window_enhancement\tests\output\example_model_with_enhancements.osm
+Running test_measure_changes_building()...
+Measure success: Fail

data/lib/openstudio/ee_measures/version.rb

@@ -7,6 +7,6 @@
 
 module OpenStudio
   module EeMeasures
-    VERSION = '0.12.0'
+    VERSION = '0.12.4'
   end
 end

data/openstudio-ee.gemspec

@@ -12,10 +12,11 @@ Gem::Specification.new do |spec|
   spec.summary       = 'Library and measures for OpenStudio for energy efficiency use cases'
   spec.description   = 'Library and measures for OpenStudio for energy efficiency use cases'
   spec.metadata = {
-      'bug_tracker_uri' => 'https://github.com/NREL/openstudio-ee-gem/issues',
-      'changelog_uri' => 'https://github.com/NREL/openstudio-ee-gem/blob/develop/CHANGELOG.md',
-      # 'documentation_uri' =>  'https://www.rubydoc.info/gems/openstudio-ee-gem/#{gem.version}',
-      'source_code_uri' => "https://github.com/NREL/openstudio-ee-gem/tree/v#{spec.version}"
+    'bug_tracker_uri' => 'https://github.com/NREL/openstudio-ee-gem/issues',
+    'changelog_uri' => 'https://github.com/NREL/openstudio-ee-gem/blob/develop/CHANGELOG.md',
+    # 'documentation_uri' =>  'https://www.rubydoc.info/gems/openstudio-ee-gem/#{gem.version}',
+    'source_code_uri' => "https://github.com/NREL/openstudio-ee-gem/tree/v#{spec.version}",
+    'rubygems_mfa_required' => 'true'
   }
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
@@ -28,15 +29,16 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '~> 3.2.2'
 
   spec.add_dependency 'bundler', '~> 2.4.10'
-  spec.add_dependency 'openstudio-extension', '~> 0.9.1'
-  spec.add_dependency 'openstudio-standards', '0.8.2'
   spec.add_dependency 'multipart-post', '2.4.0'
+  spec.add_dependency 'openstudio-extension', '~> 0.9.3'
+  spec.add_dependency 'openstudio-standards', '0.8.2'
 
+  spec.add_development_dependency 'octokit', '4.18.0' # for change logs
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.9'
   spec.add_development_dependency 'rubocop', '1.50'
   spec.add_development_dependency 'rubocop-checkstyle_formatter', '0.6.0'
   spec.add_development_dependency 'rubocop-performance', '1.20.0'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.6.0'
   spec.add_development_dependency 'simplecov', '0.22.0'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec', '~> 3.9'
-  spec.add_development_dependency 'octokit', '4.18.0' # for change logs
 end

data/test-workflow-locally.sh

@@ -0,0 +1,152 @@
+#!/bin/bash
+
+# Local workflow testing script
+# This script tests the key components of the GitHub Actions workflow locally
+
+set -e
+
+echo "🔍 Testing OpenStudio EE Gem Workflow Components Locally"
+echo "========================================================"
+
+# Test 1: Check Docker image availability
+echo "1. Testing Docker image availability..."
+
+# Check if images are already available locally
+if docker images --format "table {{.Repository}}:{{.Tag}}" | grep -q "nrel/openstudio:develop"; then
+    echo "✅ nrel/openstudio:develop image found locally"
+    DOCKER_IMAGE="nrel/openstudio:develop"
+elif docker images --format "table {{.Repository}}:{{.Tag}}" | grep -q "nrel/openstudio:3.10.0"; then
+    echo "✅ nrel/openstudio:3.10.0 image found locally"
+    DOCKER_IMAGE="nrel/openstudio:3.10.0"
+else
+    echo "⚠️  No local OpenStudio Docker images found. Attempting to pull..."
+    
+    # Try to pull the develop image
+    if docker pull nrel/openstudio:develop 2>/dev/null; then
+        echo "✅ Successfully pulled nrel/openstudio:develop image"
+        DOCKER_IMAGE="nrel/openstudio:develop"
+    else
+        echo "❌ Failed to pull nrel/openstudio:develop image"
+        echo "   This might be due to:"
+        echo "   - Repository requires authentication (docker login)"
+        echo "   - Network connectivity issues"
+        echo "   - Repository access restrictions"
+        
+        # Try fallback to 3.10.0
+        echo "   Trying fallback to nrel/openstudio:3.10.0..."
+        if docker pull nrel/openstudio:3.10.0 2>/dev/null; then
+            echo "✅ Successfully pulled nrel/openstudio:3.10.0 image"
+            DOCKER_IMAGE="nrel/openstudio:3.10.0"
+        else
+            echo "❌ Failed to pull any OpenStudio Docker image"
+            echo ""
+            echo "🔧 To fix this issue:"
+            echo "   1. Check if you need to run 'docker login' for private registries"
+            echo "   2. Verify network connectivity to Docker Hub"
+            echo "   3. Contact your system administrator about Docker registry access"
+            echo ""
+            echo "⏭️  Skipping Docker-based tests. The GitHub Actions workflow will"
+            echo "   run in the GitHub environment which should have proper access."
+            exit 0
+        fi
+    fi
+fi
+
+DOCKER_IMAGE="${DOCKER_IMAGE:-nrel/openstudio:develop}"
+echo "Using Docker image: $DOCKER_IMAGE"
+
+# Test 2: Run basic container commands
+echo ""
+echo "2. Testing basic container functionality..."
+docker run --rm -v "$(pwd):/workspace" -w /workspace "$DOCKER_IMAGE" bash -c "
+    echo 'Container started successfully'
+    echo 'Ruby Version:' \$(ruby -v)
+    echo 'Bundle Version:' \$(bundle -v)
+    echo 'OpenStudio Version:' \$(openstudio openstudio_version)
+    echo 'Listing OpenStudio Gems:' \$(openstudio gem_list)
+"
+
+# Test 3: Test locale setup
+echo ""
+echo "3. Testing locale configuration..."
+docker run --rm -u root "$DOCKER_IMAGE" bash -c "
+    apt-get update -qq
+    apt-get install -y locales
+    locale-gen en_US.UTF-8
+    echo 'Locale setup completed'
+    locale -a | grep en_US
+"
+
+# Test 4: Test bundle install
+echo ""
+echo "4. Testing bundle install..."
+docker run --rm -v "$(pwd):/workspace" -w /workspace "$DOCKER_IMAGE" bash -c "
+    if bundle install; then
+        echo '✅ Bundle install successful'
+        bundle list
+    else
+        echo '❌ Bundle install failed'
+        exit 1
+    fi
+"
+
+# Test 5: Test basic rake tasks (if available)
+echo ""
+echo "5. Testing rake tasks availability..."
+docker run --rm -v "$(pwd):/workspace" -w /workspace "$DOCKER_IMAGE" bash -c "
+    bundle install
+    echo 'Available rake tasks:'
+    bundle exec rake -T | head -10
+"
+
+# Test 6: Local environment validation (fallback if Docker fails)
+if [ "$DOCKER_IMAGE" = "" ]; then
+    echo ""
+    echo "6. Testing local Ruby environment (Docker unavailable)..."
+    
+    # Check Ruby version
+    if command -v ruby >/dev/null 2>&1; then
+        echo "Ruby Version: $(ruby -v)"
+    else
+        echo "❌ Ruby not found in local environment"
+    fi
+    
+    # Check Bundle version
+    if command -v bundle >/dev/null 2>&1; then
+        echo "Bundle Version: $(bundle -v)"
+        
+        # Test bundle install
+        if bundle check >/dev/null 2>&1 || bundle install; then
+            echo "✅ Bundle dependencies satisfied"
+            
+            # List available rake tasks
+            echo "Available rake tasks:"
+            bundle exec rake -T | head -5
+        else
+            echo "❌ Bundle install failed"
+        fi
+    else
+        echo "❌ Bundler not found in local environment"
+    fi
+fi
+
+echo ""
+echo "🎉 Local workflow testing completed!"
+echo ""
+echo "📝 Notes:"
+echo "   - Docker image testing completed (using $DOCKER_IMAGE)"
+echo "   - All basic commands work as expected"
+echo "   - Bundle install succeeds"
+echo "   - Ready for GitHub Actions testing"
+echo ""
+echo "⚠️  To test the full workflow:"
+echo "   1. Push changes to a test branch"
+echo "   2. Monitor the GitHub Actions run"
+echo "   3. Check the S3 bucket for uploaded results"
+echo ""
+echo "🔍 Alternative local testing (without Docker):"
+echo "   If Docker testing failed, you can still validate the workflow logic:"
+echo "   1. Check that bundle install works: bundle install"
+echo "   2. List available rake tasks: bundle exec rake -T"
+echo "   3. Test individual rake tasks if available"
+echo "   4. The GitHub Actions environment should have proper Docker access"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openstudio-ee
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.12.4
 platform: ruby
 authors:
 - David Goldwasser
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-08-02 00:00:00.000000000 Z
+date: 2025-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,20 +25,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.4.10
+- !ruby/object:Gem::Dependency
+  name: multipart-post
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: openstudio-extension
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.9.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.9.3
 - !ruby/object:Gem::Dependency
   name: openstudio-standards
   requirement: !ruby/object:Gem::Requirement
@@ -54,117 +68,117 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.8.2
 - !ruby/object:Gem::Dependency
-  name: multipart-post
+  name: octokit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.4.0
-  type: :runtime
+        version: 4.18.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 4.18.0
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.50'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.50'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-checkstyle_formatter
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '3.9'
 - !ruby/object:Gem::Dependency
-  name: rubocop-performance
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.20.0
+        version: '1.50'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.20.0
+        version: '1.50'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubocop-checkstyle_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.22.0
+        version: 0.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.22.0
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: 1.20.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: 1.20.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: 0.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
-  name: octokit
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.18.0
+        version: 0.22.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.18.0
+        version: 0.22.0
 description: Library and measures for OpenStudio for energy efficiency use cases
 email:
 - david.goldwasser@nrel.gov
@@ -173,16 +187,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coverage"
 - ".github/workflows/test-with-openstudio.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
-- Jenkinsfile
 - LICENSE.md
 - README.md
 - Rakefile
+- WORKFLOW_CHANGES.md
 - doc_templates/LICENSE.md
 - doc_templates/README.md.erb
 - doc_templates/copyright_erb.txt
@@ -324,17 +339,31 @@ files:
 - lib/measures/replace_water_heater_mixed_with_thermal_storage_chilled_water/README.md.erb
 - lib/measures/replace_water_heater_mixed_with_thermal_storage_chilled_water/measure.rb
 - lib/measures/replace_water_heater_mixed_with_thermal_storage_chilled_water/measure.xml
+- lib/measures/window_enhancement/LICENSE.md
+- lib/measures/window_enhancement/README.md
+- lib/measures/window_enhancement/docs/.gitkeep
+- lib/measures/window_enhancement/measure.py
+- lib/measures/window_enhancement/measure.xml
+- lib/measures/window_enhancement/resources/EC3_lookup.py
+- lib/measures/window_enhancement/resources/Test_API.py
+- lib/measures/window_enhancement/resources/__pycache__/EC3_lookup.cpython-39.pyc
+- lib/measures/window_enhancement/resources/__pycache__/Original_EC3_lookup.py
+- lib/measures/window_enhancement/resources/__pycache__/Test_API.cpython-39.pyc
+- lib/measures/window_enhancement/resources/calculate_perimeter.py
+- lib/measures/window_enhancement/test_output.log
 - lib/openstudio-ee-measures.rb
 - lib/openstudio/ee_measures.rb
 - lib/openstudio/ee_measures/extension.rb
 - lib/openstudio/ee_measures/version.rb
 - openstudio-ee.gemspec
+- test-workflow-locally.sh
 homepage: https://openstudio.net
 licenses: []
 metadata:
   bug_tracker_uri: https://github.com/NREL/openstudio-ee-gem/issues
   changelog_uri: https://github.com/NREL/openstudio-ee-gem/blob/develop/CHANGELOG.md
-  source_code_uri: https://github.com/NREL/openstudio-ee-gem/tree/v0.12.0
+  source_code_uri: https://github.com/NREL/openstudio-ee-gem/tree/v0.12.4
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:

data/Jenkinsfile

@@ -1,11 +0,0 @@
-//Jenkins pipelines are stored in shared libraries. Please see: https://github.com/NREL/cbci_jenkins_libs
- 
-@Library('cbci_shared_libs') _
-
-// Build for PR to develop branch only. 
-if ((env.CHANGE_ID) && (env.CHANGE_TARGET) ) { // check if set
-
-  openstudio_extension_gems()
-    
-}
-