Skip to content

Standardize atomicdistances to use results#5347

Draft
charity-g wants to merge 4 commits intoMDAnalysis:developfrom
charity-g:standardize-atomicdistances-to-use-results
Draft

Standardize atomicdistances to use results#5347
charity-g wants to merge 4 commits intoMDAnalysis:developfrom
charity-g:standardize-atomicdistances-to-use-results

Conversation

@charity-g
Copy link
Copy Markdown

@charity-g charity-g commented Mar 28, 2026

Fixes #4819

Changes made in this Pull Request:

LLM / AI generated code disclosure

LLMs or other AI-powered tools (beyond simple IDE use cases) were used in this contribution: no

PR Checklist

  • Issue raised/referenced?
  • Tests updated/added?
  • Documentation updated/added?
  • package/CHANGELOG file updated?
  • Is your name in package/AUTHORS? (If it is not, add it!)
  • LLM/AI disclosure was updated.

Developers Certificate of Origin

I certify that I can submit this code contribution as described in the Developer Certificate of Origin, under the MDAnalysis LICENSE.


📚 Documentation preview 📚: https://mdanalysis--5347.org.readthedocs.build/en/5347/

Copy link
Copy Markdown
Member

@BradyAJohnston BradyAJohnston left a comment

Choose a reason for hiding this comment

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

Some suggestions that should fix the issues with running tests.

The black formatter is also failing. You can run it like this:

uvx black~=24.0 package

# MDAnalysis: A Toolkit for the Analysis of Molecular Dynamics Simulations.
# J. Comput. Chem. 32 (2011), 2319--2327, doi:10.1002/jcc.21787
#
from mdanalysis.package.MDAnalysis.analysis.results import Results
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This is what's causing your tests to fail - this mdanalysis.package.MDAnalysis only exists on local file system. You should always just import directly from MDAnalysis - which will become available if you us pip install -e . or uv pip install -e ..


"""

from mdanalysis.package.MDAnalysis.analysis.results import (
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

same issue with imports as in other comment.

Changes
* The msd.py inside analysis is changed, and ProgressBar is implemented inside
_conclude_simple and _conclude_fft functions instead of tqdm (Issue #5144, PR #5153)
* `MDAnalysis.analysis.atomicdistances.AtomicDistances` results are now consistent with expected`analysis` documentation data type = Results (Issue #4819)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

needs a space between "expected analysis"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

analysis.atomicdistances.AtomicDistances does not use Results

2 participants