armi.cli.modify module

Search through a directory tree and modify ARMI settings in existing input file(s). All valid settings may be used as keyword arguments.

class armi.cli.modify.ModifyCaseSettingsCommand

Bases: EntryPoint

Search through a directory tree and modify ARMI settings in existing input file(s). All valid settings may be used as keyword arguments.

Run the entry point like this:

$ python -m armi modify --nTasks=3 *.yaml

name: Optional[str] = 'modify'

The <command-name> that is used to call the command from the command line

addOptions()

invoke()

settingsArgument: Optional[str] = None

One of {‘optional’, ‘required’, None}, or unspecified. Specifies whether a settings file argument is to be added to the command’s argument parser. If settingsArgument == ‘required’, then a settings file is a required positional argument. If settingsArgument == ‘optional’, then it is an optional positional argument. Finally, if settingsArgument is None, then no settings file argument is added.