Skip to content

Commit eedfe2d

Browse files
committed
Adding explaination of grouping to docs
1 parent da3197e commit eedfe2d

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

docs/getting_started.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,12 @@ The top_traj_file argument is necessary to identify your simulation data, the ot
130130
- ``molecules``
131131
- ``str``
132132

133+
Averaging
134+
^^^^^^^^^
135+
The code is able to average over molecules of the same type.
136+
The grouping arguement is used to control how the averaging is done.
137+
The default is "molecules" which defines molecules by the number and names of the atoms and groups molecules that are the same.
138+
You can also use "each" which makes each molecule its own group, effectively not averaging over molecules.
133139

134140
Example #1
135141
^^^^^^^^^^

0 commit comments

Comments
 (0)