Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rename gbxml measures #171

Merged
merged 15 commits into from
Jun 28, 2024
Merged

rename gbxml measures #171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
5b9045c
gbxml_import dir
MatthewSteen Jun 28, 2024
bc93bb1
mv import_gbxml => gbxml_import
MatthewSteen Jun 28, 2024
965872f
mv advanced_import_gbxml => gbxml_import_advanced
MatthewSteen Jun 28, 2024
4778e91
mv gbxml_hvac_import => gbxml_import_hvac
MatthewSteen Jun 28, 2024
ffe5c3c
update workflows
MatthewSteen Jun 28, 2024
67ff4ac
measure -u gbxml_import
MatthewSteen Jun 28, 2024
a860f99
measure -u gbxml_import
MatthewSteen Jun 28, 2024
b6e6e7c
add README to gbxml_import
MatthewSteen Jun 28, 2024
23941fc
measure -u gbxml_import_advanced
MatthewSteen Jun 28, 2024
f391b90
measure -u gbxml_import_hvac
MatthewSteen Jun 28, 2024
66dd968
mv *_test.rb files
MatthewSteen Jun 28, 2024
2bc22d4
update *_test.rb class names
MatthewSteen Jun 28, 2024
dcaff96
mv gbxml_hvac_import.rb => gbxml_import_hvac.rb
MatthewSteen Jun 28, 2024
59ec89b
update require_relative
MatthewSteen Jun 28, 2024
25c0cd8
update RegressionTesting.osw
MatthewSteen Jun 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions measures/advanced_import_gbxml/README.md → measures/gbxml_import/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

###### (Automatically generated documentation)

# Advanced Import Gbxml
# GbxmlImport

## Description
This measure will bring in additional gbXML data beyond what comes in with the basic OpenStudio gbXML import.
Import a gbXML file

## Modeler Description
This measure expects GbXMLReverseTranslator to already have been run on the model. This measure parses the XML and translates additional gbXML objects to OSM.
Import a gbXML file

## Measure Type
ModelMeasure
Expand All @@ -27,6 +27,14 @@ Filename or full path to gbXML file.
**Required:** true,
**Model Dependent:** false

### Rename Building and Thermal Zone objects with gbXML Names?

**Name:** rename_objects,
**Type:** Boolean,
**Units:** ,
**Required:** false,
**Model Dependent:** false




0 measures/advanced_import_gbxml/README.md.erb → measures/gbxml_import/README.md.erb
View file
Open in desktop
File renamed without changes.
6 changes: 3 additions & 3 deletions measures/import_gbxml/measure.rb → measures/gbxml_import/measure.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
# http://nrel.github.io/OpenStudio-user-documentation/reference/measure_writing_guide/

# start the measure
class ImportGbxml < OpenStudio::Measure::ModelMeasure
class GbxmlImport < OpenStudio::Measure::ModelMeasure

# human readable name
def name
return "ImportGbxml"
return "Gbxml Import"
end

# human readable description
Expand Down Expand Up @@ -184,4 +184,4 @@ def run(model, runner, user_arguments)
end

