coderunner 0.14.24 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e1deca0aeb33a5da186b2c08c94945d7561cdf4
-  data.tar.gz: f97f58aba34eea4c3221d16ad88316a28b93e241
+  metadata.gz: 417fc5c2741343dc39e1f783601b939db54b3c10
+  data.tar.gz: 0334eb08f867cbcb0ea42b622bdf66ab9bb8053c
 SHA512:
-  metadata.gz: 3db503c9c435107ade3384de8f9364e645ae84e4363ff28f33b3df831014991ad1511fadd082d67eb108ec5aba4158ac65ae50826d0a6c20f3dc86d9efac4066
-  data.tar.gz: 71f72f4d1324706d49e10e7a2dbda39b90efd5b6c79518127aef12dd6d86437fc9d721a51366d13763dec467e44f15ed04a913ebc48ece427045aea65163d753
+  metadata.gz: 03e5bc3450880af1c5c824949aa560566199dcee38ac1cb26b279281276d20d2c6ff1c8da6ebb74dace1825c45d89e14cd0aa7cbdd702e9934837305354ff4de
+  data.tar.gz: ac261b9512c9cdf629e033e9bd0d367f3f08d47cc9d57e4ee32a206d3d6a701b5eb8f7dfac6b23ed7634f74b72f09b95d4c225959425de71ea1e627d92b135b2

data/VERSION

@@ -1 +1 @@
-0.14.24
+0.15.0

data/coderunner.gemspec

@@ -2,17 +2,17 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: coderunner 0.14.24 ruby lib
+# stub: coderunner 0.15.0 ruby lib
 # stub: ext/extconf.rb
 
 Gem::Specification.new do |s|
   s.name = "coderunner"
-  s.version = "0.14.24"
+  s.version = "0.15.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Edmund Highcock"]
-  s.date = "2014-10-10"
+  s.date = "2014-10-14"
   s.description = "CodeRunner is a framework for the automated running and analysis of simulations. It automatically generates any necessary input files, organises the output data and analyses it. Because it is a modular system, it can easily be customised to work with any system and any simulation code. One of its greatest strengths is that it is independent of any one simulation code; thus it can easily plot and compare the data from different codes."
   s.email = "edmundhighcock@sourceforge.net"
   s.executables = ["coderunner"]

data/lib/coderunner.rb

