osut 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9e23061febdcbf30770082f0fccb3b16aabd5fd18a8f9ae7decdf3b268703e02
+  data.tar.gz: 0e672c27b10625c3b287f160362c8fcc4619062fe169b3681c90f5fa9fcf45f4
+SHA512:
+  metadata.gz: fda291e260dfabb52f7a01f7ab68120475e60e82db082287df2a1647a6254b0f7e8585b23aa32e75001ec1ef6b0c9c5802606bfe1c2f0181d960e5752633d043
+  data.tar.gz: 74c78f3af6ca9e73d97f9b4f5f28c45f05e5002326ebeaa9b731ce1d6143b97595f2eb6af309fe799c280c04b8a3a233444d213372e8d77264568e49d9f3f5db

data/.gitattributes

@@ -0,0 +1,3 @@
+* text=auto
+*.rb text
+text eol=lf

data/.github/workflows/pull_request.yml

@@ -0,0 +1,72 @@
+name: Pull Request CI
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test_300x:
+    runs-on: ubuntu-18.04
+    steps:
+    - name: Check out repository
+      uses: actions/checkout@v2
+    - name: Run Tests
+      run: |
+        echo $(pwd)
+        echo $(ls)
+        docker pull nrel/openstudio:3.0.0
+        docker run --name test --rm -d -t -v $(pwd):/work -w /work nrel/openstudio:3.0.0
+        docker exec -t test pwd
+        docker exec -t test ls
+        docker exec -t test bundle update
+        docker exec -t test bundle exec rake
+        docker kill test
+  test_321x:
+    runs-on: ubuntu-18.04
+    steps:
+    - name: Check out repository
+      uses: actions/checkout@v2
+    - name: Run Tests
+      run: |
+        echo $(pwd)
+        echo $(ls)
+        docker pull nrel/openstudio:3.2.1
+        docker run --name test --rm -d -t -v $(pwd):/work -w /work nrel/openstudio:3.2.1
+        docker exec -t test pwd
+        docker exec -t test ls
+        docker exec -t test bundle update
+        docker exec -t test bundle exec rake
+        docker kill test
+  test_330x:
+    runs-on: ubuntu-18.04
+    steps:
+    - name: Check out repository
+      uses: actions/checkout@v2
+    - name: Run Tests
+      run: |
+        echo $(pwd)
+        echo $(ls)
+        docker pull nrel/openstudio:3.3.0
+        docker run --name test --rm -d -t -v $(pwd):/work -w /work nrel/openstudio:3.3.0
+        docker exec -t test pwd
+        docker exec -t test ls
+        docker exec -t test bundle update
+        docker exec -t test bundle exec rake
+        docker kill test
+  test_340x:
+    runs-on: ubuntu-18.04
+    steps:
+    - name: Check out repository
+      uses: actions/checkout@v2
+    - name: Run Tests
+      run: |
+        echo $(pwd)
+        echo $(ls)
+        docker pull nrel/openstudio:3.4.0
+        docker run --name test --rm -d -t -v $(pwd):/work -w /work nrel/openstudio:3.4.0
+        docker exec -t test pwd
+        docker exec -t test ls
+        docker exec -t test bundle update
+        docker exec -t test bundle exec rake
+        docker kill test

data/.gitignore

@@ -0,0 +1,11 @@
+Gemfile.lock
+.rspec_status
+.bundle
+pkg
+
+.yardoc
+_yardoc
+doc/
+rdoc
+
+.DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2022, Denis Bourgeois
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,54 @@
+# osut
+
+General purpose Ruby utilities for [OpenStudio](https://openstudio.net) [Measures](https://nrel.github.io/OpenStudio-user-documentation/reference/measure_writing_guide/) or other OpenStudio [SDK](https://openstudio-sdk-documentation.s3.amazonaws.com/index.html) applications. Compatible with SDK v3.0.0 (or newer) and OpenStudio Application [releases](https://github.com/openstudiocoalition/OpenStudioApplication/releases?page=2) distributed by the [OpenStudio Coalition](https://openstudiocoalition.org).
+
+Add:
+
+```
+gem "osut", git: "https://github.com/rd2/osut", branch: "main"
+```
+
+... in a v2.1 [bundled](https://bundler.io) _Measure_ development environment "Gemfile" (or instead as a _gemspec_ dependency), and then run:
+
+```
+bundle install (or 'bundle update')
+```
+### Recommended use
+
+As a Ruby module, one can access __osut__ by extending a _Measure_ module or class:
+
+```
+require osut
+
+module M
+  extend OSut
+  ...
+end
+```
+The logger module [oslg](https://github.com/rd2/oslg) is an __osut__ dependency. _Measure_ developers can (optionally) choose to log debug, informative, warning or error messages from within an __osut__-extended module or class, e.g.:
+
+```
+M.log(OSut::WARN, "Calculated material thickness > 1m")
+```
+... and then decide (at any given stage in the _Measure_) what to log to the OpenStudio runner, vs an automatically-generated results report (e.g. for code compliance), vs a bug report.
+
+### Features
+
+Roughly half of the __osut__ methods extract useful _zoning_ information from OpenStudio models (.osm files), e.g.:
+- is a given space part of a CONDITIONED thermal zone?
+- if CONDITIONED, what are its MIN/MAX heating/cooling setpoint temperatures?
+- is it instead a _plenum_? or otherwise UNCONDITIONED?
+
+Most of these _zoning_ queries are adapted from [OpenStudio Standards](https://github.com/NREL/openstudio-standards/blob/master/lib/openstudio-standards/standards/Standards.ThermalZone.rb), providing key inputs to _Measures_ (or gems) such as _Thermal Bridging & Derating_ (or [TBD](https://github.com/rd2/tbd)).
+
+The remaining methods deal mainly with constructions & materials, or surface geometry, e.g.:  
+
+- what is the calculated R-value of a construction?
+- are any layered materials in a construction MASSLESS?
+- which one of these layered materials is considered the most insulating?
+- what is the total thickness of a _standard_ opaque construction?
+- any overlaps between 2x windows in a given wall?
+
+Look up the full __osut__ API [here](https://www.rubydoc.info/gems/osut).
+
+OpenStudio-related questions can be posted on [UnmetHours](https://unmethours.com/questions/).

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "yard"
+YARD::Rake::YardocTask.new do |t|
+  t.files = ["lib/osut/utils.rb"]
+end
+
+task default: :spec