cape.pykes.manage: Manage files in pykes run folders

This module is a derivative of the main solution folder management module manage. It provides FUN3D-specific versions of the three top-level functions, which each correspond to a primary command-line option.

Function

Command-line

CleanFolder()

--clean

ArchiveFolder()

--archive

SkeletonFolder()

--skeleton

The FUN3D-specific versions of these commands use the function pyFun.options.Archive.auto_Archive(), which apply the default settings appropriate to pyFun, and then call the generic version of the function with the same name from manage. In addition, this module sets

# Subdirectories
fsub = ["Flow"]

which instructs the archiving functions to also look inside the folder Flow/ if it exists.

The --unarchive command does not require any specific customizations for FUN3D, and the generic version of manage.UnarchiveFolder() is just called directly.

See also:

  • manage

  • cape.pyfun.options.Archive

  • cape.options.Archive

cape.pykes.manage.ArchiveFolder(opts, phantom=False)

Archive a folder to a backup location and clean up nonessential files

Call:
>>> ArchiveFolder(opts, phantom=False)
Inputs:
opts: cape.options.Options

Options interface including management/archive interface

phantom: True | {False}

Write actions to archive.log; only delete if False

Versions:

  • 2016-12-09 @ddalle: Version 1.0

  • 2017-12-15 @ddalle: Version 1.1; add phantom

cape.pykes.manage.CleanFolder(opts, phantom=False)

Delete files before archiving and regardless of status

Call:
>>> pyFun.manage.CleanFolder(opts, phantom=False)
Inputs:
opts: cape.options.Options

Options interface including management/archive interface

phantom: True | {False}

Write actions to archive.log; only delete if False

Versions:

  • 2017-03-10 @ddalle: Version 1.0

  • 2017-12-15 @ddalle: Version 1.1; add phantom

cape.pykes.manage.SkeletonFolder(opts, phantom=False)

Archive a folder and delete all but most essential files files

Call:
>>> SkeletonFolder(opts, phantom=False)
Inputs:
opts: cape.options.Options

Options interface including management/archive interface

phantom: True | {False}

Write actions to archive.log; only delete if False

Versions:

  • 2017-12-14 @ddalle: Version 1.0

  • 2017-12-15 @ddalle: Version 1.1; add phantom