README.md in osut-0.3.0 vs README.md in osut-0.4.0

- old
+ new

@@ -1,8 +1,8 @@ # 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). +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. They provide key inputs to _Measures_ (or gems) such as _Thermal Bridging & Derating_ (or [TBD](https://github.com/rd2/tbd)). Compatible with SDK v3.0.0 (or newer) and OpenStudio Application [releases](https://github.com/openstudiocoalition/OpenStudioApplication/releases) distributed by the [OpenStudio Coalition](https://openstudiocoalition.org). Add: ``` gem "osut", git: "https://github.com/rd2/osut", branch: "main" @@ -33,23 +33,22 @@ ``` ... 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 the __osut__ methods deal with OpenStudio geometry (e.g. add & auto-position a front entrance with sidelights and transoms), or with constructions & materials: -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). +The remainder extract useful _zoning_ information from OpenStudio models, e.g.: + +- is a given space part of a CONDITIONED thermal zone? +- if CONDITIONED or INDIRECTLY UNCONDITIONED, what are its MIN/MAX heating/cooling setpoint temperatures? +- is it instead a _plenum_? or otherwise UNCONDITIONED? + +Many of these _zoning_ queries are adapted from [OpenStudio Standards](https://github.com/NREL/openstudio-standards/blob/master/lib/openstudio-standards/standards/Standards.ThermalZone.rb). + +Look up the full __osut__ API [here](https://www.rubydoc.info/gems/osut/OSut). OpenStudio-related questions can be posted on [UnmetHours](https://unmethours.com/questions/).