Skip to content

Commit

Permalink
Small doc update.
Browse files Browse the repository at this point in the history
  • Loading branch information
ntouran committed Apr 10, 2020
1 parent 9884b9a commit 405b18e
Show file tree
Hide file tree
Showing 3 changed files with 63 additions and 1 deletion.
Binary file added doc/.static/c5g7-mox.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 15 additions & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,27 @@ improving analysis quality.
* :ref:`search`


.. list-table:: Quick links
:widths: 30 70

* - Source code
- https://github.com/terrapower/armi
* - Documentation
- https://terrapower.github.io/armi
* - Bug tracker
- https://github.com/terrapower/armi/issues
* - Plugin directory
- https://github.com/terrapower/armi-plugin-directory
* - Contact
- armi-devs@terrapower.com

TerraPower and ARMI are registered trademarks of TerraPower, LLC.
Other trademarks and registered trademarks used in this Manual are the property of the
respective trademark holders.

The ARMI system is governed by the following license::

Copyright 2009-2019 TerraPower, LLC
Copyright 2009-2020 TerraPower, LLC
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
48 changes: 48 additions & 0 deletions doc/user/tutorials/walkthrough_lwr_inputs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,54 @@ this benchmark problem entirely.
There! You have now created all the ARMI inputs, from scratch, needed to
represent the C5G7 benchmark problem.

Ok, so now what?
================
You can run the default ARMI app on these inputs, which will run a
few cycles and make an output database::

$ python -m armi run c5g7-settings.yaml

But since the baseline
app doesn't do any real calculations, it won't have a lot in it.
You have to add plugins to do calculations (see the
`plugin directory <https://github.com/terrapower/armi-plugin-directory>`_).

Of course, you can fiddle around with the reactor in memory. For example, in an
ipython session, you can plot one of the assembly's pin locations.

.. code-block:: python
import matplotlib.pyplot as plt
import armi
from armi.reactor.flags import Flags
armi.configure()
o = armi.init(fName = "c5g7-settings.yaml")
b = o.r.core.getFirstBlock(Flags.MOX)
flags = [Flags.LOW, Flags.MEDIUM, Flags.HIGH]
colors = ["green", "yellow", "red"]
for f, c in zip(flags, colors):
x, y=[], []
pin = b.getComponent(Flags.FUEL| f)
for loc in pin.spatialLocator:
xi, yi, zi = loc.getGlobalCoordinates()
x.append(xi)
y.append(yi)
plt.scatter(x, y, color=c)
plt.show()
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.


Here are the full files used in this example:

* :download:`Blueprints <../../../armi/tests/tutorials/c5g7-blueprints.yaml>`
Expand Down

0 comments on commit 405b18e

Please sign in to comment.