openstudio-metadata 0.0.1

data/lib/openstudio/metadata/helpers.rb

@@ -0,0 +1,184 @@
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# 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 any contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission from the respective party.
+#
+# (4) Other than as required in clauses (1) and (2), distributions in any form
+# of modifications or other derivative works may not use the "OpenStudio"
+# trademark, "OS", "os", or any other confusingly similar designation without
+# specific prior written permission from Alliance for Sustainable Energy, LLC.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY 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(S), ANY CONTRIBUTORS, THE
+# UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
+# THEIR EMPLOYEES, 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.
+# *******************************************************************************
+module OpenStudio
+  module Metadata
+    module Helpers
+
+      ##
+      # Format with no spaces or '-' (can be used as EMS var name)
+      ##
+      # @param [String] name
+      def create_ems_str(name)
+        return name.gsub(/[\s-]/, '_').to_s
+      end
+
+      ##
+      # Create a UUID and format as a Haystack ref (ie, "r:xxxxx")
+      ##
+      # @return [String]
+      def haystack_create_uuid
+        return "r:#{OpenStudio.removeBraces(OpenStudio.createUUID)}"
+      end
+
+      ##
+      # Return string formatted for Ref (ie, "r:xxxxx") with uuid of object
+      ##
+      # @param [OpenStudio::UUID] id
+      # @return [String]
+      def haystack_format_as_ref(id)
+        return "r:#{OpenStudio.removeBraces(id)}"
+      end
+
+      ##
+      # Return string formatted for strings (ie, "s:xxxxx")
+      ##
+      # @param [] str An object which can be converted to a string
+      # @return [String]
+      def haystack_format_as_str(str)
+        return "s:#{str}"
+      end
+
+      ##
+      # Return string formatted for numbers (ie, "n:xxxxx")
+      ##
+      # @param [] str An object which can be converted to a string
+      # @return [String]
+      def haystack_format_as_num(str)
+        return "n:#{str}"
+      end
+
+      ##
+      # Create both an output variable and an energy management system sensor and register them to the model
+      ##
+      # @param [String] system_node_property One of the 'System Node Properties', see E+ IO reference node list outputs
+      # @param [OpenStudio::Model::Node] node Node of interest
+      # @param [String] ems_name Desired name for EMS variable
+      # @param [OpenStudio::Model::Model] model
+      # @param [String] reporting_frequency See E+ IO reference reporting frequency for options
+      # @param [Boolean] bcvtb Flag to export OutputVariable to bcvtb
+      def create_output_variable_and_ems_sensor(system_node_property:, node:, ems_name:, model:, reporting_frequency: 'timestep', bcvtb: true)
+        name = create_ems_str(ems_name)
+        output_variable = OpenStudio::Model::OutputVariable.new(system_node_property, model)
+        output_variable.setKeyValue(node.name.to_s)
+        output_variable.setReportingFrequency(reporting_frequency)
+        output_variable.setName(name)
+        output_variable.setExportToBCVTB(bcvtb)
+
+        # EMS sensors are used to declare an Erl variable that is linked to E+ output variables or meters
+        sensor = OpenStudio::Model::EnergyManagementSystemSensor.new(model, output_variable)
+
+        # The key reference for the specified output variable
+        sensor.setKeyName(node.handle.to_s)
+
+        # Unique name for the sensor that becomes the name of a variable for us in Erl programs.
+        sensor.setName("EMS_#{name}")
+        return output_variable
+      end
+
+      def create_output_meter(model, meter_name, reporting_frequency: 'timestep')
+        meter = OpenStudio::Model::OutputMeter.new(model)
+        meter.setName(meter_name)
+        meter.setReportingFrequency(reporting_frequency)
+        return meter
+      end
+
+      def create_point_timevars(outvar_time, siteRef)
+        # this function will add haystack tag to the time-variables created by user.
+        # the time-variables are also written to variables.cfg file to coupling energyplus
+        # the uuid is unique to be used for mapping purpose
+        # the point_json generated here caontains the tags for the tim-variables
+        point_json = {}
+        # id = outvar_time.keyValue.to_s + outvar_time.name.to_s
+        uuid = haystack_create_uuid
+        point_json[:id] = uuid
+        # point_json[:source] = create_str("EnergyPlus")
+        # point_json[:type] = "Output:Variable"
+        # point_json[:name] = create_str(outvar_time.name.to_s)
+        # point_json[:variable] = create_str(outvar_time.name)
+        point_json[:dis] = haystack_format_as_str(outvar_time.nameString)
+        point_json[:siteRef] = haystack_format_as_ref(siteRef)
+        point_json[:point] = 'm:'
+        point_json[:cur] = 'm:'
+        point_json[:curStatus] = 's:disabled'
+
+        return point_json, uuid
+      end
+
+      def create_mapping_timevars(outvar_time, uuid)
+        # this function will use the uuid generated from create_point_timevars(), to make a mapping.
+        # the uuid is unique to be used for mapping purpose; uuid is the belt to connect point_json and mapping_json
+        # the mapping_json below contains all the necessary tags
+        mapping_json = {}
+        mapping_json[:id] = uuid
+        mapping_json[:source] = 'EnergyPlus'
+        mapping_json[:name] = 'EMS'
+        mapping_json[:type] = outvar_time.nameString
+        mapping_json[:variable] = ''
+
+        return mapping_json
+      end
+
+      def create_point_uuid(type, id, siteRef, equipRef, floorRef, where, what, measurement, kind, unit)
+        point_json = {}
+        uuid = haystack_create_uuid
+        point_json[:id] = uuid
+        point_json[:dis] = haystack_format_as_str(id)
+        point_json[:siteRef] = haystack_format_as_ref(siteRef)
+        point_json[:equipRef] = haystack_format_as_ref(equipRef)
+        point_json[:floorRef] = haystack_format_as_ref(floorRef)
+        point_json[:point] = 'm:'
+        point_json[type.to_s] = 'm:'
+        point_json[measurement.to_s] = 'm:'
+        point_json[where.to_s] = 'm:'
+        point_json[what.to_s] = 'm:'
+        point_json[:kind] = haystack_format_as_str(kind)
+        point_json[:unit] = haystack_format_as_str(unit)
+        point_json[:cur] = 'm:'
+        point_json[:curStatus] = 's:disabled'
+        return point_json, uuid
+      end
+
+      def create_mapping_output_uuid(emsName, uuid)
+        json = {}
+        json[:id] = haystack_format_as_ref(uuid)
+        json[:source] = 'Ptolemy'
+        json[:name] = ''
+        json[:type] = ''
+        json[:variable] = emsName
+        return json
+      end
+    end
+  end
+end