# register the measure to be used by the application
ImportGbxml.new.registerWithApplication
GbxmlImport.new.registerWithApplication
60 changes: 45 additions & 15 deletions measures/import_gbxml/measure.xml → measures/gbxml_import/measure.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<?xml version="1.0"?>
<measure>
<schema_version>3.0</schema_version>
<name>import_gbxml</name>
<schema_version>3.1</schema_version>
<name>gbxml_import</name>
<uid>a335136f-bad3-451d-a585-9ea31249e38b</uid>
<version_id>ad35b7c9-cf23-404d-9fcc-96bd8f87c5f6</version_id>
<version_modified>20220420T154900Z</version_modified>
<version_id>5752fd87-ac2a-4563-980a-1f6109864a0f</version_id>
<version_modified>2024-06-28T17:41:21Z</version_modified>
<xml_checksum>DA3B952E</xml_checksum>
<class_name>ImportGbxml</class_name>
<display_name>ImportGbxml</display_name>
<class_name>GbxmlImport</class_name>
<display_name>GbxmlImport</display_name>
<description>Import a gbXML file</description>
<modeler_description>Import a gbXML file</modeler_description>
<arguments>
Expand All @@ -19,6 +19,24 @@
<required>true</required>
<model_dependent>false</model_dependent>
</argument>
<argument>
<name>rename_objects</name>
<display_name>Rename Building and Thermal Zone objects with gbXML Names?</display_name>
<type>Boolean</type>
<required>false</required>
<model_dependent>false</model_dependent>
<default_value>true</default_value>
<choices>
<choice>
<value>true</value>
<display_name>true</display_name>
</choice>
<choice>
<value>false</value>
<display_name>false</display_name>
</choice>
</choices>
</argument>
</arguments>
<outputs />
<provenances />
Expand Down Expand Up @@ -69,16 +87,16 @@
</attributes>
<files>
<file>
<filename>import_gbxml_test.rb</filename>
<filetype>rb</filetype>
<usage_type>test</usage_type>
<checksum>3F13F2CF</checksum>
<filename>README.md</filename>
<filetype>md</filetype>
<usage_type>readme</usage_type>
<checksum>6B4A52CA</checksum>
</file>
<file>
<filename>gbXMLStandard Test Model 2016.xml</filename>
<filetype>xml</filetype>
<usage_type>test</usage_type>
<checksum>D39FE3DA</checksum>
<filename>README.md.erb</filename>
<filetype>erb</filetype>
<usage_type>readmeerb</usage_type>
<checksum>703C9964</checksum>
</file>
<file>
<version>
Expand All @@ -89,7 +107,19 @@
<filename>measure.rb</filename>
<filetype>rb</filetype>
<usage_type>script</usage_type>
<checksum>CCBBDF6D</checksum>
<checksum>67A74842</checksum>
</file>
<file>
<filename>gbXMLStandard Test Model 2016.xml</filename>
<filetype>xml</filetype>
<usage_type>test</usage_type>
<checksum>D39FE3DA</checksum>
</file>
<file>
<filename>import_gbxml_test.rb</filename>
<filetype>rb</filetype>
<usage_type>test</usage_type>
<checksum>3F13F2CF</checksum>
</file>
</files>
</measure>
0 ...l/tests/gbXMLStandard Test Model 2016.xml → ...t/tests/gbXMLStandard Test Model 2016.xml
View file
Open in desktop
File renamed without changes.
4 changes: 2 additions & 2 deletions ...s/import_gbxml/tests/import_gbxml_test.rb → ...s/gbxml_import/tests/gbxml_import_test.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
require_relative '../measure.rb'
require 'fileutils'

class ImportGbxml_Test < MiniTest::Unit::TestCase
class GbxmlImport_Test < MiniTest::Unit::TestCase

# def setup
# end
Expand All @@ -15,7 +15,7 @@ class ImportGbxml_Test < MiniTest::Unit::TestCase
def test_import
# create a test model
model = OpenStudio::Model::Model.new

# create an instance of the measure
measure = ImportGbxml.new

Expand Down
26 changes: 26 additions & 0 deletions measures/gbxml_import_advanced/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@


###### (Automatically generated documentation)

#

## Description


## Modeler Description


## Measure Type
ModelMeasure

## Taxonomy


## Arguments




This measure does not have any user arguments


0 measures/gbxml_hvac_import/README.md.erb → measures/gbxml_import_advanced/README.md.erb
View file
Open in desktop
File renamed without changes.
6 changes: 3 additions & 3 deletions measures/advanced_import_gbxml/measure.rb → measures/gbxml_import_advanced/measure.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@
Dir[File.dirname(__FILE__) + '/resources/*.rb'].each { |file| require file }

# start the measure
class AdvancedImportGbxml < OpenStudio::Measure::ModelMeasure
class GbxmlImportAdvanced < OpenStudio::Measure::ModelMeasure
# human readable name
def name
# Measure name should be the title case of the class name.
return 'Advanced Import Gbxml'
return 'Gbxml Import Advanced'
end

# human readable description
Expand Down Expand Up @@ -421,4 +421,4 @@ def run(model, runner, user_arguments)
end

