YAML conversion specification#

run_conversion_from_yaml(specification_file_path: Path, data_folder_path: Optional[Path] = None, output_folder_path: Optional[Path] = None, overwrite: bool = False) → None[source]#

Run conversion to NWB given a yaml specification file.

Parameters

  • specification_file_path (FilePath) – File path leading to .yml specification file for NWB conversion.

  • data_folder_path (FolderPathType, optional) – Folder path leading to root location of the data files. The default is the parent directory of the specification_file_path.

  • output_folder_path (FolderPathType, optional) – Folder path leading to the desired output location of the .nwb files. The default is the parent directory of the specification_file_path.

  • overwrite (bool, default: False) – If True, replaces any existing NWBFile at the nwbfile_path location, if save_to_file is True. If False, appends the existing NWBFile at the nwbfile_path location, if save_to_file is True.