data/lib/openstudio/metadata/serializer.rb

@@ -0,0 +1,141 @@
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# 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 any contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission from the respective party.
+#
+# (4) Other than as required in clauses (1) and (2), distributions in any form
+# of modifications or other derivative works may not use the "OpenStudio"
+# trademark, "OS", "os", or any other confusingly similar designation without
+# specific prior written permission from Alliance for Sustainable Energy, LLC.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY 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(S), ANY CONTRIBUTORS, THE
+# UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
+# THEIR EMPLOYEES, 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.
+# *******************************************************************************
+require 'rdf'
+require 'linkeddata'
+require 'sparql/client'
+
+module OpenStudio
+  module Metadata
+    ##
+    # Class to serialize entities into Brick Graph
+    ##
+    # @example Use BrickGraph to make a `ttl` from a list of entities
+    #   entities = creator.entities
+    #   brick_graph = BrickGraph.new
+    #   brick_graph.create_graph_from_entities(entities)
+    #   ttl = brick_graph.dump(:ttl)
+    class BrickGraph
+      # Returns new instance of BrickGraph
+      # @param building_namespace [String] used for `bldg` prefix in ttl
+      def initialize(building_namespace: 'http://example.com/mybuilding#')
+        @brick = RDF::Vocabulary.new('https://brickschema.org/schema/1.1/Brick#')
+        @bldg = RDF::Vocabulary.new(building_namespace)
+        @prefixes = {
+          rdf: RDF.to_uri,
+          rdfs: RDF::RDFS.to_uri,
+          brick: @brick,
+          bldg: @bldg
+        }
+        @g = nil
+      end
+
+      ##
+      # Creates graph from list of entities
+      ##
+      # @param entities [Array<Hash>] list of entities from {Creator.entities}
+      def create_from_entities(entities)
+        @g = RDF::Repository.new
+        entities.each do |entity|
+          @g << RDF::Statement.new(@bldg[entity['id']], RDF.type, @brick[entity['type']])
+          @g << RDF::Statement.new(@bldg[entity['id']], RDF::RDFS.label, entity['dis'])
+          if entity.key? 'relationships'
+            entity['relationships'].each do |relationship, reference|
+              @g << RDF::Statement.new(@bldg[entity['id']], @brick[relationship], @bldg[reference])
+            end
+          end
+        end
+      end
+
+      ##
+      # Outputs Brick graph in desired `format`
+      ##
+      # @param format [Symbol] A symbol declaring to format to dump the graph as
+      # @see https://rubydoc.info/github/ruby-rdf/rdf/RDF/Enumerable#dump-instance_method
+      ##
+      # @return [String] A string representation of the graph in the desired format
+      #
+      def dump(format = :ttl)
+        return @g.dump(format, prefixes: @prefixes)
+      end
+    end
+
+    ##
+    # Class to serialize entities into a Haystack JSON
+    ##
+    # @example Use Haystack to make JSON from list of entities
+    #   entities = creator.entities
+    #   haystack = Haystack.new
+    #   haystack_json = haystack.create_haystack_from_entities(entities)
+    class Haystack
+      ##
+      # Creates Haystack JSON from list of entities
+      ##
+      # @param entities [Array<Hash>]  list of entities from {Creator.entities}
+      ##
+      # @return [String] Haystack JSON representation of entities
+      def create_from_entities(entities)
+        cols = []
+        rows = []
+        entities.each do |entity|
+          entity.keys.each do |k|
+            if k == 'add_tags'
+              (tags = entity[k]) && tags.each { |tag| entity.store(tag, ':m') && entity.delete(k) }
+            elsif k == 'type'
+              (t_tags = entity[k].split('-')) && t_tags.each { |t_tag| entity.store(t_tag, ':m') } && entity.delete(k)
+            elsif k == 'relationships'
+              relationships = entity[k]
+              relationships.each do |relationship, reference|
+                entity.store(relationship, reference)
+              end
+              entity.delete(k)
+            end
+          end
+          rows.append(entity)
+        end
+        rows.each do |row|
+          row.keys.each do |k|
+            unless cols.include?('name' => k)
+              cols.append('name' => k)
+            end
+          end
+        end
+        data = { 'meta' => { 'ver' => '3.0' },
+                 'cols' => cols,
+                 'rows' => rows }
+        return JSON.pretty_generate(data)
+      end
+    end
+  end
+end

