simulator 0.1.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+
+gemspec
+
+group :development do
+  gem 'guard-cucumber'
+  gem 'guard-rspec'
+  gem 'ruby_gntp'
+  gem 'pry'
+end
+group :test do
+  gem "rspec"
+  gem "rspec-expectations", "~>2.12.1"
+  gem "cucumber"
+end
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jamie Ly
+
+MIT License
+
+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.md

@@ -0,0 +1,67 @@
+# Simulator
+
+Use to easily create models and view results across periods. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simulator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simulator
+
+## Usage
+
+See the features for some examples.
+
+    bundle exec cucumber
+
+See the specs for some simpler examples.
+
+    bundle exec rspec
+
+See the `examples` subdirectory for examples as well. Including the one
+excerpted below:
+
+```ruby
+# We create a model that simulates a ball drop
+model = Simulator::Model.new do
+  name = "Ball drop model"
+  # create a couple static variables to represent acceleration with
+  # default values
+  var :ax, 0
+  var :ay, - 9.8
+
+  # create dynamic variables bound to some computation, with default
+  # values. 
+
+  # velocity is affected by acceleration
+  eqtn(:vx, 20) { vx + ax }
+  eqtn(:vy, 50) { vy + ay }
+
+  # position is affected by velocity
+  eqtn(:x, 10) { x + vx }
+  eqtn(:y, 100) { y + vy }
+end
+
+# Run the model 10 periods
+model_run = model.new_run
+10.times do 
+  model_run.step
+end
+
+# retrieve the data
+series = model_run.data.series :x, :y
+puts series
+# > [[30, 50, 70, 90, 110, 130, 150, 170, 190, 210, 210],
+# > [140.2, 170.6, 191.2, 202.0, 203.0, 194.2, 175.6, 147.2, 108.99999999999999, 60.999999999999986, 60.999999999999986]]
+
+# Then plot it or do whatever you like
+```
+

data/RELEASE.md

@@ -0,0 +1,31 @@
+v0.1.2
+======
+* Added detail to gemspec
+
+v0.1.1
+======
+* Added mortgage example
+
+v0.1.0
+======
+* First minor release
+* Removes `puts` in `Model.rb`
+* Alters beer_spec to use new var default syntax
+
+v0.0.5
+======
+* Added "bounce" example
+* Added arg to pass default value of variable with eqtn call
+
+v0.0.4
+======
+
+v0.0.3
+======
+* Added block parameter to Model instantiation to more easily create
+  variables and equations.
+* Added "interest" spec to test a simple interest model
+* Added "beer" spec for a more complex model example
+* Added `delay` function which allows equations to interact with past periods
+
+

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/examples/drop/Gemfile

@@ -0,0 +1,5 @@
+source :rubygems
+
+gem 'simulator', path: '../..'
+gem 'chunky_png'
+

data/examples/drop/drop.rb

@@ -0,0 +1,70 @@
+require 'json'
+require 'chunky_png'
+require 'simulator'
+
+module Drop
+  class Program
+    attr_accessor :model, :steps_per_second
+
+    def initialize
+      steps_per_second = 3.0
+      @steps_per_second = steps_per_second
+      @model = ::Simulator::Model.new do
+        name = "Drop model"
+        var :ax, 0
+        var :ay, - 9.8/steps_per_second
+        eqtn(:vx, 20) { vx + ax }
+        eqtn(:vy, 50) { vy + ay }
+        eqtn(:x, 10) { x + vx }
+        eqtn(:y, 100) { y + vy }
+      end
+      @height = 500
+      @width = 700
+    end
+
+    def model_data
+      # Run the model 30 steps
+      model_run = @model.new_run
+      30.times do 
+        model_run.step
+      end
+      
+      # get the data
+      model_run.data
+    end
+
+    def norm_data(data)
+      xs, ys = data.series :x, :y
+
+      # normalize
+      xs = xs.collect(&:round)
+      # Flip the y coordinates so we can draw
+      ys = ys.collect {|y| @height - y.round}
+
+      xs.zip(ys)
+    end
+
+    def plot_data(filename, pts)
+      # display the data in an image
+      image = ChunkyPNG::Image.new @width, @height, 
+        ChunkyPNG::Color::BLACK
+      pts.each do |pt|
+        x, y = pt
+        image.circle x, y, 3, ChunkyPNG::Color('red')
+      end
+      image.save filename
+    end
+
+
+    def run
+      data = model_data
+      pts = norm_data data
+      plot_data 'drop.png', pts
+    end
+  end
+end
+
+
+# Run the program
+Drop::Program.new.run
+

data/examples/mortage/Gemfile

@@ -0,0 +1,5 @@
+source :rubygems
+
+gem 'simulator', path: '../..'
+gem 'chunky_png'
+

data/examples/mortage/mortgage.rb

