Skip to content

Commit 4e24c2d

Browse files
Update documentation for particle tracks (#3627)
Co-authored-by: Paul Romano <paul.k.romano@gmail.com>
1 parent 2d77544 commit 4e24c2d

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

docs/source/usersguide/processing.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -68,17 +68,17 @@ generation, and particle number of the desired particle. For example, to create
6868
a track file for particle 4 of batch 1 and generation 2::
6969

7070
settings = openmc.Settings()
71-
settings.track = (1, 2, 4)
71+
settings.track = [(1, 2, 4)]
7272

73-
To specify multiple particles, the length of the iterable should be a multiple
74-
of three, e.g., if we wanted particles 3 and 4 from batch 1 and generation 2::
73+
To specify multiple particles, specify a list of tuples, e.g., if we wanted
74+
particles 3 and 4 from batch 1 and generation 2::
7575

76-
settings.track = (1, 2, 3, 1, 2, 4)
76+
settings.track = [(1, 2, 3), (1, 2, 4)]
7777

78-
After running OpenMC, the working directory will contain a file of the form
79-
"track_(batch #)_(generation #)_(particle #).h5" for each particle tracked.
80-
These track files can be converted into VTK poly data files with the
81-
:class:`openmc.Tracks` class.
78+
After running OpenMC (now, without the ``-t`` argument), the working directory
79+
will contain a file named `tracks.h5`, which contains a collection of particle
80+
tracks. These track files can be converted into VTK poly data files or
81+
matplotlib plots with the :class:`openmc.Tracks` class.
8282

8383
----------------------
8484
Source Site Processing

0 commit comments

Comments
 (0)