hsntools.paths.create.create_session_directory

hsntools.paths.create.create_session_directory(project_path, subject, experiment, session, recordings_name='recordings', session_folders={'01_raw': ['behavior', 'neural'], '02_processing': ['alignment', 'metadata', 'sorting', 'task'], '03_extracted': ['spikes', 'lfp']}, verbose=True)

Create the folder structure for one or more sessions of data.

Parameters:

project_pathstr or Path

The path to the project folder.

subjectstr or list

The subject code(s) to create the session folders within.

experimentstr

Experiment name to create the session folders within.

sessionstr or int or list

The session label(s) to create the folder structure for. Can be an integer index, or a string, for example session_0. If list, should be a list of str or int to create multiple session folders.

recordings_namestr, optional

The name of the subfolder (within project_path) to store recordings.

session_foldersdict, optional

Defines the folder names to initialize as part of the session folder. Each key defines a sub-directory within the session folder. Each set of values is a list of folder names for within each sub-directory.

verbosebool, optional, default: True

Whether to print out information.