aurora_file_processor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6dc40acd65096580852f989a41645d63809be35b
+  data.tar.gz: 7f1df16f5abdf45fc01b73799d62c3045b49faec
+SHA512:
+  metadata.gz: cc4f7df7d9f168c929b22260f5982cf17cc5c2a96e0baa83959e226b1148ef960b78cd42f7faadab7cce75fce694bfe345c667628f2e95dc81ca633646e09bfb
+  data.tar.gz: 5b9383fdbb69e64299148a04f5d1ecaf53a7127b5cbcd4f5a0ad6240f4cb675ab2011fa5b3894d18747079d86f48702aa3509450085de9398cd1bb3fd1b06bd6

data/bin/aurora_file_processor

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require "aurora_file_processor"
+
+f = AuroraFileProcessor.new(ARGV[0], ARGV[1])
+f.read_file

data/lib/aurora_file_processor.rb

@@ -0,0 +1,211 @@
+# A module to store constants relating to electrical production and CO2 emission analysis
+module Constants
+	# g CO2 emitted per kWh produced. (Source: carbonfund.org (ca. 2012))
+  CO2_USGRID = 592.5
+  # TWh energy, US eletrical grid, 2012 (Source: Wiki)
+  ENERGY_USGRID = 4143
+  # A hash that stores 6 common types of renewable energy generation as the keys and service lifecycle carbon emissions
+  # per kWh generated as the values (source: Wiki)
+  ENERGY_TYPES = {
+  	PV_Solar: 46, 
+  	Thermal_Solar: 22, 
+  	Onshore_Wind: 12,
+  	Geothermal: 45,
+  	Hydroelectric: 4,
+  	Biomass: 18, 	
+  	 }
+end
+
+# String class: adds two methods
+#
+# Author: Renee Hendrickson 
+# Credit: thanksgiving_dinner.rb answer key
+#
+class String
+	# A method that upcases the first letter of each word
+	def titlecase
+		self.gsub(/\b\w/){|f| f.upcase}
+	end
+
+	# A method to replace underscores in variable names with spaces for human reading
+	def humanize
+		self.gsub('_',' ').titlecase
+	end
+end
+
+# This class processes energy and power files unique to the Aurora Power-One inverter.
+#
+# Author: Chris Ashfield
+# License: MIT
+# 
+# More info about the Aurora device can be found here: 
+# http://www.power-one.com/renewable-energy/products/solar/string-inverters/aurora-uno-single-phase/pvi-30363842-north-america/series
+# 
+class AuroraFileProcessor
+	include Constants
+
+  # Total energy output in Wh
+	attr_reader :energy_amount
+	# Total inverter operating time represented by file
+	attr_reader :energy_run_time
+	# an array containing both files inputted on the command line
+	attr_reader :filename
+	# Maximum power (in W) recorded in the power file
+	attr_reader :max_power
+	# Minimum power (in W) recorded in the power file
+	attr_reader :min_power
+	# Average power (W) calculated by dividing energy by runtime (energy file used only)
+	attr_reader :ave_power
+	# The differential carbon impact of utilizing a renewable energy system versus the 
+	# average of the entire US electrical grid
+	attr_reader :carbon_savings
+	# The specific type of renewable energy system. Defaults to PV Solar.
+	attr_reader :system_type
+  
+  # The initialization method takes two arguments that were entered on the command line. 
+  # There must be exactly one energy file and one power file. They can be named anything 
+  # (note: without spaces) and be entered in any order.
+  #
+  # === Attributes
+  #
+  # * +filename1+ The first file read from the command line arguments
+  # * +filename2+ The second file read from the command line arguments
+  #
+	def initialize filename1, filename2
+		@filename = [filename1, filename2]
+		# boolean vasriables to help track which file is read first
+		@parsed_energy = false
+		@parsed_power = false
+		# keeps track of the number of files read in
+		@file_count = 0
+	end
+
+  # A helper method to read in the file and map it to an array of strings
+  #
+  def read_file
+  	@readin = []
+    file = File.open(@filename[@file_count], 'r') 
+	  @readin = file.each.to_a
+	  # chop off the escaped characters (in this case: \r\n)
+    @readin.map! {|s| s.chomp}
+    # increment the file count
+    @file_count += 1
+    file.close
+    # determine which file was read in
+    # the files either have a "W" (for power) or "Wh" as the first line
+  	if @readin[0] =~ /Wh/
+  		parse_energy
+  	else @readin[0] =~ /W/
+  		parse_power
+  	end
+  end
+  
+  # A helper method to map the values (now in an array from either file type) to a hash
+  #
+  def parse_hash 
+  	hash = {}
+  	# Remove the first five lines of the file
+  	temp_array = @readin[5, @readin.length]
+  	# Split the input at the semicolon: the left hand side is a timestamp and the right hand side 
+  	# is the value (either power in W, or energy in Wh depending on the file type).
+  	# This is committed to a hash with time as the key and the W/Wh as the value.
+  	temp_array.each do |s|
+  		k,v = s.split(/;/)
+  		# the Aurora reports time as seconds since 1/1/0000 and Ruby reports time utilizing an epoch
+  		# that began on 1/1/1970. The time stamp is adjusted for the time in seconds between these
+  		# two dates.
+  		hash[Time.at(k.to_i - 62167104000)] = v.to_f
+  	end
+  	return hash
+  end
+  
+  # A method to parse the data originally from the energy file and calculate the amount of time
+  # that past respresented by the data and total energy outputted (and assign them to variables)
+  #
+  def parse_energy
+  	energy_hash = parse_hash
+  	# total energy produced
+  	temp_array = []
+  	temp_array = energy_hash.to_a
+  	# runtime in hours
+  	@energy_run_time = (temp_array[temp_array.length - 1][0] - temp_array[0][0])/3600.0
+  	# energy in Wh
+  	@energy_amount = (temp_array[temp_array.length - 1][1] - temp_array[0][1])
+  	
+  	# if the program parsed energy before power, do power now
+  	@parsed_energy = true
+  	read_file unless @parsed_power
+  	output_report
+  end
+
+  # A method to parse the data originally from the power file and find the maximum power
+  # reading, minimum power reading, and assign them to class variables
+  #
+  def parse_power
+  	power_hash = parse_hash
+  	@max_power = power_hash.values.max
+  	@min_power = power_hash.values.min
+  	@parsed_power = true
+  	read_file unless @parsed_energy
+  end
+  
+  # A method to output a human readable report summarizing the data captured in the energy and power files.
+  #
+  # This method is called after the energy and power files have been parsed and the desired values
+  # calculated and comitted to variables.
+  #
+  def output_report
+  	# Have user indicate the type of renewable energy system that generated the file
+  	# The Aurora is type-agnostic: it only reports power and energy regardless of the type.
+  	#
+  	puts "Enter the number for the type of renewable production system?\n"
+  	puts "1.\tPV Solar\n"
+  	puts "2.\tThermal Solar\n"
+  	puts "3.\tOnshore Wind\n"
+  	puts "4.\tGeothermal\n"
+  	puts "5.\tHydroelectric\n"
+  	puts "6.\tBiomass\n"
+  	print "Your Choice: "
+  	warning = ""
+		input = STDIN.gets.chomp
+		case input.to_i
+		when 1
+			@system_type = :PV_Solar
+		when 2
+			@system_type = :Thermal_Solar
+	  when 3
+	  	@system_type = :Onshore_Wind
+		when 4
+			@system_type = :Geothermal
+		when 5
+			@system_type = :Hydroelectric
+		when 6
+			@system_type = :Biomass
+	  else
+	  	warning = "Invalid energy type give. Default is "
+	  	@system_type = :PV_Solar
+		end
+		@carbon_savings = (@energy_amount / 1000.0) * (CO2_USGRID - ENERGY_TYPES[@system_type])
+		@ave_power = (@energy_amount / @energy_run_time).round(2)
+		# Write a new output file. Note that this overwrites any existing file.
+  	output_file = File.open("Energy Report", 'w+') 
+  	output_file.write("ENERGY REPORT\n")
+  	output_file.write("Energy System Type: #{warning} #{@system_type.to_s.humanize}\n\n")
+  	output_file.write("Total Operating Time: #{@energy_run_time} hours\n")
+    output_file.write("Total Energy Produced: #{@energy_amount} Wh\n")
+    output_file.write("Your Power Range was #{@min_power} to #{@max_power} W.\n")
+    output_file.write("Your Average Power was: #{@ave_power} W\n\n")
+    output_file.write("Carbon Productivity-Sequestration:\n")
+    output_file.write("#{@system_type.to_s.humanize} Rating: #{ENERGY_TYPES[@system_type]} g CO2 per kWh\n")
+    output_file.write("US Average: #{CO2_USGRID} g CO2 per kWh\n")
+    output_file.write("Your energy production resulted in #{@carbon_savings.to_i} g net " \
+    	"CO2 Productivity-Sequestration\n")
+    output_file.close
+    if File.exists?("Energy Report") 
+    	puts "Report generated successfully!"
+    end
+  end
+
+end
+
+

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: aurora_file_processor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Ashfield
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-12 00:00:00.000000000 Z
+dependencies: []
+description: The gem takes exactly one energy file and one power file generated by
+  the inverter. The two filenames are enter on the command line without spaces (no
+  order necessary)
+email: biodieselchris@gmail.com
+executables:
+- aurora_file_processor
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/aurora_file_processor.rb
+- bin/aurora_file_processor
+homepage: http://rubygems.org/gems/aurora_file_processor
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.9
+signing_key: 
+specification_version: 4
+summary: A gem to process energy and power files outputted by the Aurora Power-One
+  inverter
+test_files: []