urbanopt-reopt 0.10.0 → 0.12.0

data/lib/urbanopt/reopt/scenario/reopt_scenario_csv.rb

@@ -16,9 +16,9 @@ module URBANopt
     class REoptScenarioCSV < ScenarioCSV
       ##
       # REoptScenarioCSV is an extension of ScenarioCSV which assigns a Simulation Mapper to each Feature in a FeatureFile using a simple CSV format.
-      # The a \REopt Lite enabled CSV file has four columns 1) feature_id, 2) feature_name, 3) mapper_class_name and 4) optional reopt assumptions file name.  There is one row for each Feature.
-      # A REoptScenarioCSV can be instantiated with set of assumptions to use in \REopt Lite for an optimization at the aggregated ScenarioReport level.
-      # A REoptScenarioCSV is also instantiated with a +reopt_files_dir+ file directory containing all \REopt Lite assumptions files (required only if the ScenarioReport or its FeatureReports will have specified assumptions).
+      # The a \REopt enabled CSV file has four columns 1) feature_id, 2) feature_name, 3) mapper_class_name and 4) optional reopt assumptions file name.  There is one row for each Feature.
+      # A REoptScenarioCSV can be instantiated with set of assumptions to use in \REopt for an optimization at the aggregated ScenarioReport level.
+      # A REoptScenarioCSV is also instantiated with a +reopt_files_dir+ file directory containing all \REopt assumptions files (required only if the ScenarioReport or its FeatureReports will have specified assumptions).
       #
       # [*parameters:*]
       #
@@ -29,8 +29,8 @@ module URBANopt
       # * +mapper_files_dir+ - _String_ - Directory containing all mapper class files containing MapperBase definitions.
       # * +csv_file+ - _String_ - Path to CSV file assigning a MapperBase class to each feature in feature_file.
       # * +num_header_rows+ - _String_ - Number of header rows to skip in CSV file.
-      # * +reopt_files_dir+ - _String_ - Path to folder containing default \REopt Lite assumptions JSON's.
-      # * +scenario_reopt_assumptions_file_name+ - _String_ - Name of .json file in the +reopt_files_dir+ location to use in assessing the aggregated ScenarioReport in \REopt Lite.
+      # * +reopt_files_dir+ - _String_ - Path to folder containing default \REopt assumptions JSON's.
+      # * +scenario_reopt_assumptions_file_name+ - _String_ - Name of .json file in the +reopt_files_dir+ location to use in assessing the aggregated ScenarioReport in \REopt.
       ##
       def initialize(name, root_dir, run_dir, feature_file, mapper_files_dir, csv_file, num_header_rows, reopt_files_dir = nil, scenario_reopt_assumptions_file_name = nil)
         super(name, root_dir, run_dir, feature_file, mapper_files_dir, csv_file, num_header_rows)
@@ -66,12 +66,12 @@ module URBANopt
           feature_id = row[0].chomp
           feature_name = row[1].chomp
           mapper_class = row[2].chomp
-          # Assume fourth columns, if exists, contains the name of the JSON file in the reopt_files_dir to use when running \REopt Lite for the feature report
+          # Assume fourth columns, if exists, contains the name of the JSON file in the reopt_files_dir to use when running \REopt for the feature report
 
           if row.length > 3 && !@reopt_files_dir.nil?
             @reopt_feature_assumptions[idx - 1] = File.join(@reopt_files_dir, row[3].chomp)
           end
-          
+
           # gets +features+ from the feature_file.
           features = []
           feature = feature_file.get_feature_by_id(feature_id)