cape.pyover.manage: Manage pyover case folders

This module is a derivative of the main solution folder management module cape.manage for OVERFLOW. It provides OVERFLOW-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 --unarchive command does not require any specific customizations for OVERFLOW, and the generic version of cape.manage.UnarchiveFolder() is just called directly.

See also:
cape.pyover.manage.ArchiveFolder(opts, phantom=False)

Archive a folder to a backup location and clean up

Call:
>>> pyOver.manage.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; phantom kwarg

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

Delete files before archiving and regardless of status

Call:
>>> pyOver.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; phantom kwarg

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

Archive a folder and delete all but most essential files

Call:
>>> pyOver.manage.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