Skip to content

Commit

Permalink
DOC Polish up ResultReader.toMatlab docstring
Browse files Browse the repository at this point in the history
Explain the ordering of universes and remove "object"
as first argument
  • Loading branch information
drewejohnson authored and Andrew Johnson committed Mar 6, 2019
1 parent 6b7028e commit 85d6f3a
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions serpentTools/parsers/results.py
Original file line number Diff line number Diff line change
Expand Up @@ -691,10 +691,13 @@ def toMatlab(self, fileP, reconvert=True, append=True,
array, rather than a stacked 2D matrix. The axis are ordered
``burnup, universeIndex, group, value/uncertainty``
The ordering of the universes can be found in the ``'UNIVERSES'``
vector if ``reconvert==True``, otherwise ``'universes'``. Each
universe ID is present in this vector, ordered to their
position along the second axis in the matrix.
Parameters
----------
obj: ``serpentTools`` container
Parser or container to be written to file
fileP: str or file-like object
Name of the file to write
reconvert: bool
Expand Down

0 comments on commit 85d6f3a

Please sign in to comment.