@@ -165,7 +165,7 @@ class CodeRunner
 	["--wall-mins", "-W", GetoptLong::REQUIRED_ARGUMENT, %[Specify the wall clock limit in minutes.]],
 	["--write-options", "-w", GetoptLong::REQUIRED_ARGUMENT, %[Use when plotting graphs. A hash of custom options which are applied to the graphkit just before plotting it; for example: -w '{xlabel: 'X Axis Quantity, log_axis: 'y'}']],
 	["--executable", "-X", GetoptLong::REQUIRED_ARGUMENT, %[Specify the location of the executable of the simulation code. It only needs to be specified once in any folder, unless it needs to be changed.]],
-	["--other-folder", "-Y", GetoptLong::REQUIRED_ARGUMENT, %[Run CodeRunner in a different folder. On a local machine 'coderunner st -Y some/other/folder' is identical to 'cd some/other/folder; coderunner st -Y'. However, this flag can also be used for remote folders using RemoteCodeRunner (as long as CodeRunner is installed on the remote machine). e.g. -Y username@machine.location:path/to/folder.]],
+	["--other-folder", "-Y", GetoptLong::REQUIRED_ARGUMENT, %[Run CodeRunner in a different folder. On a local machine 'coderunner st -Y some/other/folder' is identical to 'cd some/other/folder; coderunner st -Y'. However, this flag can also be used for remote folders using RemoteCodeRunner (as long as CodeRunner is installed on the remote machine). e.g. -Y username@machine.location:path/to/folder. If this option is specified multiple times, a merged runner will be created from the set of specified folders.]],
 	["--supplementary-options", "-y", GetoptLong::REQUIRED_ARGUMENT],
 	["--server", "-Z", GetoptLong::REQUIRED_ARGUMENT, %[Technical use only]],	
 	["--log", "-z", GetoptLong::NO_ARGUMENT, %[Switch logging on (currently not working very well (05/2010)).]]	 # :nodoc:
@@ -282,6 +282,16 @@ EOF
 			copts[:G].push arg
 		when "--run-graph"
 			copts[:g].push arg
+    when "--other-folder"
+      if copts[:Y]
+        if copts[:Y].kind_of? String
+          copts[:Y] = [copts[:Y], arg]
+        else
+          copts[:Y].push arg
+        end
+      else
+        copts[:Y] = arg
+      end
 # 		when "--cancel"
 # 			copts[:K] = arg.to_i
 		when "--multiple-processes"

data/lib/coderunner/class_methods.rb

@@ -614,7 +614,7 @@ EOF
 #     raise "something is already submitting" if FileTest.exist? "submitting"
     runs = []
     raise "Parameters must be an array of inspected hashes" unless copts[:p].kind_of? Array
-    Dir.chdir(copts[:Y]) do
+    Dir.chdir(runner.root_folder) do
 
       copts[:p].push nil if copts[:p] == []
   #         ep copts[:p]; exit
@@ -636,7 +636,7 @@ EOF
 #     raise "something is already submitting" if FileTest.exist? "submitting"
     runs = []
     raise "Parameters must be an array of inspected hashes" unless copts[:p].kind_of? Array
-    Dir.chdir(copts[:Y]) do
+    Dir.chdir(runner.root_folder) do
       runs = runner.filtered_ids.map do |id|
         eputs id
         run = runner.run_list[id].dup
@@ -795,7 +795,22 @@ EOF
       copts[:h] = :real
     end
 
+#     ep Log.log_file
+    #copts[:code_copts].each{|k,v| CODE_OPTIONS[k] = v} if copts[:code_copts]
+    copts.keys.map{|k| k.to_s}.grep(/_options$/).map{|k| k.to_sym}.each do |k|
+      CODE_OPTIONS[k.to_s.sub('_options','').to_sym] = copts[k]
+    end
+
+
+  end
+
+  # Analyse copts[:Y], the choice of the root folder for the runner, and make appropriate
+  # modifications to the command options for running remotely, etc.
+  def self.process_root_folder(copts)
     copts[:Y] ||= DEFAULT_COMMAND_OPTIONS[:Y] if DEFAULT_COMMAND_OPTIONS[:Y]
+    if copts[:Y] and copts[:Y].kind_of? Array
+      eputs "Warning: ignoring additional folders... selecting folder: #{copts[:Y]=copts[:Y][0]}"
+    end
     if copts[:Y] and copts[:Y] =~ /:/
       set_class_defaults(copts)
       copts[:running_remotely] = true
@@ -806,13 +821,6 @@ EOF
 #         ep DEFAULT_RUNNER_OPTIONS
       end
     end
-#     ep Log.log_file
-    #copts[:code_copts].each{|k,v| CODE_OPTIONS[k] = v} if copts[:code_copts]
-    copts.keys.map{|k| k.to_s}.grep(/_options$/).map{|k| k.to_sym}.each do |k|
-      CODE_OPTIONS[k.to_s.sub('_options','').to_sym] = copts[k]
-    end
-
-
   end
 
   CODE_OPTIONS={}
@@ -821,7 +829,10 @@ EOF
 
   def self.fetch_runner(copts={})
 #     ep copts
+    #read_default_command_options(copts)
+    process_command_options(copts)
     # If copts(:Y) is an array of locations, return a merged runner of those locations
+    #copts[:Y] ||= DEFAULT_COMMAND_OPTIONS[:Y] if DEFAULT_COMMAND_OPTIONS[:Y]
     if copts[:Y].kind_of? Array
       runners = copts[:Y].map do |location|
         new_copts = copts.dup.absorb(Y: location)
@@ -829,7 +840,7 @@ EOF
       end
       return Merged.new(*runners)
     end
-    process_command_options(copts)
+    process_root_folder(copts)
     #ep copts
     @runners ||= {}
     runner = nil

data/lib/coderunner/instance_methods.rb

@@ -633,8 +633,14 @@ EOF
 			end)
 	end
 	
