buildingsync/buildingsync-gem

buildingsync-gem's Issues

DO NOT USE PrimaryLightingSystemType element

BuildingSync-gem/spec/files/L100_Instance1.xml

Line 142 in d23c6e1

<auc:PrimaryLightingSystemType>Compact Fluorescent</auc:PrimaryLightingSystemType>

This element should not exist. Instead, the auc:LightingSystem should have a child auc:LampType with one of the sub-elements defined for the L100 level (i.e. auc:LampType/auc:LinearFluorescent, auc:LampType/auc:Incandescent, etc.)

Update selection tool code to pass tests

all three tests of the selection tool are failing:

make code changes to pass these tests again:

BuildingSync-gem/spec/tests/selection_tool_spec.rb

Line 42 in 7117b72

RSpec.describe 'SelectionTool' do

PSZ-AC with gas coil heat change air_loop_heating_type

BuildingSync-gem/lib/buildingsync/helpers/Model.hvac.rb

Lines 28 to 29 in 571698a

	when 'PSZ-AC with gas coil heat'
	standard.model_add_hvac_system(self, 'PSZ-AC', ht = 'NaturalGas', znht = nil, cl = 'Electricity', zones)

Add the parameter for air_loop_heating_type = 'Gas' into this call. Else, a natural gas hot water boiler is added. The name of this case implies that heating occurs directly in the AHU via a gas fired furnace, not via a hot water loop fed by a gas fired boiler

Remove weather files from the repository

I'm not fond of having the weather files in this Gem. I don't have a better idea at the moment. In python there is a post-install command that runs and I'm wondering if we could do something similar where upon installing the gem a post install command runs and installed the weather files.

Still needs some investigation on how this would work.

Update how BSync-gem finds a 'baseline' scenario

BuildingSync-gem/lib/buildingsync/makers/workflow_maker.rb

Line 321 in d23c6e1

if scenario_name == 'Baseline'

This should not use the name of the scenario or an ID element. It should instead be:

• auc:Scenario/auc:ScenarioType/auc:CurrentBuilding/auc:CalculationMethod/auc:Modeled

occupancy_type vs occupancy_classification?

BuildingSync-gem/lib/buildingsync/model_articulation/building_section.rb

Line 115 in 50edf20

@occupancy_classification = section_element.elements["#{ns}:OccupancyClassification"].text

BuildingSync-gem/lib/buildingsync/model_articulation/building_section.rb

Line 94 in 50edf20

@occupancy_type = read_occupancy_type(section_element, occ_type, ns)

Hey @TMaile - seems to me these both access the auc:OccupancyClassification element, so just trying to understand if the have different intentions?

Download weather files from BCL given a specific location

Define ASHRAE Level 1 Use Case

Need to define this in format for the use case validator

[DA_Update_RefTmp] Refactor code in Tmp_OsLib_ModelGenerationBRICR module

• get_building_types
• get_templates
• calc_aspect_ratio
• building_form_defaults
• get_space_types_from_building_type
• remove_non_resource_objects
• create_bar
• make_surfaces_adiabatic
• calc_bar_reduced_bounding_box
• calc_bar_reduced_width
• calc_bar_stretched

Extend class level testing

Site class level testing is almost complete
need testing for all other classes

[DA_Update] Update to OpenStudio 3.0 and ruby 2.5

