cape.pyover.options.archiveopts: OVERFLOW archiving options

This module provides OVERFLOW-specific modifications to the base archiving options module.

Default behavior for OVERFLOW case archiving, which is defined in this module, is to copy several of the large files (such as mesh, solution, etc.) and create several tar bombs. The default tar balls that are created within an archive folder are specified in two separate commands. For each dictionary, the name of the key is the name of the tar file, and the list on the right-hand side is a list of file globs that go into the tar file. These are set or modified in the ArchivePostTarGroups setting.

# Plot3D files
Plot3DDict = [
    {"brkset.[0-9]*": 1},
    {"q.[0-9]*":      1},
    {"x.[0-9]*":      1},
]
# Run output files
RunDict = [
    {"run": "run.[0-9frtls][0-9oeup]*"},
    {"out": "*.out"},
    {"SurfBC": "SurfBC*.dat"},
    {"pyover": [
        "pyover*",
        "case.json",
        "conditions.json"
    ]},
    {"meshinfo": [
        "Config.xml",
        "grdwghts.save",
        "mixsur.save",
        "walldist.save"
    ]}
]

Grid, solution, and post-processing files that are directly copied to the archive (without being added to a tar file) are set using the following code. This affects the ArchiveFiles setting. The bewildering file glob for q, x, and brkset files are trying to capture both x.restart and x.save with one glob.

# Flow files
CopyFiles = [
    "INTOUT",
    "XINTOUT",
    "q.avg",
    "q.srf",
    "x.srf",
    {"q.[sr0-9][ae0-9][vs0-9][et0-9]*": 1},
    {"x.[sr0-9][ae0-9][vs0-9][et0-9]*": 1},
    {"brkset.[sr0-9][ae0-9][vs0-9][et0-9]*": 1}
]

Further files to be deleted upon use of the --skeleton command are defined using the following code. This is the SkeletonFiles and TailFiles settings. Note that SkeletonFiles are defined in reverse order; the user specifies the files to keep, not delete.

# Skeleton
SkeletonFiles = [
    "case.json",
    "conditions.json",
    "archive.log",
    "run.[0-9]*.inp",
    "run.[0-9]*.[0-9]*",
    "lineload/grid.i.triq",
]
# Tail files
TailFiles = [
    {"run.resid": [1, "run.tail.resid"]},
]

The TailFiles settings causes pyOver to run the command

$ tail -n 1 run.resid > run.tail.resid
See also:
class cape.pyover.options.archiveopts.ArchiveOpts(*args, **kw)

Archiving options interface

Call:
>>> opts = ArchiveOpts(**kw)
Versions:

  • 2015-09-28 @ddalle: v1.0

  • 2016-03-01 @ddalle: v1.1; custom settings

  • 2022-10-21 @ddalle: v2.0; use cape.optdict

apply_ArchiveTemplate()

Apply OVERFLOW-specific archiving defaults

Call:
>>> opts.apply_ArchiveTemplate()
Inputs:
opts: ArchiveOpts

Options interface

Versions:

  • 2016-02-29 @ddalle: v1.0

init_post()

Initialization hook for OVERFLOW archiving options

Call:
>>> opts.init_post()
Inputs:
opts: ArchiveOpts

Archiving options interface

Versions:

  • 2022-10-21 @ddalle: v1.0

cape.pyover.options.archiveopts.auto_Archive(opts)

Automatically convert dict to pyover ArchiveOpts

Call:
>>> opts = auto_Archive(opts)
Inputs:
opts: dict

Dict of either global, “RunControl” or “Archive” options

Outputs:
opts: ArchiveOpts

Instance of archiving options

Versions:

  • 2016-02-29 @ddalle: v1.0

  • 2022-10-21 @ddalle: v2.0; generic call