From f55b0bc0f5969000f714ca81a819cdbd098460d8 Mon Sep 17 00:00:00 2001 From: Zachary Prince Date: Tue, 9 Jan 2024 10:18:49 -0800 Subject: [PATCH] Fixing docs for PDF build (#1574) --- doc/developer/guide.rst | 4 ++-- doc/developer/profiling.rst | 2 +- doc/tutorials/walkthrough_lwr_inputs.rst | 2 +- doc/user/inputs.rst | 2 +- doc/user/physics_coupling.rst | 2 +- doc/user/radial_and_axial_expansion.rst | 12 ++++++------ 6 files changed, 12 insertions(+), 12 deletions(-) diff --git a/doc/developer/guide.rst b/doc/developer/guide.rst index 64bff5fe5..6fddb3248 100644 --- a/doc/developer/guide.rst +++ b/doc/developer/guide.rst @@ -33,7 +33,7 @@ of this hierarchy using the :py:mod:`armi.reactor.parameters` system to contain .. figure:: /.static/armi_reactor_objects.png :align: center - **Figure 1.** The primary data containers in ARMI + The primary data containers in ARMI Each level of the composite pattern hierarchy contains most of its state data in a collection of parameters detailing considerations of how the reactor has progressed @@ -206,7 +206,7 @@ interface stack is traversed in order. .. figure:: /.static/armi_general_flowchart.png :align: center - **Figure 1.** The computational flow of the interface hooks + The computational flow of the interface hooks For example, input checking routines would run at beginning-of-life (BOL), calculation modules might run at every time node, etc. To accommodate these various needs, interface diff --git a/doc/developer/profiling.rst b/doc/developer/profiling.rst index 02a00717c..f7074c627 100644 --- a/doc/developer/profiling.rst +++ b/doc/developer/profiling.rst @@ -19,4 +19,4 @@ This produces images like this: .. figure:: /.static/buildMacros.png :align: center - **Figure 1.** An example of the profiler output rendered to a png. + An example of the profiler output rendered to a png. diff --git a/doc/tutorials/walkthrough_lwr_inputs.rst b/doc/tutorials/walkthrough_lwr_inputs.rst index 84e405338..e4fa3def6 100644 --- a/doc/tutorials/walkthrough_lwr_inputs.rst +++ b/doc/tutorials/walkthrough_lwr_inputs.rst @@ -222,7 +222,7 @@ This should show a simple representation of the block. .. figure:: https://terrapower.github.io/armi/_static/c5g7-mox.png :figclass: align-center - **Figure 1.** A representation of a C5G7 fuel assembly. + A representation of a C5G7 fuel assembly. Here are the full files used in this example: diff --git a/doc/user/inputs.rst b/doc/user/inputs.rst index 02fa47375..e2ee8ceba 100644 --- a/doc/user/inputs.rst +++ b/doc/user/inputs.rst @@ -456,7 +456,7 @@ The ARMI data model is represented schematically below, and the blueprints are d .. figure:: /.static/armi_reactor_objects.png :align: center - **Figure 1.** The primary data containers in ARMI + The primary data containers in ARMI :ref:`blocks `: Defines :py:class:`~armi.reactor.components.component.Component` inputs for a diff --git a/doc/user/physics_coupling.rst b/doc/user/physics_coupling.rst index 2390cba62..f3b76ceaa 100644 --- a/doc/user/physics_coupling.rst +++ b/doc/user/physics_coupling.rst @@ -75,4 +75,4 @@ These assembly-wise convergence parameters are then stored in an array of conver The total convergence of the power distribution is finally measured through the infinity norm (i.e, the max) of :math:`\xi`, .. math:: - \epsilon = \| \xi \|_\inf = \max \xi. + \epsilon = \| \xi \|_{\inf} = \max \xi. diff --git a/doc/user/radial_and_axial_expansion.rst b/doc/user/radial_and_axial_expansion.rst index ca7f28cd7..ea43e858a 100644 --- a/doc/user/radial_and_axial_expansion.rst +++ b/doc/user/radial_and_axial_expansion.rst @@ -23,28 +23,28 @@ where, :math:`\Delta L` and :math:`\Delta T` are the change in length and temper Given Equation :eq:`linearExp`, we can create expressions for the change in length between our "hot" temperature (Equation :eq:`hotExp`) .. math:: - \begin{align} + \begin{aligned} \frac{L_h - L_0}{L_0} &= \alpha(T_h)\left(T_h - T_0\right),\\ \frac{L_h}{L_0} &= 1 + \alpha(T_h)\left(T_h - T_0\right). - \end{align} + \end{aligned} :label: hotExp and "non-reference" temperature, :math:`T_c` (Equation :eq:`nonRefExp`), .. math:: - \begin{align} + \begin{aligned} \frac{L_c - L_0}{L_0} &= \alpha(T_c)\left(T_c - T_0\right),\\ \frac{L_c}{L_0} &= 1 + \alpha(T_c)\left(T_c - T_0\right). - \end{align} + \end{aligned} :label: nonRefExp These are used within ARMI to enable thermal expansion and contraction with a temperature not equal to the reference temperature, :math:`T_0`. By taking the difference between Equation :eq:`hotExp` and :eq:`nonRefExp`, we can obtain an expression relating the change in length, :math:`L_h - L_c`, to the reference length, :math:`L_0`, .. math:: - \begin{align} + \begin{aligned} \frac{L_h - L_0}{L_0} - \frac{L_c - L_0}{L_0} &= \frac{L_h}{L_0} - 1 - \frac{L_c}{L_0} + 1, \\ &= \frac{L_h - L_c}{L_0}. - \end{align} + \end{aligned} :label: diffHotNonRef Using Equations :eq:`diffHotNonRef` and :eq:`nonRefExp`, we can obtain an expression for the change in length, :math:`L_h - L_c`, relative to the non-reference temperature,