Recipe Settings

- [source code]
Specify settings for the run of a recipe, including the number of workers/CPUs, the project folder, and other settings.


  • folder
    Path to a project folder in which the recipe will be executed. If None, the default project folder for the Recipe will be used.
  • workers
    An integer to set the number of CPUs used in the execution of the recipe. This number should not exceed the number of CPUs on the machine and should be lower if other tasks are running while the simulation is running. If unspecified, it will automatically default to one less than the number of CPUs currently available on the machine. (Default: None)
  • reload_old
    A boolean to indicate whether existing results for a given 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).


  • settings
    Recipe settings that can be plugged into any recipe component to specify how the simulation should be run.