Merge 1e6027a into c374838

armi/apps.py

@@ -19,13 +19,14 @@
 Framework for a specific application. An ``App`` implements a simple interface for
 customizing much of the Framework's behavior.
 
-.. admonition:: Historical Fun Fact
-
-    This pattern is used by many frameworks as a way of encapsulating what would
-    otherwise be global state. The ARMI Framework has historically made heavy use of
-    global state (e.g., :py:mod:`armi.nucDirectory.nuclideBases`), and it will take
-    quite a bit of effort to refactor the code to access such things through an App
-    object.
+Notes
+-----
+Historical Fun Fact
+
+This pattern is used by many frameworks as a way of encapsulating what would otherwise be global
+state. The ARMI Framework has historically made heavy use of global state (e.g.,
+:py:mod:`armi.nucDirectory.nuclideBases`), and it will take quite a bit of effort to refactor the
+code to access such things through an App object.
 """
 # ruff: noqa: E402
 from typing import Dict, Optional, Tuple, List

armi/interfaces.py

@@ -21,9 +21,7 @@
 See Also
 --------
 armi.operators : Schedule calls to various interfaces
-
 armi.plugins : Register various interfaces
-
 """
 import copy
 from typing import Union
@@ -362,7 +360,7 @@ def preDistributeState(self):
 
         Examples
         --------
-        return {'neutronsPerFission',self.neutronsPerFission}
+        >>> return {'neutronsPerFission',self.neutronsPerFission}
         """
         return {}
 

armi/nuclearDataIO/cccc/compxs.py

@@ -46,7 +46,6 @@
 
 Examples
 --------
-::
     >>> from armi.nuclearDataIO import compxs
     >>> lib = compxs.readBinary('COMPXS')
     >>> r0 = lib.regions[0]

armi/nuclearDataIO/cccc/nhflux.py

@@ -413,7 +413,7 @@ def _rwGeodstCoordMap2D(self):
 
         Examples
         --------
-        geodstCoordMap[NodalIndex] = geodstIndex
+            geodstCoordMap[NodalIndex] = geodstIndex
 
         See Also
         --------

armi/nuclearDataIO/xsCollections.py

@@ -27,14 +27,14 @@
 
 Examples
 --------
-# creating a MicroscopicXSCollection by loading one from ISOTXS.
-microLib = armi.nuclearDataIO.ISOTXS('ISOTXS')
-micros = myLib.nuclides['U235AA'].micros
-
-# creating macroscopic XS:
-mc = MacroscopicCrossSectionCreator()
-macroCollection = mc.createMacrosFromMicros(microLib, block)
-blocksWithMacros = mc.createMacrosOnBlocklist(microLib, blocks)
+    # creating a MicroscopicXSCollection by loading one from ISOTXS.
+    microLib = armi.nuclearDataIO.ISOTXS('ISOTXS')
+    micros = myLib.nuclides['U235AA'].micros
+
+    # creating macroscopic XS:
+    mc = MacroscopicCrossSectionCreator()
+    macroCollection = mc.createMacrosFromMicros(microLib, block)
+    blocksWithMacros = mc.createMacrosOnBlocklist(microLib, blocks)
 
 """
 import numpy

armi/nuclearDataIO/xsNuclides.py

@@ -14,11 +14,11 @@
 
 r"""
 This module contains cross section nuclides, which are a wrapper around the
-:py:class:`~armi.nucDirectory.nuclideBases.INuclide` objects. The cross section nuclide objects contain
-cross section information from a specific calculation (e.g. neutron, or gamma cross sections).
+:py:class:`~armi.nucDirectory.nuclideBases.INuclide` objects. The cross section nuclide objects
+contain cross section information from a specific calculation (e.g. neutron, or gamma cross sections).
 
-:py:class:`XSNuclide` objects also contain meta data from the original file, so that another file can be
-reconstructed.
+:py:class:`XSNuclide` objects also contain meta data from the original file, so that another file
+can be reconstructed.
 
 .. warning::
     :py:class:`XSNuclide` objects should only be created by reading data into

armi/physics/neutronics/crossSectionSettings.py

@@ -87,8 +87,8 @@ def getStr(cls, typeSpec: Enum):
 
         Examples
         --------
-        XSGeometryTypes.getStr(XSGeometryTypes.ZERO_DIMENSIONAL) == "0D"
-        XSGeometryTypes.getStr(XSGeometryTypes.TWO_DIMENSIONAL_HEX) == "2D hex"
+            XSGeometryTypes.getStr(XSGeometryTypes.ZERO_DIMENSIONAL) == "0D"
+            XSGeometryTypes.getStr(XSGeometryTypes.TWO_DIMENSIONAL_HEX) == "2D hex"
         """
         geometryTypes = list(cls)
         if typeSpec not in geometryTypes:

armi/reactor/assemblies.py

@@ -864,8 +864,8 @@ def getBlocksAndZ(self, typeSpec=None, returnBottomZ=False, returnTopZ=False):
 
         Examples
         --------
-        for block, bottomZ in a.getBlocksAndZ(returnBottomZ=True):
-            print({0}'s bottom mesh point is {1}'.format(block, bottomZ))
+            for block, bottomZ in a.getBlocksAndZ(returnBottomZ=True):
+                print({0}'s bottom mesh point is {1}'.format(block, bottomZ))
         """
         if returnBottomZ and returnTopZ:
             raise ValueError("Both returnTopZ and returnBottomZ are set to `True`")
@@ -982,9 +982,9 @@ def getBlocksBetweenElevations(self, zLower, zUpper):
         Examples
         --------
         If the block structure looks like:
-         50.0 to 100.0 Block3
-         25.0 to 50.0  Block2
-         0.0 to 25.0   Block1
+        50.0 to 100.0 Block3
+        25.0 to 50.0  Block2
+        0.0 to 25.0   Block1
 
         Then,
 

armi/reactor/blocks.py

@@ -2049,7 +2049,7 @@ def rotatePins(self, rotNum, justCompute=False):
 
         Examples
         --------
-        rotateIndexLookup[i_after_rotation-1] = i_before_rotation-1
+            rotateIndexLookup[i_after_rotation-1] = i_before_rotation-1
         """
         if not 0 <= rotNum <= 5:
             raise ValueError(

armi/reactor/converters/geometryConverters.py

@@ -1399,8 +1399,8 @@ class EdgeAssemblyChanger(GeometryChanger):
 
     Examples
     --------
-    edgeChanger = EdgeAssemblyChanger()
-    edgeChanger.removeEdgeAssemblies(reactor.core)
+        edgeChanger = EdgeAssemblyChanger()
+        edgeChanger.removeEdgeAssemblies(reactor.core)
     """
 
     def addEdgeAssemblies(self, core):

armi/reactor/converters/uniformMesh.py

@@ -41,11 +41,11 @@
 
 Examples
 --------
-converter = uniformMesh.NeutronicsUniformMeshConverter()
-converter.convert(reactor)
-uniformReactor = converter.convReactor
-# do calcs, then:
-converter.applyStateToOriginal()
+    converter = uniformMesh.NeutronicsUniformMeshConverter()
+    converter.convert(reactor)
+    uniformReactor = converter.convReactor
+    # do calcs, then:
+    converter.applyStateToOriginal()
 
 The mesh mapping happens as described in the figure:
 

armi/reactor/reactors.py

@@ -2585,10 +2585,10 @@ def buildManualZones(self, cs):
         --------
         Manual zones will be defined in a special string format, e.g.:
 
-        zoneDefinitions:
-            - ring-1: 001-001
-            - ring-2: 002-001, 002-002
-            - ring-3: 003-001, 003-002, 003-003
+        >>> zoneDefinitions:
+        >>>     - ring-1: 001-001
+        >>>     - ring-2: 002-001, 002-002
+        >>>     - ring-3: 003-001, 003-002, 003-003
 
         Notes
         -----

armi/reactor/zones.py

@@ -446,10 +446,10 @@ def summary(self) -> None:
 
         Examples
         --------
-        zoneDefinitions:
-        - ring-1: 001-001
-        - ring-2: 002-001, 002-002
-        - ring-3: 003-001, 003-002, 003-003
+            zoneDefinitions:
+            - ring-1: 001-001
+            - ring-2: 002-001, 002-002
+            - ring-3: 003-001, 003-002, 003-003
         """
         # log a quick header
         runLog.info("zoneDefinitions:")

armi/settings/fwSettings/tightCouplingSettings.py

@@ -49,7 +49,7 @@ class TightCouplingSettings(dict):
 
     Examples
     --------
-    couplingSettings = TightCouplingSettings({'globalFlux': {'parameter': 'keff', 'convergence': 1e-05}})
+        couplingSettings = TightCouplingSettings({'globalFlux': {'parameter': 'keff', 'convergence': 1e-05}})
     """
 
     def __repr__(self):

armi/utils/mathematics.py

@@ -84,7 +84,7 @@ def convertToSlice(x, increment=False):
 
     Examples
     --------
-    a = np.array([10, 11, 12, 13])
+    >>> a = np.array([10, 11, 12, 13])
 
     >>> convertToSlice(2)
     slice(2, 3, None)