Adding descriptions to fuel cycle settings (#1761)

terrapower · Jul 3, 2024 · 491406a · 491406a
1 parent e3782c7
commit 491406a
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 5 deletions.
diff --git a/armi/physics/fuelCycle/settings.py b/armi/physics/fuelCycle/settings.py
@@ -101,13 +101,19 @@ def getFuelCycleSettings():
             label="Plot shuffle arrows",
         ),
         setting.Setting(
-            CONF_JUMP_RING_NUM, default=8, label="Jump Ring Number", description="None"
+            CONF_JUMP_RING_NUM,
+            default=8,
+            label="Jump Ring Number",
+            description="The number of hex rings jumped when distributing the feed assemblies in "
+            "the alternating concentric rings or checkerboard shuffle patterns (convergent / "
+            "divergent shuffling).",
         ),
         setting.Setting(
             CONF_LEVELS_PER_CASCADE,
             default=14,
             label="Move per cascade",
-            description="None",
+            description="The number of moves made per cascade when performing convergent or "
+            "divergent shuffle patterns.",
         ),
     ]
     return settings

diff --git a/armi/settings/fwSettings/globalSettings.py b/armi/settings/fwSettings/globalSettings.py
@@ -423,7 +423,8 @@ def defineSettings() -> List[setting.Setting]:
             CONF_BURNUP_PEAKING_FACTOR,
             default=0.0,
             label="Burn-up Peaking Factor",
-            description="None",
+            description="The peak/avg factor for burnup and DPA. If it is not set the current flux "
+            "peaking is used (this is typically conservatively high).",
             schema=vol.All(vol.Coerce(float), vol.Range(min=0)),
         ),
         setting.Setting(
@@ -529,7 +530,8 @@ def defineSettings() -> List[setting.Setting]:
             CONF_FRESH_FEED_TYPE,
             default="feed fuel",
             label="Fresh Feed Type",
-            description="None",
+            description="The type of fresh fuel added to the core, used in certain pre-defined "
+            "fuel shuffling logic sequences.",
             options=["feed fuel", "igniter fuel", "inner driver fuel"],
         ),
         setting.Setting(
@@ -668,7 +670,10 @@ def defineSettings() -> List[setting.Setting]:
             schema=vol.All(vol.Coerce(float), vol.Range(min=0)),
         ),
         setting.Setting(
-            CONF_REMOVE_PER_CYCLE, default=3, label="Move per Cycle", description="None"
+            CONF_REMOVE_PER_CYCLE,
+            default=3,
+            label="Remove per Cycle",
+            description="The number of fuel assemblies removed per cycle at equilibrium.",
         ),
         setting.Setting(
             CONF_RUN_TYPE,