fix(recipe): Expose debug folder on recipe settings

honeybee_grasshopper_core/json/HB_Recipe_Settings.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.6.0", 
+  "version": "1.6.1", 
   "nickname": "RecipeSettings", 
   "outputs": [
     [
@@ -36,14 +36,14 @@
     }, 
     {
       "access": "item", 
-      "name": "report_out_", 
-      "description": "A boolean to indicate whether the recipe progress should be\ndisplayed in the cmd window (False) or output form the \"report\" of\nthe recipe component (True). Outputting from the component can be\nuseful for debugging but recipe reports can often be very long\nand so it can slow Grasshopper slightly. (Default: False).", 
-      "type": "bool", 
+      "name": "debug_folder_", 
+      "description": "An optional path to a debug folder. If debug folder is\nprovided, all the steps of the simulation will be executed inside\nthe debug folder which can be used for further inspection.", 
+      "type": "string", 
       "default": null
     }
   ], 
   "subcategory": "0 :: Create", 
-  "code": "\n\ntry:\n    from lbt_recipes.settings import RecipeSettings\nexcept ImportError as e:\n    raise ImportError('\\nFailed to import lbt_recipes:\\n\\t{}'.format(e))\n\n\n# create the settings\nsettings = RecipeSettings(_folder_, _workers_, reload_old_, report_out_)\n", 
+  "code": "\n\ntry:\n    from lbt_recipes.settings import RecipeSettings\nexcept ImportError as e:\n    raise ImportError('\\nFailed to import lbt_recipes:\\n\\t{}'.format(e))\n\n\n# create the settings\nsettings = RecipeSettings(_folder_, _workers_, reload_old_, debug_folder=debug_folder_)\n", 
   "category": "Honeybee", 
   "name": "HB Recipe Settings", 
   "description": "Specify settings for the run of a recipe, including the number of workers/CPUs,\nthe project folder, and other settings.\n-"

honeybee_grasshopper_core/src/HB Recipe Settings.py

@@ -25,11 +25,9 @@
             model and recipe should be reloaded (if they are found) instead of
             re-running the entire recipe from the beginning. If False or
             None, any existing results will be overwritten by the new simulation.
-        report_out_: A boolean to indicate whether the recipe progress should be
-            displayed in the cmd window (False) or output form the "report" of
-            the recipe component (True). Outputting from the component can be
-            useful for debugging but recipe reports can often be very long
-            and so it can slow Grasshopper slightly. (Default: False).
+        debug_folder_: An optional path to a debug folder. If debug folder is
+            provided, all the steps of the simulation will be executed inside
+            the debug folder which can be used for further inspection.
 
     Returns:
         settings: Recipe settings that can be plugged into any recipe component to
@@ -38,7 +36,7 @@
 
 ghenv.Component.Name = 'HB Recipe Settings'
 ghenv.Component.NickName = 'RecipeSettings'
-ghenv.Component.Message = '1.6.0'
+ghenv.Component.Message = '1.6.1'
 ghenv.Component.Category = 'Honeybee'
 ghenv.Component.SubCategory = '0 :: Create'
 ghenv.Component.AdditionalHelpFromDocStrings = '7'
@@ -51,4 +49,4 @@
 
 
 # create the settings
-settings = RecipeSettings(_folder_, _workers_, reload_old_, report_out_)
+settings = RecipeSettings(_folder_, _workers_, reload_old_, debug_folder=debug_folder_)