Skip to content

Commit

Permalink
Adding more prominent grid editor docs (#1731)
Browse files Browse the repository at this point in the history
The grid editor is a powerful feature, and not easy
to discover or featured in the docs. This adds
an intriguing figure (from our fftf isothermal repo)
up front so people can see what they're missing
and go looking for the feature.

Along the way, I noticed that all png files were
ignored across the repo. Since we use png images
in our documentation, it's important that we do not
blanket ignore such files. I struggled for a while
to find out why my png wasn't showing up in the options
to stage! If we have build artifacts that are ending
up in commits then I suggest we clean those out
or be more precise with the ignoring.
  • Loading branch information
ntouran committed Jun 15, 2024
1 parent a7a868b commit 3b822bc
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 2 deletions.
2 changes: 0 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ bin/*
/bin
dist/
dist-*/
*.png
doc/_build
doc/user/tutorials
doc/tutorials/anl-afci-177*
Expand Down Expand Up @@ -59,7 +58,6 @@ venv*/
**/.coverage*
**/logs/*
*.ascii
*.png

# Misc. exclusions
*.html
Expand Down
5 changes: 5 additions & 0 deletions armi/utils/gridEditor.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,11 @@
$ python -m armi grids
If you have an existing set of input files, pass in the blueprints input file
as the first argument and the system will load up the associated grid, e.g.::
$ python -m armi grids FFTF-blueprints.yaml
**Known Issues**
Expand Down
Binary file added doc/.static/gridEditor.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: 9 additions & 0 deletions doc/user/inputs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1043,6 +1043,15 @@ Example grid definitions are shown below::
.. tip:: We have gone through some effort to allow both pin and core grid definitions to share this
input and it may improve in the future.

You may set up some kinds of grids (e.g. 1/3 and full core hex or Cartesian core
loadings) using our interactive graphical grid editor described more in
:py:mod:`armi.utils.gridEditor`.

.. figure:: /.static/gridEditor.png
:align: center

An example of the Grid Editor being used on a FFTF input file

.. _custom-isotopics:

Custom Isotopics
Expand Down

0 comments on commit 3b822bc

Please sign in to comment.