Skip to content

Commit

Permalink
Updates to fix latex build of docs. (#539)
Browse files Browse the repository at this point in the history
The LaTeX builder did not work with SVGs so I converted them to pngs. I
also fixed some incorrect LaTeX math and dealt with a few stray
backslashes that were failing the build.

With these changes, the Sphinx LaTeX builder works properly and xelatex
builds a full pdf appropriately.

It's not a perfect PDF in that the introductory sections are added as
top level chapters to the end of the document, but other than that it is
pretty good.
  • Loading branch information
ntouran committed Jan 18, 2022
1 parent e7aa498 commit db26b9c
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 11 deletions.
7 changes: 6 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
|Build Status| |Code Coverage|

.. The LaTeX builder doesn't support SVGs, and these badges are SVGs
.. only:: html

|Build Status| |Code Coverage|

The Advanced Reactor Modeling Interface (ARMI\ :sup:`®`) is an open-source tool that
streamlines your nuclear reactor design/analysis needs by providing a
Expand Down
5 changes: 2 additions & 3 deletions armi/reactor/blocks.py
Original file line number Diff line number Diff line change
Expand Up @@ -1297,9 +1297,8 @@ def getMfp(self, gamma=False):
.. math::
<\Sigma> = \frac{\sum_E(\phi_e*\Sigma_e*dE)}{\sum_E (\phi_e*dE)} =
\sum_E(\phi_e*N*\sum_{\text{type}}(\sigma_e) dE}{\sum_E (\phi_e*dE))}
<\Sigma> = \frac{\sum_E(\phi_e \Sigma_e dE)}{\sum_E (\phi_e dE)} =
\frac{\sum_E(\phi_e N \sum_{\text{type}}(\sigma_e) dE}{\sum_E (\phi_e dE))}
Block macro is the sum of macros of all nuclides.
Expand Down
4 changes: 2 additions & 2 deletions armi/reactor/grids.py
Original file line number Diff line number Diff line change
Expand Up @@ -1132,14 +1132,14 @@ class CartesianGrid(Grid):
These concepts are illustrated in the example drawings below.
.. figure:: ../.static/through-center.svg
.. figure:: ../.static/through-center.png
:width: 400px
:align: center
Grid example where the axes pass through the "center assembly" (odd-by-odd).
Note that ring 1 only has one location in it.
.. figure:: ../.static/not-through-center.svg
.. figure:: ../.static/not-through-center.png
:width: 400px
:align: center
Expand Down
Binary file added doc/.static/not-through-center.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/.static/through-center.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 4 additions & 5 deletions doc/user/accessingEntryPoints.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,13 @@ Reports Entry Point
There are two ways to access the reports entry point in ARMI.

The first way is through a yaml settings file.
Here, the call is as follows
Here, the call is as follows::

``(venv) C:\Users\username\codes> tparmi report anl-afci-177.yaml``
(venv) C:\Users\username\codes> tparmi report anl-afci-177.yaml

It is also possible to call this on an h5 file,
It is also possible to call this on an h5 file::


``(venv) C:\Users\username\codes> tparmi report -h5db refTestBase.h5``
(venv) C:\Users\username\codes> tparmi report -h5db refTestBase.h5

.. note:: When working with a h5 file, -h5db must be included

Expand Down

0 comments on commit db26b9c

Please sign in to comment.