• created new branch DA_update based on DA branch
• changed to model-articulation-gem to v 0.2.0
• changed model-articulation-gem from DA branch to develop branch
• updated to support Ruby 2.5.8
• installed OpenStudio 3.0.1
• changed reference from ruby 2.5.8 to OpenStudio 3.0.1
• refactor code that uses Epw class
• adjusted travis testing to use 3.0.1 (depends on #65)
• update reference files and measures to reflect changes in OpenStudio 3.0.1 (adding these measures to openstudio-ee-gem here: NREL/openstudio-ee-gem@4d595fc)
  • tenant_star_internal_loads
  • replace_simple_glazing
  • vr_fwith_doas
  • add_apszhp_to_each_zone
  • improve_simple_glazing_by_percentage
  • set_boiler_thermal_efficiency
  • replace_hvac_with_gshp_and_doas
  • ReplaceFanTotalEfficiency
  • ImproveFanTotalEfficiencybyPercentage
  • add_energy_recovery_ventilator
  • set_water_heater_efficiency_heat_lossand_peak_water_flow_rate
  • reduce_water_use_by_percentage
  • add_apszhp_to_each_zone
• refactor code to ensure tests are passing again

Processing of level 1 parameters

Extend testing of comparing to OSM file to compare IDF files

Currently we are generating an OSM file at the site level and compare it to an earlier version of that file, by making sure the file size is within 1 byte.
In order to detect smaller differences between those files/models, we need to compare IDF files

Test files refer to schema in incorrect relative location

BuildingSync-gem\spec\files\DC GSA Headquarters.xml refers to a schema at ../BuildingSync.xsd

<BuildingSync xmlns="http://buildingsync.net/schemas/bedes-auc/2019" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://buildingsync.net/schemas/bedes-auc/2019 ../BuildingSync.xsd">

However, this schema does not exist in the repository. We should either include the schema in the repo or point to it at an online location.

Selection of constructions in Standards fails

The following error message indicates that the construction are not properly selected in the Standards gem.

Could not find construction properties for: CBES T24 2001-ClimateZone 3C-ExteriorFloor-Mass-Nonresidential.

Need to investigate what goes wrong with the string that is passed to that method.

Include dependency on OpenStudio Model Articulation Gem

Remove the use of OS_Lib methods and import methods from https://github.com/NREL/openstudio-model-articulation-gem

[DA_Update_RefSched] Refactor code that uses parametric schedules

The following function used to call our parametric schedules code

BuildingSync-gem/lib/buildingsync/model_articulation/loads_system.rb

Line 149 in 012ccc9

def adjust_people_schedule(space_type, building_section, model)

we need to update it to use: OsLib_Schedules.createComplexSchedule

https://github.com/NREL/OpenStudio-Prototype-Buildings/blob/c3d5021d8b7aef43e560544699fb5c559e6b721d/lib/btap/lib/os_lib_schedules.rb#L451

here is an example of how it is used in a measure:

https://github.com/NREL/openstudio-model-articulation-gem/blob/e1da9c43d6cee75012520975cc4b7022414336b6/lib/measures/create_parametric_schedules/measure.rb#L744

Scenario processing: Measures not found in Golden Test File.xml

The following measures could not be processed:

• Building1RemovePV
• WholeSiteRemovePV

question on this line in workflow_maker.rb

BuildingSync-gem/lib/buildingsync/makers/workflow_maker.rb

Line 482 in bb52655

next if scenario_name == 'Baseline'

So, I was running EDV workflow, and realized baseline OS simulation results were not adding back to xml. Here is a detail description of the issue.

So I was looking into BuildingSync gem and found that one line in the link above was skipping (if I'm understanding correctly) baseline scenario for adding back to xml files. Is this something that was necessary on BuildingSync gem? or can we comment that line out (or do something else) moving forward?

Add simulation runs to travis testing

Running simulations will show that osm files created are complete and simulation ready

Update code for BuildingSync 2.0 beta

Use local version of EPW file before download from BCL

Is there something like a local component library that would make it easy to use local instances of EPW files?

Use a factory bot to generate XML files on the fly

spec/tests/model_articulation_test/facility_spec.rb .. create_minimum_snippet(occupancy_classification, year_of_const, floor_area_type, floor_area_value)

we should pull these out into a factory. Most common is https://github.com/thoughtbot/factory_bot_rails

Process use cases in the selector tool

Besides running the schema validation, we should also run the use case check via the selector tool API.

Enable reading of level 1 parameters

sdfa

https://github.com/BuildingSync/BuildingSync-gem/blob/571698a276a973e0ab9909f1e86eb6b245068c35/lib/buildingsync/helpers/Model.hvac.rb#L28-29

Inconsistent sub surface name in IDF Translator

As part of our testing, we compare two IDF files that are generated from OSMs to ensure that we do not miss any changes in the generated model.

We discovered some small differences in the naming of sub surfaces in the IDF files.

E.g., Sub Surface 11 <-> Sub Surface 5, see comparison screenshot below. I also attached the two osm and idf files. we use the following code to generate the IDF form the OSM.

OpenStudio::EnergyPlus::ForwardTranslator.new.translateModel(model)

IDF_OSM_Files.zip

Maker Classes

@TMaile the class inheritance structure used for the Makers is very confusing. We have the following:
ModelMakerLevelZero < PhaseZeroWorkflowMaker
PhaseZeroWorkflowMaker < WorkflowMaker
WorkflowMaker < ModelMaker

From my perspective, seems like we should segment methods / properties according to how they are segmented for OSMs and OSWs, namely:

1. ModelMaker should include methods / structures for creating an OSM
2. WorkflowMaker should include methods / structures for defining an OSW using a base OSM

Let's discuss on next call

auc:FloorsBelowGrade Max at 1

Trying to define more than 1 auc:FloorsBelowGrade results in the following:

/Users/cmosiman/.rbenv/versions/2.2.4/lib/ruby/gems/2.2.0/bundler/gems/openstudio-model-articulation-gem-2adec90118c0/lib/openstudio/model_articulation/os_lib_model_generation_bricr.rb:652:in `block in create_bar': undefined method `[]' for nil:NilClass (NoMethodError)
        from /Users/cmosiman/.rbenv/versions/2.2.4/lib/ruby/gems/2.2.0/bundler/gems/openstudio-model-articulation-gem-2adec90118c0/lib/openstudio/model_articulation/os_lib_model_generation_bricr.rb:650:in `each'
        from /Users/cmosiman/.rbenv/versions/2.2.4/lib/ruby/gems/2.2.0/bundler/gems/openstudio-model-articulation-gem-2adec90118c0/lib/openstudio/model_articulation/os_lib_model_generation_bricr.rb:650:in `each_with_index'
        from /Users/cmosiman/.rbenv/versions/2.2.4/lib/ruby/gems/2.2.0/bundler/gems/openstudio-model-articulation-gem-2adec90118c0/lib/openstudio/model_articulation/os_lib_model_generation_bricr.rb:650:in `create_bar'
        from /Users/cmosiman/.rbenv/versions/2.2.4/lib/ruby/gems/2.2.0/bundler/gems/BuildingSync-gem-50edf2060dd5/lib/buildingsync/model_articulation/building.rb:763:in `generate_baseline_osm'
        from /Users/cmosiman/.rbenv/versions/2.2.4/lib/ruby/gems/2.2.0/bundler/gems/BuildingSync-gem-50edf2060dd5/lib/buildingsync/model_articulation/site.rb:260:in `generate_baseline_osm'
        from /Users/cmosiman/.rbenv/versions/2.2.4/lib/ruby/gems/2.2.0/bundler/gems/BuildingSync-gem-50edf2060dd5/lib/buildingsync/model_articulation/facility.rb:123:in `generate_baseline_osm'
        from /Users/cmosiman/.rbenv/versions/2.2.4/lib/ruby/gems/2.2.0/bundler/gems/BuildingSync-gem-50edf2060dd5/lib/buildingsync/makers/model_maker_level_zero.rb:68:in `generate_baseline'
        from /Users/cmosiman/.rbenv/versions/2.2.4/lib/ruby/gems/2.2.0/bundler/gems/BuildingSync-gem-50edf2060dd5/lib/buildingsync/translator.rb:115:in `write_osm'

Translator.write_model_to_xml

Exact method name of write_model_to_xml isn't necessary, nor for it to live in the Translator class (I know we have the saveXML in the ModelMaker classes, and maybe this is the eventual intention of this method), but it would be super useful for the OSM to be flushed to the specified file, such that upon write, as many of the characteristics of the model that can be represented in the Schema be translated to xml. This would make it very valuable for users to understand how the BuildingSync file they provided was interpreted by the gem without needing to open up the .osm file

[DA] move NUM_BUILDINGS_PARALLEL to runner?

the file config.rb.in still contains a constant for the number of buildings that can be run in parallel.

 # number of parallel BuildingSync files to run
 NUM_BUILDINGS_PARALLEL = 2

Should we also move that to the runner options?

See discussion here

Jenkins testing of scenario simulations [postponed]

When we run the full set of tests, Travis runs out of time especially when running all the scenario simulations. We agreed in our last meeting that we will run all of the tests with Travis except the scenario simulations.

Those can be found in 'translator_scenario_simulations_spec.rb' and should be added to the Jenkins testing.

[DA] Address review comments of large pull request #56

• address review comments
• remove code that references parametric schedules (depends on review and potential active use of DA branch)
• initiate another round of review and if ok then finally merge PR #56 (without the schedule code)

Golden Test File - Processing large bldg - small bldg occupancy type: laboratory testing

The Golden Test File has two buildings. Since we are focusing on generating only one building for now, we developed code to pick the largest building by floor area.
This also circumvents the issue with the occupancy type of the small building set to "Laboratory-Testing" which is not supported in any of the standards we are considering,

Determine how to set the standard used in translation

Currently this is hard wired to use the CBES T24 standard. However in other cases users may want to use a different standard

Design document for multiple buildings in one BuildingSync file

A BuildingSync file can have multiple buildings in it. We need to design what the expected behavior is. Should we simulate both buildings in the same OSM? Have one OSM per building? Are there user options?

VAV with PFP Boxes Change

BuildingSync-gem/lib/buildingsync/helpers/Model.hvac.rb

Lines 139 to 140 in 571698a

	when 'VAV with PFP boxes'
	standard.model_add_hvac_system(self, 'VAV PFP Boxes', ht = 'NaturalGas', znht = 'NaturalGas', cl = 'Electricity', zones)

ht = 'Electricity' and znht = 'Electricity'

Even though it doesn’t matter from an implementation perspective (because the underlying method doesn't look at either of these parameters and automatically utilizes electric resistance heating at both the AHU and terminal units). However, it is very confusing when reading...likely there should be accompanying documentation in the openstudio-standards world for this, since you would think these would be overriding methods...

Run BuildingSync Use Case Validator localy

Having trouble accessing online validator from Ruby 2.2.4 due to OpenSSL issues. Run validator locally to test for now.

@kflemin can you write up or point to some documentation on how to run the validator locally

Don't include OpenStudio Module in classes

The OpenStudio Module is huge and not meant to be mixed into classes. Don't include it in classes like:

https://github.com/BuildingSync/BuildingSync-gem/blob/DA/lib/buildingsync/model_articulation/spatial_element.rb#L44

Remove scenario simulations from Travis

[DA_Update] OpenStudio 3.0.1 fails to install during travis testing

I am trying to update the DA_update branch to support testing with OpenStudio 3.0.1.

The installation of OpenStudio seems to fail. Below are the details:

here is the line that defines the OpenStudio version:

BuildingSync-gem/.travis.yml

Line 11 in 012ccc9

- env: FAVOR_LOCAL_GEMS=1 OPENSTUDIO_VERSION=3.0.1 OPENSTUDIO_SHA=09b7c8a554 RUBYLIB=/usr/local/openstudio-3.0.1/Ruby:/usr/Ruby

here is the line that tries to install it:

BuildingSync-gem/.travis.yml

Line 20 in f212981

- curl -sLO https://raw.githubusercontent.com/NREL/OpenStudio-server/2.9.X-LTS/docker/deployment/scripts/install_openstudio.sh

I am not sure if the installation file is missing or the script is outdated.

Scenario processing: Measures not found in DC GSA Headquarters.xml

The following measures could not be processed and I could not find them via a quick search in the usual gems:

• Name: Other -- Description: HVAC Scheduling Control
• Name: Retrofit with T-8 -- Description: Lighting Retrofit
• Name: Other -- Description: Air Side and Water Side Economizer Maintenance
• Name: Upgrade operating protocols, calibration, and/or sequencing -- Description: Demand Controlled Ventilation

Include simulation variables within the OpenStudio Extension Gem

The following variables should be covered in the OpenStudioExtension Gem and removed from the config.rb.in file in BuildingSync

• MAX_DATAPOINTS
• NUM_PARALLEL

What about others like:

• DO_SIMULATIONS
• SIMULATE_BASELINE_ONLY
• DO_MODEL_CALIBRATION
• DO_GET_RESULTS

Attributes conditioned_floor_area or heated_and_cooled_floor_area used?

BuildingSync-gem/lib/buildingsync/model_articulation/spatial_element.rb

Lines 90 to 94 in 50edf20

	if @total_floor_area.nil? && !@conditioned_floor_area.nil?
	@total_floor_area = @conditioned_floor_area
	elsif @total_floor_area.nil? && !@heated_and_cooled_floor_area.nil?
	@total_floor_area = @heated_and_cooled_floor_area
	end

Hey @TMaile, are these defined anywhere? Seems maybe they were previous attribute names or something, or I missed them?

Core reorg to match other extension gems

• Make main ruby file just include other files
• Move extension class to extension.rb file and rename

Install OpenStudio inside of travis

we need to figure out how to install OpenStudio inside of Travis in order for our automated testing to work correctly.

Overall main tasks

Based on the review of PR #56, define needs for next BSync gem development push

Refactor workflow maker code to reduce if/then/else code

The current (from BRICR inherited) code in the workflow maker uses a lot of if/then/else code. We want to refactor this to make it more generic and to use some hash to generically deal with the categories and properties.

[DA_Update_Gen] Create a new generator class that contains code from specs to create minimal BldgSync file

• Create new branch DA_Update_Gen from DA_Update branch
• Create a new class called generator that contains the following features:
  • create_minimum_facility
  • create_minimum_snippet
• refactor code so it uses this new class in the test

see issue #56 (comment)

PVAV with PFP Boxes change heating type

BuildingSync-gem/lib/buildingsync/helpers/Model.hvac.rb

Lines 168 to 169 in 571698a

	when 'PVAV with PFP boxes'
	standard.model_add_hvac_system(self, 'PVAV PFP Boxes', ht = 'Electricity', znht = 'Electricity', cl = 'Electricity', zones)

Change heating type to ht = 'Natural Gas'. Assumption with packaged and non-hot water reheat is that it is natural gas fired.