Skip to content

Commit 57189eb

Browse files
author
Akshit Boora
committed
Clarify principal_axes() axis orientation in documentation (#1828)
1 parent 50dc512 commit 57189eb

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

package/MDAnalysis/core/topologyattrs.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2073,7 +2073,12 @@ def principal_axes(group, wrap=False):
20732073
axis_vectors : array
20742074
3 x 3 array with ``v[0]`` as first, ``v[1]`` as second, and
20752075
``v[2]`` as third eigenvector.
2076-
2076+
Notes
2077+
-----
2078+
The returned array contains the principal axes as row vectors.
2079+
Each row corresponds to one principal axis (e1, e2, e3). This may
2080+
appear transposed compared to conventions where eigenvectors are
2081+
stored as column vectors.
20772082
20782083
.. versionchanged:: 0.8
20792084
Added `pbc` keyword

0 commit comments

Comments
 (0)