data/lib/openstudio/metadata/version.rb

@@ -0,0 +1,40 @@
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# 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 any contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission from the respective party.
+#
+# (4) Other than as required in clauses (1) and (2), distributions in any form
+# of modifications or other derivative works may not use the "OpenStudio"
+# trademark, "OS", "os", or any other confusingly similar designation without
+# specific prior written permission from Alliance for Sustainable Energy, LLC.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY 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(S), ANY CONTRIBUTORS, THE
+# UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
+# THEIR EMPLOYEES, 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.
+# *******************************************************************************
+
+module OpenStudio
+  module Metadata
+    VERSION = '0.0.1'.freeze
+  end
+end

data/lib/openstudio/metadata/writer.rb

@@ -0,0 +1,107 @@
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# 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 any contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission from the respective party.
+#
+# (4) Other than as required in clauses (1) and (2), distributions in any form
+# of modifications or other derivative works may not use the "OpenStudio"
+# trademark, "OS", "os", or any other confusingly similar designation without
+# specific prior written permission from Alliance for Sustainable Energy, LLC.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY 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(S), ANY CONTRIBUTORS, THE
+# UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
+# THEIR EMPLOYEES, 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.
+# *******************************************************************************
+require 'json'
+require 'yaml'
+
+require 'linkeddata'
+require 'sparql/client'
+require 'openstudio'
+
+module OpenStudio
+  module Metadata
+    ##
+    # Class to write serialized metadata models to file
+    ##
+    # @example Write Haystack JSON to file with Writer
+    #   creator = OpenStudio::Metadata::Creator.new(path_to_model)
+    #   creator.apply_mappings('Haystack')
+    #   writer = OpenStudio::Metadata::Writer.new(creator: creator)
+    #   writer.write_output_to_file(output_format: 'json')
+    class Writer
+      ##
+      # Initialize Writer
+      ##
+      # @param creator [Creator] creator
+      def initialize(creator:)
+        @creator = creator
+        @files_path = File.join(File.dirname(__FILE__), '../../files')
+        @metadata_type = @creator.metadata_type
+        @output_format = nil # set by write_output_to_file
+        @brick_graph = nil #
+        @haystack = nil
+
+        supported_metadata_types = ['Brick', 'Haystack']
+        raise "metadata_type must be one of #{supported_metadata_types}" unless supported_metadata_types.include? @metadata_type
+      end
+
+      # Generates BrickGraph or Haystack from entities
+      def create_output
+        case @metadata_type
+        when 'Brick'
+          @brick_graph = BrickGraph.new
+          @brick_graph.create_from_entities(@creator.entities)
+        when 'Haystack'
+          @haystack = Haystack.new
+          @haystack = @haystack.create_from_entities(@creator.entities)
+        end
+      end
+
+      ##
+      # Write metadata model to file
+      ##
+      # @param [String] output_format One of: ['json', 'ttl', 'nq']
+      # @param [String] file_path Path to output folder
+      # @param [String] file_name_without_extension output name without extension
+      def write_output_to_file(output_format:, file_path: '.', file_name_without_extension: 'model')
+        @output_format = output_format
+        supported_haystack_formats = ['json']
+        supported_brick_formats = ['ttl', 'nq']
+        raise "Brick output format must be one of: #{supported_brick_formats}" if (@metadata_type == 'Brick') && !supported_brick_formats.include?(@output_format)
+        raise "Haystack output format must be one of: #{supported_haystack_formats}" if (@metadata_type == 'Haystack') && !supported_haystack_formats.include?(@output_format)
+        case @metadata_type
+        when 'Brick'
+          case @output_format
+          when 'ttl'
+            File.open(File.join(file_path, "#{file_name_without_extension}.ttl"), 'w') { |f| f << @brick_graph.dump(:ttl) }
+          when 'nq'
+            File.open(File.join(file_path, "#{file_name_without_extension}.nq"), 'w') { |f| f << @brick_graph.dump(:nquads) }
+          end
+        when 'Haystack'
+          File.open(File.join(file_path, "#{file_name_without_extension}.json"), 'w') { |f| f << @haystack }
+        end
+      end
+    end
+  end
+end