+  # Returns an empty string. A hook for CodeRunner::Merged
+  def merged_runner_info(run)
+    ""
+  end
+
 	# Print out a summary of all the runs in the root folder, formatted in nice pretty colours. Since this is often called in a loop, if called twice without any arguments it will erase the first printout. To stop this happening set rewind to 0. If the command is being issued not in a terminal, so that CodeRunner cannot determine the size of the terminal, the second argument must be passed as an array of [rows, columns].
 
+  
 	def print_out(rewind = nil, options={}) # terminal_size = [rows, cols]
 		rewind ||= @print_out_size
 		terminal_size = options[:terminal_size]
@@ -680,6 +686,8 @@ EOF
 					#@split_point = @new_split_point
 					eprint j%2==0 ? j%4==0 ? cyan : green : dc
 					line = options[:with_comments] ? @run.comment_line : @run.print_out_line.chomp  
+          # if this is not a merged runner, merged_runner_info is an empty string
+          line = merged_runner_info(@run) + line
 					eprint line
 					eputs cln
 	# 				puts (line.size / Terminal.terminal_size[1]).class

data/lib/coderunner/merged_code_runner.rb

@@ -8,11 +8,27 @@ class CodeRunner
 		send(meth, *args)
 	end
 
+  # This class allows the analysis of multiple root folders as if they were
+  # one. For every normal runner (instance of CodeRunner) that is added to the merged runner
+  # (instance of CodeRunner::Merged), the runs of that normal runner are added to the merged
+  # run_list. Normal runner function such as CodeRunner#graphkit() can then be called.
+  #
+  # In order to keep the run_list unique, the runs from each component runner are not added
+  # to the merged runner directly: instead they are wrapped in a container of class Run::Merged
+  # which behaves like a standard run object except that it redefines the id to be [runner_index, id].
+  # Thus, within the merged runner, the id of run 43 from the third runner to be added to the merged
+  # runner is [2,43].
+  #
 	class Merged < CodeRunner
+    # Iterates over the runners contained within the merged runner.
+    # E.g.
+    #   merged_runner.each{|runner| p runner.root_folder}
 		def each
 			@runners.each{|r| yield(r)}
 		end
 		include Enumerable
+    # Create a new merged runner. <tt>runners</tt> is an array of standard runners
+    # (i.e. instances of CodeRunner).
 		def initialize(*runners)
 			@runners = []
 			r = runners[0]
@@ -22,14 +38,34 @@ class CodeRunner
 			@run_list = {}
 			runners.each{|runner| add_runner(runner)}
 		end
+    # Raises an error. At the present time, submitting 
+    # from a merged runner has no defined behaviour and 
+    # is not implemented.
+    def submit(*args)
+      raise "Submitting from a merged runner is currently not supported"
+    end
+    # A string prepended to each line of the status output for merged
+    # runners... see CodeRunner#print_out
+    def merged_runner_info(run)
+      #run.id.inspect + " : "
+      run.id[0].to_s + ","
+      #""
+    end
+    # Merge an additional runner. 
 		def add_runner(runner)
+      index = @runners.size
 			@runners.push runner
 			runner.run_list.each do |id, run|
 				#raise "Duplicate ids: #{id}" if @run_list[id]
-				@run_list[id] = run
+        merged_run = Run::Merged.new(index, run)
+				@run_list[merged_run.id] = merged_run 
 			end
 			@ids = @run_list.keys
 		end
