iblrig.commands.transfer_data

iblrig.commands.transfer_data(tag=None, local_path=None, remote_path=None, dry=False, interactive=False, cleanup_weeks=2, **kwargs)[source]

Copies data from the rig to the local server.

Parameters:

  • tag (str) – The acquisition PC tag to transfer, e.g. ‘behavior’, ‘video’, ‘ephys’, ‘timeline’, etc.

  • local_path (Path) – Path to local subjects folder, otherwise fetches path from iblrig_settings.yaml file.

  • remote_path (Path) – Path to remote subjects folder, otherwise fetches path from iblrig_settings.yaml file.

  • dry (bool) – Do not copy or remove local data.

  • interactive (bool) – If true, users are prompted to review the sessions to copy before proceeding.

  • cleanup_weeks (int, bool) – Remove local data older than this number of weeks. If False, do not remove.

  • kwargs – Optional arguments to pass to SessionCopier constructor.

Returns:

A list of the copier objects that were run.

Return type:

list of SessionCopier

Parameters:

  • local_path (Path | None)

  • remote_path (Path | None)

  • dry (bool)

  • interactive (bool)