Skip to content

add docs for analysis.align.AverageStructure #2944

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

Merged
orbeckst merged 1 commit into from
Sep 18, 2020
Merged

add docs for analysis.align.AverageStructure #2944

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
8 changes: 2 additions & 6 deletions package/MDAnalysis/analysis/align.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,7 @@

.. autofunction:: alignto
.. autoclass:: AlignTraj
.. autoclass:: AverageStructure
.. autofunction:: rotation_matrix


Expand Down Expand Up @@ -796,13 +797,8 @@ def __init__(self, mobile, reference=None, select='all', filename=None,
already a :class:`MemoryReader` then it is *always* treated as if
``in_memory`` had been set to ``True``.

.. versionadded:: 1.0.0

.. versionchanged:: 1.0.0
Copy link
Member

@IAlibay IAlibay Sep 15, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oops, that one's on me I believe.

Copy link
Member Author

@orbeckst orbeckst Sep 15, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No biggie — I rather have more information than less.

Thanks for reviewing so quickly.... and the other one — you beat me to asking for your review.

Support for the ``start``, ``stop``, and ``step`` keywords has been
removed. These should instead be passed
to :meth:`AverageStructure.run`.

.. versionadded:: 1.0.0
"""
if in_memory or isinstance(mobile.trajectory, MemoryReader):
mobile.transfer_to_memory()
Expand Down