pyiron_base.project.archiving.export_archive.copy_files_to_archive

pyiron_base.project.archiving.export_archive.copy_files_to_archive#

pyiron_base.project.archiving.export_archive.copy_files_to_archive(directory_to_transfer: str, archive_directory: str, compress: bool = True, copy_all_files: bool = False, arcname: str | None = None, df: DataFrame | None = None)[source]#

Copy files from a directory to an archive, optionally compressing the archive.

Parameters:

  • directory_to_transfer (str) – The directory containing the files to transfer.

  • archive_directory (str) – The destination directory for the archive.

  • compress (bool) – If True, compress the archive directory into a tarball. Default is True.

  • copy_all_files (bool) – If True, include all files in the archive, otherwise only .h5 files. Default is False.

  • arcname (str) – The name of the archive directory. Default is the name of the directory to transfer.

  • df (DataFrame) – DataFrame containing updated job information with new IDs and project paths.

Contents