armi.settings.settingsRules module

This module contains rules supporting custom actions taken on the reading of setting inputs

Note

The settingsRules system was developed before the pluginification of ARMI, and doesn’t play very nicely with the post-plugin world. This is mainly because registration of new rules happens at import time of the rule itself, which is unreliable and difficult to control, and even sort of implicit and sneaky. They are also somewhat redundant with the armi.operators.settingsValidation.Query/armi.operators.settingsValidation.Inspector system and the scripts.migration package.. It is not recommended for plugins to define settings rules using the mechanism in this module, which may be removed in the future.

armi.settings.settingsRules.include_as_rule(*args)[source]
armi.settings.settingsRules.nullRule(cs, name, value)[source]
armi.settings.settingsRules.applyVerbosity(cs, name, value)[source]
armi.settings.settingsRules.oldFourPass(cs, name, value)[source]
armi.settings.settingsRules.squashNoneFP(cs, name, value)[source]
armi.settings.settingsRules.assemblyRotationAlgorithmStringNone(cs, name, value)[source]
armi.settings.settingsRules.sensitivityCoefficientsCommonCapitalizationMistake(cs, name, value)[source]
armi.settings.settingsRules.twrcOptionConversion(cs, name, value)[source]
armi.settings.settingsRules.PumpInertiaPercentChange(cs, name, value)[source]