+    # Call a method on each runner and combine the results according to 
+    # the block.
+    # E.g.
+    #   string_of_root_folders = merged_runner.merge_method(:root_folder){|string, folder| string << "," << folder}
 		def merge_method(meth, *args, &block)
 			results = @runners.map{|r| r.send(meth, *args)}
 			return results.inject{|o,n| yield(o,n)}
@@ -37,4 +73,27 @@ class CodeRunner
 
 		
 	end
+  # This is a container for run objects for use in a merged runner.
+  # Basically its job is to route all methods to the run it contains,
+  # except for the id method, which is redefined.
+  #
+  # Instead of being a number, the id of the run is now an array of two 
+  # numbers, of which the second is the id of the run contained, but the
+  # first is the index of the runner which the run corresponds to.
+  #
+  # Thus, within a merged runner (an instance of CodeRunner::Merged), each 
+  # run has a unique id, and the merged runner can treat the Run::Merged objects
+  # exactly as if they were simply Run objects.
+  class Run::Merged
+    attr_reader :run
+    attr_accessor :id
+    def initialize(runner_index, run)
+      @runner_index = runner_index
+      @run = run
+      @id = [@runner_index, @run.id]
+    end
+    def method_missing(meth, *args)
+      @run.send(meth, *args)
+    end
+  end
 end

data/lib/coderunner/remote_code_runner.rb

@@ -1,6 +1,6 @@
 class RemoteCodeRunner < CodeRunner
 	(CodeRunner.instance_methods - (Object.instance_methods + Log.instance_methods)).each do |meth|
-		next if [:sort_runs, :print_out, :filter, :similar_runs, :get_max, :get_min, :generate_combined_ids, :setup_run_class, :get_run_class_name, :readout, :graphkit_from_lists, :graphkit, :graphkit_shorthand, :run_graphkit_shorthand, :axiskit, :filtered_ids,  :filtered_run_list, :make_film_from_lists, :sweep_graphkits, :cache].include? meth
+		next if [:sort_runs, :print_out, :filter, :similar_runs, :get_max, :get_min, :generate_combined_ids, :setup_run_class, :get_run_class_name, :readout, :graphkit_from_lists, :graphkit, :graphkit_shorthand, :run_graphkit_shorthand, :axiskit, :filtered_ids,  :filtered_run_list, :make_film_from_lists, :sweep_graphkits, :cache, :merged_runner_info].include? meth
 		next if CodeRunner::DEFAULT_RUNNER_OPTIONS.keys.include? meth
 		next if CodeRunner::DEFAULT_RUNNER_OPTIONS.keys.map{|meth| (meth.to_s + '=').to_sym}.include? meth
 

data/test/test_coderunner.rb

@@ -203,9 +203,16 @@ class TestCodeRunner < Test::Unit::TestCase
 		@runner3 = CodeRunner.new(tfolder2).update
 		assert_nothing_raised{@mrunner = CodeRunner::Merged.new(@runner, @runner3)}
 		@mrunner.print_out(0)
+    #STDIN.gets
 		assert_equal(@runner.run_list.size + 1, @mrunner.run_list.size)
 		@mrunner2 = @runner.merge(@runner3)
 		assert_equal(@mrunner2.run_list.keys, @mrunner.run_list.keys)
+    assert_nothing_raised{@mrunner.add_runner(@runner)}
+    assert_equal(CodeRunner::Run::Merged, @mrunner.run_list[[2, 6]].class)
+    assert_equal(6, @mrunner.run_list[[2, 6]].run.id)
+    assert_system("#$coderunner_command st -Y #{tfolder} -Y #{tfolder2}")
+    assert_raise(RuntimeError){@mrunner.submit}
+    #STDIN.gets
 		FileUtils.rm_r tfolder2
 	end
 	

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coderunner
 version: !ruby/object:Gem::Version
-  version: 0.14.24
+  version: 0.15.0
 platform: ruby
 authors:
 - Edmund Highcock
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-10 00:00:00.000000000 Z
+date: 2014-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphkit