folder_setup

outputting.folder_setup(label, date_string, pickle_data=False, base_path=None)[source]

Identifies and creates the folder the data will be stored in

Folder will be created as “./Outputs/<sim_label>_<date>/”. If that had previously been created then it is created as “./Outputs/<sim_label>_<date>_no_<#>/”, where “<#>” is the first available integer.

A subfolder is also created with the name Pickle if pickle is true.

Parameters:
  • label (basestring) – The label for the simulation
  • date_string (basestring) – The date identifier
  • pickle_data (bool, optional) – If true the data for each model, task and participant is recorded. Default is False
  • base_path (basestring, optional) – The path into which the new folder will be placed. Default is current working directory
Returns:

folder_name – The folder path that has just been created
Return type:

string

See also

newFile()
Creates a new file
saving()
Creates the log system