diff --git a/armi/cases/suite.py b/armi/cases/suite.py index e17ed99b2..1a25f82a2 100644 --- a/armi/cases/suite.py +++ b/armi/cases/suite.py @@ -50,7 +50,6 @@ class CaseSuite: A CaseSuite is a collection that is keyed off Case titles. - .. impl:: Dependence allows for one case to start after the completion of another :id: I_ARMI_CASE_SUITE :implements: R_ARMI_CASE_SUITE diff --git a/armi/nuclearDataIO/cccc/dif3d.py b/armi/nuclearDataIO/cccc/dif3d.py index ea96fca81..81848e28a 100644 --- a/armi/nuclearDataIO/cccc/dif3d.py +++ b/armi/nuclearDataIO/cccc/dif3d.py @@ -93,12 +93,7 @@ def __init__(self): class Dif3dStream(cccc.StreamWithDataContainer): - """Tool to read and write DIF3D files. - - .. impl:: Tool to read and write DIF3D files. - :id: I_ARMI_NUCDATA_DIF3D - :implements: R_ARMI_NUCDATA_DIF3D - """ + """Tool to read and write DIF3D files.""" @staticmethod def _getDataContainer() -> Dif3dData: diff --git a/armi/nuclearDataIO/cccc/dlayxs.py b/armi/nuclearDataIO/cccc/dlayxs.py index 9fa9be7c0..51736b851 100644 --- a/armi/nuclearDataIO/cccc/dlayxs.py +++ b/armi/nuclearDataIO/cccc/dlayxs.py @@ -126,10 +126,6 @@ class Dlayxs(collections.OrderedDict): If you want an average over all nuclides, then you need to produce it using the properly-computed average contributions of each nuclide. - .. impl:: Tool to read and write DLAYXS files. - :id: I_ARMI_NUCDATA_DLAYXS - :implements: R_ARMI_NUCDATA_DLAYXS - Attributes ---------- nuclideFamily : dict diff --git a/armi/nuclearDataIO/cccc/gamiso.py b/armi/nuclearDataIO/cccc/gamiso.py index 013ad5215..b53eb0827 100644 --- a/armi/nuclearDataIO/cccc/gamiso.py +++ b/armi/nuclearDataIO/cccc/gamiso.py @@ -22,9 +22,9 @@ :id: I_ARMI_NUCDATA_GAMISO :implements: R_ARMI_NUCDATA_GAMISO -See [GAMSOR]_. +See [GAMSOR]_. -.. [GAMSOR] Smith, M. A., Lee, C. H., and Hill, R. N. GAMSOR: Gamma Source Preparation and DIF3D Flux Solution. United States: +.. [GAMSOR] Smith, M. A., Lee, C. H., and Hill, R. N. GAMSOR: Gamma Source Preparation and DIF3D Flux Solution. United States: N. p., 2016. Web. doi:10.2172/1343095. `On OSTI `_ """ @@ -118,10 +118,6 @@ class _GamisoIO(isotxs.IsotxsIO): """ A reader/writer for GAMISO data files. - .. impl:: Tool to read and write GAMISO files. - :id: I_ARMI_NUCDATA_GAMISO - :implements: R_ARMI_NUCDATA_GAMISO - Notes ----- The GAMISO file format is identical to ISOTXS. diff --git a/armi/nuclearDataIO/cccc/geodst.py b/armi/nuclearDataIO/cccc/geodst.py index eb7774f12..ee777bcad 100644 --- a/armi/nuclearDataIO/cccc/geodst.py +++ b/armi/nuclearDataIO/cccc/geodst.py @@ -111,10 +111,6 @@ class GeodstStream(cccc.StreamWithDataContainer): """ Stream for reading to/writing from with GEODST data. - .. impl:: Tool to read and write GEODST files. - :id: I_ARMI_NUCDATA_GEODST - :implements: R_ARMI_NUCDATA_GEODST - Parameters ---------- geom : GeodstData diff --git a/armi/nuclearDataIO/cccc/isotxs.py b/armi/nuclearDataIO/cccc/isotxs.py index 50fedf060..3b3f42ee4 100644 --- a/armi/nuclearDataIO/cccc/isotxs.py +++ b/armi/nuclearDataIO/cccc/isotxs.py @@ -18,7 +18,7 @@ ISOTXS is a binary file that contains multigroup microscopic cross sections. ISOTXS stands for *Isotope Cross Sections*. -ISOTXS files are often created by a lattice physics code such as MC2 or DRAGON and +ISOTXS files are often created by a lattice physics code such as MC2 or DRAGON and used as input to a global flux solver such as DIF3D. This module implements reading and writing of the @@ -191,10 +191,6 @@ class IsotxsIO(cccc.Stream): """ A semi-abstract stream for reading and writing to a :py:class:`~armi.nuclearDataIO.isotxs.Isotxs`. - .. impl:: Tool to read and write ISOTXS files. - :id: I_ARMI_NUCDATA_ISOTXS - :implements: R_ARMI_NUCDATA_ISOTXS - Notes ----- This is a bit of a special case compared to most other CCCC files because of the special diff --git a/armi/nuclearDataIO/cccc/pmatrx.py b/armi/nuclearDataIO/cccc/pmatrx.py index 732648d76..83836ba98 100644 --- a/armi/nuclearDataIO/cccc/pmatrx.py +++ b/armi/nuclearDataIO/cccc/pmatrx.py @@ -168,13 +168,6 @@ def _readWrite(lib, fileName, fileMode, getNuclideFunc): class PmatrxIO(cccc.Stream): - """Tool to read and write PMATRX files. - - .. impl:: Tool to read and write PMATRX files. - :id: I_ARMI_NUCDATA_PMATRX - :implements: R_ARMI_NUCDATA_PMATRX - """ - def __init__(self, fileName, xsLib, fileMode, getNuclideFunc): cccc.Stream.__init__(self, fileName, fileMode) self._lib = xsLib diff --git a/armi/nuclearDataIO/cccc/tests/test_gamiso.py b/armi/nuclearDataIO/cccc/tests/test_gamiso.py index 1b4c71afd..6fd45bfa3 100644 --- a/armi/nuclearDataIO/cccc/tests/test_gamiso.py +++ b/armi/nuclearDataIO/cccc/tests/test_gamiso.py @@ -34,12 +34,6 @@ def setUp(self): def test_compare(self): """Compare the input binary GAMISO file. - .. test:: Test reading GAMISO files. - :id: T_ARMI_NUCDATA_GAMISO - :tests: R_ARMI_NUCDATA_GAMISO - """ - """Compare the input binary GAMISO file. - .. test:: Test reading GAMISO files. :id: T_ARMI_NUCDATA_GAMISO0 :tests: R_ARMI_NUCDATA_GAMISO diff --git a/armi/operators/operator.py b/armi/operators/operator.py index f5f99012b..5e2adb6b4 100644 --- a/armi/operators/operator.py +++ b/armi/operators/operator.py @@ -77,7 +77,7 @@ class Operator: :id: I_ARMI_OPERATOR_COMM :implements: R_ARMI_OPERATOR_COMM - .. impl:: An operator is build from user settings. + .. impl:: An operator is built from user settings. :id: I_ARMI_OPERATOR_SETTINGS :implements: R_ARMI_OPERATOR_SETTINGS @@ -402,7 +402,7 @@ def _timeNodeLoop(self, cycle, timeNode): def _performTightCoupling(self, cycle: int, timeNode: int, writeDB: bool = True): """If requested, perform tight coupling and write out database. - .. impl:: The operator shall allow coupling between physics systems. + .. impl:: The operator shall allow tight coupling between physics systems. :id: I_ARMI_OPERATOR_PHYSICS :implements: R_ARMI_OPERATOR_PHYSICS diff --git a/armi/physics/neutronics/globalFlux/tests/test_globalFluxInterface.py b/armi/physics/neutronics/globalFlux/tests/test_globalFluxInterface.py index 9accd8944..1c910766a 100644 --- a/armi/physics/neutronics/globalFlux/tests/test_globalFluxInterface.py +++ b/armi/physics/neutronics/globalFlux/tests/test_globalFluxInterface.py @@ -370,6 +370,7 @@ def test_calcReactionRates(self): .. test:: Return the reaction rates for a given ArmiObject :id: T_ARMI_FLUX_RX_RATES :tests: R_ARMI_FLUX_RX_RATES + .. warning: This does not validate the reaction rate calculation. """ b = test_blocks.loadTestBlock() diff --git a/armi/plugins.py b/armi/plugins.py index 6d99168f5..f8ed8bb69 100644 --- a/armi/plugins.py +++ b/armi/plugins.py @@ -141,11 +141,7 @@ class ArmiPlugin: An ArmiPlugin provides a namespace to collect hook implementations provided by a single "plugin". This API is incomplete, unstable, and expected to change. - .. impl:: Plugins have interfaces, to add code to the application. - :id: I_ARMI_PLUGIN - :implements: R_ARMI_PLUGIN - - .. impl:: Plugins have interfaces, to add code to the application. + .. impl:: Plugins have interfaces to add code to the application. :id: I_ARMI_PLUGIN :implements: R_ARMI_PLUGIN """ @@ -156,14 +152,6 @@ def exposeInterfaces(cs) -> List: """ Function for exposing interface(s) to other code. - .. impl:: Plugins have interfaces to the operator. - :id: I_ARMI_PLUGIN_INTERFACES - :implements: R_ARMI_PLUGIN_INTERFACES - - .. impl:: Define an arbitrary physical parameter. - :id: I_ARMI_PARAM - :implements: R_ARMI_PARAM - .. impl:: Plugins have interfaces to the operator. :id: I_ARMI_PLUGIN_INTERFACES :implements: R_ARMI_PLUGIN_INTERFACES diff --git a/armi/reactor/components/component.py b/armi/reactor/components/component.py index 82defccd4..f2a2f531a 100644 --- a/armi/reactor/components/component.py +++ b/armi/reactor/components/component.py @@ -1177,7 +1177,7 @@ def getIntegratedMgFlux(self, adjoint=False, gamma=False): def density(self): """Returns the mass density of the object in g/cc. - .. impl:: Material densitiy is retrievable + .. impl:: Material density is retrievable :id: I_ARMI_COMP_MAT1 :implements: R_ARMI_COMP_MAT """ diff --git a/armi/reactor/parameters/parameterDefinitions.py b/armi/reactor/parameters/parameterDefinitions.py index 232bcf002..f3305d41c 100644 --- a/armi/reactor/parameters/parameterDefinitions.py +++ b/armi/reactor/parameters/parameterDefinitions.py @@ -340,7 +340,7 @@ def __get__(self, obj, cls=None): def setter(self, setter): """Decorator method for assigning setter. - .. impl:: Provide a way to signal if a parameter needs updated across processes. + .. impl:: Provide a way to signal if a parameter needs updating across processes. :id: I_ARMI_PARAM_PARALLEL :implements: R_ARMI_PARAM_PARALLEL diff --git a/armi/reactor/tests/test_components.py b/armi/reactor/tests/test_components.py index fe19c2c4c..2c7f3a3ef 100644 --- a/armi/reactor/tests/test_components.py +++ b/armi/reactor/tests/test_components.py @@ -347,7 +347,7 @@ def test_volumeAfterClearCache(self): """ Test volume after cache has been cleared. - .. test:: Clear cache after a dimenions updated + .. test:: Clear cache after a dimensions updated :id: T_ARMI_COMP_VOL1 :tests: R_ARMI_COMP_VOL """