crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-29 06:35:48 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Fix broken links, remove section talking about MATLAB

Browse source
This commit is contained in:
Paul Romano 2022-03-04 10:34:37 -06:00
parent 8418eaeedb
commit 338abf2fab
8 changed files with 29 additions and 37 deletions
Download patch file Download diff file Expand all files Collapse all files

27
docs/source/usersguide/processing.rst
View file

@ -34,30 +34,20 @@ as requested; it is used in many of the provided plotting utilities, OpenMC's
regression test suite, and can be used in user-created scripts to carry out
manipulations of the data.
An `example notebook <../examples/post-processing.ipynb>`_ demonstrates how to
extract data from a statepoint using the Python API.
An `example notebook`_ demonstrates how to extract data from a statepoint using
the Python API.
Plotting in 2D
--------------
The `notebook example <../examples/post-processing.ipynb>`_ also demonstrates
how to plot a structured mesh tally in two dimensions using the Python API. One
can also use the :ref:`scripts_plot` script which provides an interactive GUI to
explore and plot structured mesh tallies for any scores and filter bins.
The `example notebook`_ also demonstrates how to plot a structured mesh tally in
two dimensions using the Python API. One can also use the :ref:`scripts_plot`
script which provides an interactive GUI to explore and plot structured mesh
tallies for any scores and filter bins.
.. image:: ../_images/plotmeshtally.png
:width: 400px
Getting Data into MATLAB
------------------------
There is currently no front-end utility to dump tally data to MATLAB files, but
the process is straightforward. First extract the data using the Python API via
``openmc.statepoint`` and then use the `Scipy MATLAB IO routines
<https://docs.scipy.org/doc/scipy/reference/tutorial/io.html>`_ to save to a MAT
file. Note that all arrays that are accessible in a statepoint are already in
NumPy arrays that can be reshaped and dumped to MATLAB in one step.
.. _usersguide_track:
----------------------------
@ -101,5 +91,6 @@ For eigenvalue problems, OpenMC will store information on the fission source
sites in the statepoint file by default. For each source site, the weight,
position, sampled direction, and sampled energy are stored. To extract this data
from a statepoint file, the ``openmc.statepoint`` module can be used. An
`example notebook <../examples/post-processing.ipynb>`_ demontrates how to
analyze and plot source information.
`example notebook`_ demontrates how to analyze and plot source information.
.. _example notebook: https://nbviewer.jupyter.org/github/openmc-dev/openmc-notebooks/blob/main/post-processing.ipynb