Skip to content

Fix documentation for geometric selections with PBC (#2166) #5305

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AkshitBoora wants to merge 1 commit into
base: develop
Choose a base branch
from
+4 −6
Open

Fix documentation for geometric selections with PBC (#2166) #5305

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions package/doc/sphinx/source/documentation_pages/selections.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,12 +302,10 @@ prop [abs] *property* *operator* *value*


.. note::
By default periodicity **is** taken into account with geometric
selections, i.e. selections will find atoms that are in different
periodic images.
To control this behaviour, use the boolean ``"periodic"`` keyword
argument of :meth:`~MDAnalysis.core.groups.AtomGroup.select_atoms`.

Geometric selections internally use capped distance searches together
with periodic KD-trees to correctly handle periodic boundary conditions
(PBC). This ensures that atom selections follow the minimum image
convention when computing distances across periodic boundaries.

Similarity and connectivity
---------------------------
Expand Down
Loading