Reset Command

Usage

xfds reset --help

Usage: xfds reset [OPTIONS] [DIRECTORY] COMMAND [ARGS]...

  Reset a folder by clearing everything except specified files.

Arguments:
  [DIRECTORY]  Directory containing model files.  [default: .]

Options:
  --help  Show this message and exit.

  Developed by pbd.tools

Description

The reset command will reset the fire model direcory so that it only contains the desired files, generally the input files. A few examples where this may be useful are as follows:

• Reset the directory so only the input files remain. This way, when a model is run again, there is a high level of confidence that every file in the directory correlates to the given model.
• Remove bulky output files. Depending on the analysis, it may not be necessary to keep the large binary files. After backing up the models to a server, disk space can be saved by deleting the files necessary for Smokeview.
• When processing models, there might be extra files generated, such as exporting images from Smokeview. A pattern could be used to ensure all the model outputs remain, but the extra files are removed.

xFDS uses the glob syntax to denote which files to keep. See the config file for more information.

xfds:
  render:
    - name: model_{{ "%.2f"|format(res) }}
      files:
        - model.fds
        - model.pbs
      variables:
        fds: 6.7.7
        n: 1
      parameters:
        res: [0.10, 0.15]
  reset:
    keep:
      - "*.fds"
      - "*.pbs"