diff --git a/armi/reactor/parameters/__init__.py b/armi/reactor/parameters/__init__.py index d03773a20..16bf2813b 100644 --- a/armi/reactor/parameters/__init__.py +++ b/armi/reactor/parameters/__init__.py @@ -71,6 +71,17 @@ >>> b.p.fuelTemp = numpy.array(range(217), dtype=float) >>> b.p.fuelTemp[58] = 600 +The parameter attributes can be access via the ``paramDefs`` property. Perhaps a user is +curious about the units of a block parameter: + + >>> defs = b.p.paramDefs + >>> defs["heightBOL"] + + + # Or, more simply: + >>> defs["heightBOL"].units + 'cm' + .. note:: There have been many discussions on what the specific name of this module/system diff --git a/armi/reactor/parameters/parameterCollections.py b/armi/reactor/parameters/parameterCollections.py index c9621e541..44cc06d30 100644 --- a/armi/reactor/parameters/parameterCollections.py +++ b/armi/reactor/parameters/parameterCollections.py @@ -431,7 +431,7 @@ def paramDefs(self) -> parameterDefinitions.ParameterDefinitionCollection: Get the :py:class:`ParameterDefinitionCollection` associated with this instance. This serves as both an alias for the pDefs class attribute, and as a read-only - accessor for them. Most non-paramter-system related interactions with an + accessor for them. Most non-parameter-system related interactions with an object's ``ParameterCollection`` should go through this. In the future, it probably makes sense to make the ``pDefs`` that the ``applyDefinitions`` and ``ResolveParametersMeta`` things are sensitive to more hidden from outside the diff --git a/doc/user/assembly_parameters_report.rst b/doc/user/assembly_parameters_report.rst index 964815fbe..e06ec2790 100644 --- a/doc/user/assembly_parameters_report.rst +++ b/doc/user/assembly_parameters_report.rst @@ -4,7 +4,8 @@ Assembly Parameters ******************* -This document lists all of the Assembly Parameters that are provided by the ARMI Framework. +This document lists all of the :py:mod:`Assembly Parameters ` that are provided by the +ARMI Framework. See :py:mod:`armi.reactor.parameters` for use. .. exec:: from armi.reactor import assemblies diff --git a/doc/user/block_parameters_report.rst b/doc/user/block_parameters_report.rst index 1c54b1aa9..96358612d 100644 --- a/doc/user/block_parameters_report.rst +++ b/doc/user/block_parameters_report.rst @@ -4,7 +4,8 @@ Block Parameters **************** -This document lists all of the Block Parameters that are provided by the ARMI Framework. +This document lists all of the :py:mod:`Block Parameters ` that are provided by the ARMI +Framework. See :py:mod:`armi.reactor.parameters` for use. .. exec:: from armi.reactor import blocks diff --git a/doc/user/component_parameters_report.rst b/doc/user/component_parameters_report.rst index 75d356680..3e28e765e 100644 --- a/doc/user/component_parameters_report.rst +++ b/doc/user/component_parameters_report.rst @@ -4,7 +4,8 @@ Component Parameters ******************** -This document lists all of the Component Parameters that are provided by the ARMI Framework. +This document lists all of the :py:mod:`Component Parameters ` that are +provided by the ARMI Framework. See :py:mod:`armi.reactor.parameters` for use. .. exec:: from armi.reactor.components import Component diff --git a/doc/user/core_parameters_report.rst b/doc/user/core_parameters_report.rst index dc0ad5c4b..ee5c60d35 100644 --- a/doc/user/core_parameters_report.rst +++ b/doc/user/core_parameters_report.rst @@ -4,7 +4,8 @@ Core Parameters *************** -This document lists all of the Core Parameters that are provided by the ARMI Framework. +This document lists all of the Core Parameters that are provided by the ARMI Framework. See +:py:mod:`armi.reactor.parameters` for use. .. exec:: from armi.reactor import reactors diff --git a/doc/user/manual_data_access.rst b/doc/user/manual_data_access.rst index 05971ff5b..34d1912c8 100644 --- a/doc/user/manual_data_access.rst +++ b/doc/user/manual_data_access.rst @@ -25,7 +25,8 @@ Accessing Some Interesting Info Often times, you may be interested in the geometric dimensions of various blocks. These are stored on the :py:mod:`components `, and may be accessed as follows:: - b = o.r.core.getFirstBlock(Flags.FUEL) + b = r.core.getFirstBlock(Flags.FUEL) + # Depending on how the reactor was loaded, this may need to be ``o.r``. fuel = b.getComponent(Flags.FUEL) od = fuel.getDimension('od',cold=True) # fuel outer diameter in cm odHot = fuel.getDimension('od') # hot dimension diff --git a/doc/user/reactor_parameters_report.rst b/doc/user/reactor_parameters_report.rst index fe2dd2dea..e8c7550f7 100644 --- a/doc/user/reactor_parameters_report.rst +++ b/doc/user/reactor_parameters_report.rst @@ -4,7 +4,8 @@ Reactor Parameters ****************** -This document lists all of the Reactor Parameters that are provided by the ARMI Framework. +This document lists all of the :py:mod:`Reactor Parameters ` that are provided by the +ARMI Framework. See :py:mod:`armi.reactor.parameters` for use. .. exec:: from armi.reactor import reactors