@@ -0,0 +1,91 @@
+require 'simulator'
+require 'chunky_png'
+
+module Mortgage
+  class Program
+    include Simulator
+    def model
+      @model = Model.new do
+        name = "Mortgage model"
+
+        # monthly steps
+        var :base_rate, 0.08
+        eqtn(:annual_rate) { base_rate + rand(10).to_f/1000 }
+        eqtn(:monthly_rate) { annual_rate / 12.0 }
+        var :payment, 2000
+        eqtn :balance, 250000 do
+          balance * (1 + monthly_rate) - payment
+        end
+      end
+    end
+
+    def model_data
+      # fixed rate mortgage
+      fixed = @model.new_run
+      fixed.set payment: 2100
+      (30 * 12).times { fixed.step }
+
+      # balloon
+      balloon = @model.new_run
+      balloon.set payment: 1850
+      (30 * 12).times { balloon.step }
+
+      variable = @model.new_run
+      # first 10 years, stick with low payment
+      variable.set payment: 1800
+      (10 * 12).times do
+        variable.step
+      end
+
+      # subsequent years, balloon to higher payment until its paid
+      variable.set payment: 2100
+      (20 * 12).times {variable.step}
+      @balances = {
+        variable: variable.data.series(:balance),
+        fixed: fixed.data.series(:balance),
+        balloon: balloon.data.series(:balance)
+      }
+
+      @balances
+    end
+    def plot
+      @height = 500
+      @width = 800
+
+      # display the data in an image
+      image = ChunkyPNG::Image.new @width, @height, 
+        ChunkyPNG::Color::BLACK
+
+      peg = @balances[:variable]
+      count = peg.length
+      max = peg.max.to_f
+      colors = {
+        variable: ChunkyPNG::Color('blue'), 
+        fixed: ChunkyPNG::Color('yellow'),
+        balloon: ChunkyPNG::Color('red')
+      }
+      @balances.keys.each do |type|
+        balances = @balances[type]
+        color = colors[type]
+
+        balances.each_index do |i|
+          x = i/count.to_f * @width
+          y = @height - (balances[i]/max * @height).to_i
+          image.circle x, y, 3, color
+        end
+      end
+
+      image.save @filename
+    end
+    def run
+      model
+      model_data
+      @filename = "mortgage.png"
+      plot
+    end
+
+  end
+end
+
+Mortgage::Program.new.run
+

data/features/equations.feature

@@ -0,0 +1,17 @@
+Feature: equations
+  In order to create simulations
+  As a simulation author
+  I want to be able to create equations which model the behavior of a system
+
+  Scenario: adding equations to scenarios
+    Given a model
+    When I add a new equation
+    Then it should be accessible in the list of equations
+
+  Scenario: creating an equation based on the pythagorean equation
+    Given a variable context
+    And a value 3 bound to x
+    And a value 4 bound to z
+    When I create a new equation "Math.sqrt(x^2 + z^2)"
+    Then I get a value result 5
+

data/features/physics.feature

@@ -0,0 +1,22 @@
+Feature: Kinematics estimation
+  In order to determine the path of a ball
+  As someone studying physics
+  I want to be able model kinematics equations
+
+  Scenario: dropping a ball from rest
+    Given a model
+    And variable "velocity_y"
+    And variable "acceleration_y"
+    And variable "displacement_y"
+    And variable "t"
+    And equation "acceleration_y * t" bound to velocity_y
+    And equation "0.5 * acceleration_y * t**2" bound to displacement_y
+    And equation "t + 1" bound to t
+    And a new run of the model
+    And the value 0 bound to displacement_y
+    And the value 1 bound to t
+    And the value -9.8 bound to acceleration_y
+    When I step the run for 10 periods
+    Then the value -490 should be bound to displacement_y
+    And the value -98 should be bound to velocity_y
+

data/features/savings_simulation.feature

@@ -0,0 +1,17 @@
+Feature: savings simulation
+  In order to simulate the outcome of savings rates across a number of periods
+  As a simulation runner
+  I want the simulation to output the outcome of the decisions made
+
+  Scenario: constant savings rate
+    Given a savings model
+    And variable "savings_rate"
+    And variable "savings"
+    And equation "savings * (1+savings_rate)" bound to savings
+    And a new run of the model
+    And the value 100 bound to savings
+    And the value 0.05 bound to savings_rate
+    When I step the run for 10 periods
+    Then the value 162.89 should be bound to savings
+
+

data/features/step_definitions/equations_steps.rb

@@ -0,0 +1,52 @@
+require 'simulator'
+include Simulator
+
+Given /^a variable context$/ do
+  @context = VariableContext.new
+end
+
+Given /^a value (\d+) bound to (\w+)$/ do |value, name|
+  @var = Variable.new name.to_sym
+  @context.add_variables @var
+  @context.set name.to_sym => value.to_i
+end
+
+When /^I create a new equation "(.*?)"$/ do |arg1|
+  @pythagorean_eqtn = Equation.new @var do
+    Math.sqrt( x*x + z*z )
+  end
+end
+
+Given /^variables with values x=(\d+), and y=(\d+)$/ do |x_value, y_value|
+  @context = VariableContext.new
+  @context.add x: 3, z: 4
+
+  # set the values of the variables in this context
+  @context.set x: x_value.to_i, z: y_value.to_i
+end
+
+Then /^I get a value result (\d+)$/ do |equation_result|
+  # the context evaluates an equation in its own context
+  @pythagorean_eqtn.evaluate_in(@context).should eq equation_result.to_i
+end
+
+Then /^a bound variable "(.*?)" with value (\d+)$/ do |var_name, value|
+  @context.get(var_name.to_sym).value.should eq value.to_i
+end
+
+Given /^a model$/ do
+  @model = Model.new
+end
+
+When /^I add a new equation$/ do
+  @new_equation = Equation.new nil do
+    1 + 1
+  end
+  @model.add_equation @new_equation
+end
+
+Then /^it should be accessible in the list of equations$/ do
+  @model.equations.member?(@new_equation).should be true
+end
+
+