# register the measure to be used by the application
AdvancedImportGbxml.new.registerWithApplication
GbxmlImportAdvanced.new.registerWithApplication
119 changes: 57 additions & 62 deletions measures/advanced_import_gbxml/measure.xml → measures/gbxml_import_advanced/measure.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
<?xml version="1.0"?>
<measure>
<schema_version>3.0</schema_version>
<schema_version>3.1</schema_version>
<error>Failed to infer measure name from 'C:/Users/MSTEEN/Documents/GitHub/NREL/gbxml-to-openstudio/measures/gbxml_import_advanced/measure.rb'</error>
<name>advanced_import_gbxml</name>
<uid>f82940f7-8046-4fd1-9dbb-df6411e86de2</uid>
<version_id>5bd42b97-9eac-42b7-b84d-015ddcb0d0ae</version_id>
<version_modified>20220420T154858Z</version_modified>
<version_id>34245d90-7622-429e-880a-c632ecf98cdd</version_id>
<version_modified>2024-06-28T17:39:01Z</version_modified>
<xml_checksum>D8922A73</xml_checksum>
<class_name>AdvancedImportGbxml</class_name>
<display_name>Advanced Import Gbxml</display_name>
Expand Down Expand Up @@ -49,10 +50,10 @@
</attributes>
<files>
<file>
<filename>LICENSE.md</filename>
<filename>README.md</filename>
<filetype>md</filetype>
<usage_type>license</usage_type>
<checksum>CD7F5672</checksum>
<usage_type>readme</usage_type>
<checksum>0B68E96D</checksum>
</file>
<file>
<filename>README.md.erb</filename>
Expand All @@ -61,22 +62,27 @@
<checksum>703C9964</checksum>
</file>
<file>
<filename>gbXMLStandard Test Model 2016.xml</filename>
<filetype>xml</filetype>
<usage_type>test</usage_type>
<checksum>D39FE3DA</checksum>
<version>
<software_program>OpenStudio</software_program>
<identifier>2.6.0</identifier>
<min_compatible>2.6.0</min_compatible>
</version>
<filename>measure.rb</filename>
<filetype>rb</filetype>
<usage_type>script</usage_type>
<checksum>070BF203</checksum>
</file>
<file>
<filename>README.md</filename>
<filetype>md</filetype>
<usage_type>readme</usage_type>
<checksum>60A34A33</checksum>
<filename>building_type_helper.rb</filename>
<filetype>rb</filetype>
<usage_type>resource</usage_type>
<checksum>A8B4E116</checksum>
</file>
<file>
<filename>Analytical Systems 01.xml</filename>
<filetype>xml</filetype>
<usage_type>test</usage_type>
<checksum>CE91D4F3</checksum>
<filename>os_lib_adv_import.rb</filename>
<filetype>rb</filetype>
<usage_type>resource</usage_type>
<checksum>D2A0FD8D</checksum>
</file>
<file>
<filename>os_lib_lighting_and_equipment.rb</filename>
Expand All @@ -85,63 +91,46 @@
<checksum>E63C7739</checksum>
</file>
<file>
<filename>Test Villa Scenario 2_alt_a.xml</filename>
<filetype>xml</filetype>
<usage_type>test</usage_type>
<checksum>89516D7B</checksum>
</file>
<file>
<filename>.gitkeep</filename>
<filetype>gitkeep</filetype>
<usage_type>doc</usage_type>
<checksum>00000000</checksum>
<filename>os_lib_schedules.rb</filename>
<filetype>rb</filetype>
<usage_type>resource</usage_type>
<checksum>C79BB5BA</checksum>
</file>
<file>
<filename>VentilationAndInfiltration.xml</filename>
<filename>200_SpacesOneZE.xml</filename>
<filetype>xml</filetype>
<usage_type>test</usage_type>
<checksum>A8185257</checksum>
</file>
<file>
<filename>os_lib_schedules.rb</filename>
<filetype>rb</filetype>
<usage_type>resource</usage_type>
<checksum>BB445760</checksum>
<checksum>C4359438</checksum>
</file>
<file>
<filename>advanced_import_gbxml_test.rb</filename>
<filetype>rb</filetype>
<filename>25_SpacesOneZE.xml</filename>
<filetype>xml</filetype>
<usage_type>test</usage_type>
<checksum>F468277A</checksum>
<checksum>44A2B39C</checksum>
</file>
<file>
<filename>os_lib_adv_import.rb</filename>
<filetype>rb</filetype>
<usage_type>resource</usage_type>
<checksum>24E56A45</checksum>
<filename>AirSystemAllVariations.xml</filename>
<filetype>xml</filetype>
<usage_type>test</usage_type>
<checksum>F50404FF</checksum>
</file>
<file>
<version>
<software_program>OpenStudio</software_program>
<identifier>2.6.0</identifier>
<min_compatible>2.6.0</min_compatible>
</version>
<filename>measure.rb</filename>
<filetype>rb</filetype>
<usage_type>script</usage_type>
<checksum>DD0E31F0</checksum>
<filename>Analytical Systems 01.xml</filename>
<filetype>xml</filetype>
<usage_type>test</usage_type>
<checksum>CE91D4F3</checksum>
</file>
<file>
<filename>200_SpacesOneZE.xml</filename>
<filename>Test Villa Scenario 2_alt_a.xml</filename>
<filetype>xml</filetype>
<usage_type>test</usage_type>
<checksum>C4359438</checksum>
<checksum>89516D7B</checksum>
</file>
<file>
<filename>25_SpacesOneZE.xml</filename>
<filename>VentilationAndInfiltration.xml</filename>
<filetype>xml</filetype>
<usage_type>test</usage_type>
<checksum>44A2B39C</checksum>
<checksum>A8185257</checksum>
</file>
<file>
<filename>adhoc_test.rb</filename>
Expand All @@ -150,16 +139,22 @@
<checksum>33699363</checksum>
</file>
<file>
<filename>AirSystemAllVariations.xml</filename>
<filename>advanced_import_gbxml_test.rb</filename>
<filetype>rb</filetype>
<usage_type>test</usage_type>
<checksum>BC66C7B5</checksum>
</file>
<file>
<filename>gbXMLStandard Test Model 2016.xml</filename>
<filetype>xml</filetype>
<usage_type>test</usage_type>
<checksum>F50404FF</checksum>
<checksum>D39FE3DA</checksum>
</file>
<file>
<filename>building_type_helper.rb</filename>
<filetype>rb</filetype>
<usage_type>resource</usage_type>
<checksum>A8B4E116</checksum>
<filename>gbxml - on -peoplehalftime.xml</filename>
<filetype>xml</filetype>
<usage_type>test</usage_type>
<checksum>7AB4E205</checksum>
</file>
</files>
</measure>
0 ...t_gbxml/resources/building_type_helper.rb → ...dvanced/resources/building_type_helper.rb
View file
Open in desktop
File renamed without changes.
0 ...port_gbxml/resources/os_lib_adv_import.rb → ...t_advanced/resources/os_lib_adv_import.rb
View file
Open in desktop
File renamed without changes.
0 ...esources/os_lib_lighting_and_equipment.rb → ...esources/os_lib_lighting_and_equipment.rb
View file
Open in desktop
File renamed without changes.
0 ...mport_gbxml/resources/os_lib_schedules.rb → ...rt_advanced/resources/os_lib_schedules.rb
View file
Open in desktop
File renamed without changes.
0 ...ed_import_gbxml/tests/200_SpacesOneZE.xml → ...import_advanced/tests/200_SpacesOneZE.xml
View file
Open in desktop
File renamed without changes.
0 ...ced_import_gbxml/tests/25_SpacesOneZE.xml → ..._import_advanced/tests/25_SpacesOneZE.xml
View file
Open in desktop
File renamed without changes.
0 ...rt_gbxml/tests/AirSystemAllVariations.xml → ...advanced/tests/AirSystemAllVariations.xml
View file
Open in desktop
File renamed without changes.
0 ...ort_gbxml/tests/Analytical Systems 01.xml → ..._advanced/tests/Analytical Systems 01.xml
100755 → 100644
View file
Open in desktop
File renamed without changes.
0 ...xml/tests/Test Villa Scenario 2_alt_a.xml → ...ced/tests/Test Villa Scenario 2_alt_a.xml
View file
Open in desktop
File renamed without changes.
0 ...bxml/tests/VentilationAndInfiltration.xml → ...nced/tests/VentilationAndInfiltration.xml
View file
Open in desktop
File renamed without changes.
0 ...advanced_import_gbxml/tests/adhoc_test.rb → ...gbxml_import_advanced/tests/adhoc_test.rb
View file
Open in desktop
File renamed without changes.
0 ...l/tests/gbXMLStandard Test Model 2016.xml → ...d/tests/gbXMLStandard Test Model 2016.xml
View file
Open in desktop
File renamed without changes.
0 ...bxml/tests/gbxml - on -peoplehalftime.xml → ...nced/tests/gbxml - on -peoplehalftime.xml
View file
Open in desktop
File renamed without changes.
Loading