iblrig.transfer_experiments.copy_folders

iblrig.transfer_experiments.copy_folders(local_folder, remote_folder, overwrite=False)[source]

Copy folders and files from a local location to a remote location.

This function copies all folders and files from a local directory to a remote directory. It provides options to overwrite existing files in the remote directory and ignore specific file patterns.

Parameters:
  • local_folder (Path) – The path to the local folder to copy from.

  • remote_folder (Path) – The path to the remote folder to copy to.

  • overwrite (bool, optional) – If True, overwrite existing files in the remote folder. Default is False.

Returns:

True if the copying is successful, False otherwise.

Return type:

bool

Parameters: