armi.settings.caseSettings module¶

This defines a Settings object that acts mostly like a dictionary. It is meant to be treated mostly like a singleton, where each custom ARMI object has access to it. It contains global user settings like the core power level, the input file names, the number of cycles to run, the run type, the environment setup, and hundreds of other things.

A settings object can be saved as or loaded from an XML file. The ARMI GUI is designed to create this settings file, which is then loaded by an ARMI process on the cluster.

A master case settings is created as masterCs

class armi.settings.caseSettings.Settings(fName=None)[source]¶

Bases: object

A container for global settings, such as case title, power level, and many run options.

It is accessible to most ARMI objects through self.cs (for ‘Case Settings’). It acts largely as a dictionary, and setting values are accessed by keys.

The settings object has a 1-to-1 correspondence with the ARMI settings input file. This file may be created by hand or by the GUI in submitter.py.

Instantiate a settings object

Parameters: fName (str, optional) – Path to a valid yaml settings file that will be loaded

instance = None¶

defaultCaseTitle = 'armi'¶

property inputDirectory¶

property caseTitle¶

property environmentSettings¶

__setstate__(state)[source]¶

Rebuild schema upon unpickling since schema is unpickleable.

Pickling happens during mpi broadcasts and also during testing where the test reactor is cached.