cape.pyfun.manage: Manage pyFun case folders

This module is a derivative of the main solution folder management module cape.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 sets

# Subdirectories
fsub = ["Flow"]

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

See also:

• cape.manage

• cape.pyfun.options.archiveopts

• cape.cfdx.options.archiveopts

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

Archive a folder to a backup location and clean

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.pyfun.manage.CleanFolder(opts, phantom=False)

Delete files before archiving and regardless of status

Call:

>>> 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.pyfun.manage.SkeletonFolder(opts, phantom=False)

Archive a folder and delete all but most essential 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