data/lib/openstudio/metadata.rb

@@ -0,0 +1,55 @@
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# 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 any contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission from the respective party.
+#
+# (4) Other than as required in clauses (1) and (2), distributions in any form
+# of modifications or other derivative works may not use the "OpenStudio"
+# trademark, "OS", "os", or any other confusingly similar designation without
+# specific prior written permission from Alliance for Sustainable Energy, LLC.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY 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(S), ANY CONTRIBUTORS, THE
+# UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
+# THEIR EMPLOYEES, 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.
+# *******************************************************************************
+
+require 'openstudio/extension'
+require_relative 'metadata/creator'
+require_relative 'metadata/version'
+require_relative 'metadata/writer'
+require_relative 'metadata/serializer'
+require_relative 'metadata/helpers'
+require_relative 'metadata/controls'
+
+module OpenStudio
+  module Metadata
+    class Metadata < OpenStudio::Extension::Extension
+      # Override parent class
+      def initialize
+        super
+
+        @root_dir = File.absolute_path(File.join(File.dirname(__FILE__), '..', '..'))
+      end
+    end
+  end
+end

data/lib/openstudio-metadata.rb

@@ -0,0 +1 @@
+require 'openstudio/metadata'

data/openstudio-metadata.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'openstudio/metadata/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'openstudio-metadata'
+  spec.version       = OpenStudio::Metadata::VERSION
+  spec.authors       = ['Austin Viveiros']
+  spec.email         = ['']
+
+  spec.summary       = 'library and measures for OpenStudio'
+  spec.description   = 'library and measures for OpenStudio'
+  spec.homepage      = 'https://openstudio.net'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.1', '>= 2.1.0'
+  spec.add_development_dependency 'rake', '13.0'
+  spec.add_development_dependency 'rspec', '3.7.0'
+  spec.add_development_dependency 'rubocop', '~> 0.54.0'
+
+  spec.add_dependency 'openstudio-extension', '0.2.5'
+  spec.add_dependency 'openstudio-standards', '0.2.11'
+end

data/test.rb

@@ -0,0 +1,15 @@
+# require 'bundler/gem_tasks'
+# require 'rspec/core/rake_task'
+#
+# RSpec::Core::RakeTask.new(:spec)
+#
+# require 'rubocop/rake_task'
+# RuboCop::RakeTask.new
+#
+## Load in the rake tasks from the base openstudio-extension gem
+require 'openstudio/extension/rake_task'
+# require 'openstudio/metadata'
+# os_extension = OpenStudio::Extension::RakeTask.new
+# os_extension.set_extension_class(OpenStudio::Metadata::Metadata)
+#
+# task default: :spec