pvwatts 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  # gem "rcov", ">= 0"
+  gem 'savon', '~> 0.7.6'
+  gem 'yard', '>= 0.6.4'
+end

data/Gemfile.lock

@@ -0,0 +1,34 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    builder (3.0.0)
+    crack (0.1.8)
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    savon (0.7.9)
+      builder (>= 2.1.2)
+      crack (>= 0.1.4)
+    yard (0.6.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rspec (~> 2.3.0)
+  savon (~> 0.7.6)
+  yard (>= 0.6.4)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Solar Universe, LLC
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,19 @@
+= pvwatts
+
+Wrapper around the http://www.nrel.gov/rredc/pvwatts/ web service API which calculates the Performance of a Grid-Connected PV System.
+
+== Contributing to pvwatts
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Solar Universe, LLC. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "pvwatts"
+  gem.homepage = "http://github.com/mattetti/pvwatts"
+  gem.license = "MIT"
+  gem.summary = %Q{Wrapper around the http://www.nrel.gov/rredc/pvwatts/ web service API.}
+  gem.description = %Q{Calculates the Performance of a Grid-Connected PV System.}
+  gem.email = "mattaimonetti@gmail.com"
+  gem.authors = ["Matt Aimonetti"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  gem.add_runtime_dependency 'savon', '~> 0.7.6'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/pvwatts.rb

@@ -0,0 +1,90 @@
+require 'rubygems'
+require 'savon'
+
+# Wrapper around the http://www.nrel.gov/rredc/pvwatts/ web service API.
+# Calculates the Performance of a Grid-Connected PV System. 
+# Use of the Pvwatts web service is restricted to authorized users. 
+# For information on obtaining authorization, contact bill_marion@nrel.gov
+#
+# @see http://www.nrel.gov/rredc/pvwatts/
+#
+# @author Matt Aimonetti for http://solaruniverse.com
+#
+class Pvwatts
+  
+  Savon::Request.log = false
+  DEFAULT_DERATE = 0.82
+  
+  attr_reader :api_key
+  
+  # Create an instance of the API wrapper.
+  #
+  # @param [String] api_key The Pvwatts API key provided by bill_marion@nrel.gov
+  #
+  def initialize(api_key)
+    @api_key = api_key
+  end
+  
+  # Calculate the estimated yearly production based on passed options.
+  #
+  # @param [Hash] opts
+  # @option opts [String, Float] :latitude Latitude coordinate of the location.
+  # @option opts [String, Float] :longitude Longitude coordinate of the location.
+  # @option opts [String, Float] :dc_rating
+  # @option opts [String, Integer] :tilt
+  # @option opts [String, Integer] :orientation Orientation or azimuth value.
+  # @option opts [String, Integer] :shading A percentage value between 0 and 100.
+  #
+  # @return [Hash] A hash with the yearly production with a key for each month and a 'year' key to represent the yearly value.
+  #
+  def yearly_production(opts={})
+    Rails.logger.debug("pvwatts yearly prod called") if Object.const_defined?(:Rails)
+    keys = opts.keys 
+    client = Savon::Client.new("http://pvwatts.nrel.gov/PVWATTS.asmx?WSDL")
+    @latitude, @longitude = [opts[:latitude], opts[:longitude]]
+    @dc_rating, @tilt, @orientation = opts[:dc_rating], opts[:tilt], opts[:orientation]
+    @shading = opts[:shading]
+    if @latitude.nil? || @longitude.nil? || @dc_rating.nil? || @tilt.nil? || @orientation.nil? || @shading.nil?
+      raise ArgumentError, "passed -> latitude: #{@latitude}, longitude: #{@longitude}, dc_rating: #{@dc_rating}\
+      tilt: #{@tilt} orientation: #{@orientation} shading: #{@shading}"
+    end
+    req = prep_request(@latitude, @longitude, @dc_rating, @tilt, @orientation, @shading)
+    
+    response = client.get_pvwatts{|soap| soap.input = "GetPVWATTS"; soap.body = req }
+    rdata = response.to_hash
+    if rdata[:get_pvwatts_response] && rdata[:get_pvwatts_response][:get_pvwatts_result] && rdata[:get_pvwatts_response][:get_pvwatts_result][:pvwatt_sinfo]
+      @production_data = {}
+      @pvwatt_info = rdata[:get_pvwatts_response][:get_pvwatts_result][:pvwatt_sinfo].compact
+      @pvwatt_info.each do |el| 
+        if el.respond_to?(:has_key?) && el.has_key?(:month)
+          @production_data[el[:month].downcase] = el[:a_cenergy].to_i
+        end
+      end
+    else
+      raise 'Problem with the pvwatts response'
+    end
+    @production_data
+  end
+  
+  private
+  
+  def prep_request(latitude, longitude, dc_rating, tilt, orientation, shading)
+    Rails.logger.debug "calling pvwatts with: latitude: #{latitude}, longitude: #{longitude}, dc_rating: #{dc_rating}, tilt: #{tilt}, orientation: #{orientation}, shading: #{shading}" if Object.const_defined?(:Rails)
+    shading = (shading == 0 ? 1 : shading / 100)
+    { 'wsdl:key'        => api_key,
+      'wsdl:latitude'   => latitude,
+      'wsdl:longitude'  => longitude,
+      'wsdl:locationID' => '', 
+      'wsdl:DCrating'   => dc_rating, 
+      # I will have to give this some thought, but .8 is a better number for now– it has todo with the shading and efficiency of inverters – we may need to pass efficiency data to get an accurate number along with the shading data (ie. how shaded the location is))
+      'wsdl:derate'     => (DEFAULT_DERATE * shading),
+      'wsdl:cost'       => 0.0,
+      'wsdl:mode'       => 0,
+      'wsdl:tilt'       => tilt,
+      'wsdl:azimuth'    => orientation,
+      'wsdl:inoct'      => 45.0,
+      'wsdl:pwrdgr'     => -0.005
+    }
+  end
+  
+end

data/pvwatts.gemspec

@@ -0,0 +1,71 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{pvwatts}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Matt Aimonetti"]
+  s.date = %q{2011-03-06}
+  s.description = %q{Calculates the Performance of a Grid-Connected PV System.}
+  s.email = %q{mattaimonetti@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/pvwatts.rb",
+    "pvwatts.gemspec",
+    "spec/pvwatts_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/mattetti/pvwatts}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Wrapper around the http://www.nrel.gov/rredc/pvwatts/ web service API.}
+  s.test_files = [
+    "spec/pvwatts_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<savon>, ["~> 0.7.6"])
+      s.add_development_dependency(%q<yard>, [">= 0.6.4"])
+      s.add_runtime_dependency(%q<savon>, ["~> 0.7.6"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<savon>, ["~> 0.7.6"])
+      s.add_dependency(%q<yard>, [">= 0.6.4"])
+      s.add_dependency(%q<savon>, ["~> 0.7.6"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<savon>, ["~> 0.7.6"])
+    s.add_dependency(%q<yard>, [">= 0.6.4"])
+    s.add_dependency(%q<savon>, ["~> 0.7.6"])
+  end
+end
+

data/spec/pvwatts_spec.rb

@@ -0,0 +1,30 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Pvwatts do
+  
+  before(:all) do
+    @pdata = Pvwatts.new(PVWATTS_SPEC_KEY).yearly_production(   :latitude    => 32.95850, 
+                                              :longitude   => -117.12206, 
+                                              :dc_rating   => 4.0, 
+                                              :tilt        => 45, 
+                                              :orientation => 180,
+                                              :shading     => 0)
+  end
+  
+  it "should fetch the yearly production data" do
+    @pdata['jan'].should == 496
+    @pdata['feb'].should == 469
+    @pdata['mar'].should == 539
+    @pdata['apr'].should == 525
+    @pdata['may'].should == 539
+    @pdata['jun'].should == 498
+    @pdata['jul'].should == 526
+    @pdata['aug'].should == 554
+    @pdata['sep'].should == 540
+    @pdata['oct'].should == 536
+    @pdata['nov'].should == 508
+    @pdata['dec'].should == 471
+    @pdata['year'].should == 6203
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'pvwatts'
+require 'savon'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+# Set this constant to run the tests
+PVWATTS_SPEC_KEY = nil
+raise "You first need to set the PVWATTS_SPEC_KEY constant in spec_helper.rb" if PVWATTS_SPEC_KEY.nil?
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification 
+name: pvwatts
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Matt Aimonetti
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-06 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: savon
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 7
+        - 6
+        version: 0.7.6
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: yard
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 4
+        version: 0.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: savon
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 7
+        - 6
+        version: 0.7.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *id006
+description: Calculates the Performance of a Grid-Connected PV System.
+email: mattaimonetti@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/pvwatts.rb
+- pvwatts.gemspec
+- spec/pvwatts_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/mattetti/pvwatts
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -4335976862583453684
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Wrapper around the http://www.nrel.gov/rredc/pvwatts/ web service API.
+test_files: 
+- spec/pvwatts_spec.rb
+- spec/spec_helper.rb