Skip to content
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.

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

Add a reader for TNG files using pytng #3765

Merged
merged 86 commits into from
Dec 15, 2022

Conversation

hmacdope
Copy link
Member

@hmacdope hmacdope commented Aug 1, 2022

Fixes #3237 and partially addresses #865 (reading TNG)

This PR adds functionality for reading TNG files using pytng (finally). 😄

The limitations of reading a TNG file using pytng are also clearly outlined in the docs.

Changes made in this Pull Request:

  • Add a reader for TNG files using PyTNG

TODO

Need to add tests using an example data file

PR Checklist

  • Tests?
  • Docs?
  • CHANGELOG updated?
  • Issue raised/referenced?

@hmacdope hmacdope self-assigned this Aug 1, 2022
@pep8speaks
Copy link

pep8speaks commented Aug 1, 2022

Hello @hmacdope! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

Line 29:80: E501 line too long (98 > 79 characters)
Line 195:80: E501 line too long (85 > 79 characters)
Line 201:80: E501 line too long (86 > 79 characters)
Line 207:80: E501 line too long (82 > 79 characters)
Line 261:80: E501 line too long (85 > 79 characters)
Line 467:80: E501 line too long (82 > 79 characters)

Line 136:80: E501 line too long (87 > 79 characters)
Line 140:80: E501 line too long (80 > 79 characters)
Line 144:80: E501 line too long (80 > 79 characters)

Line 130:80: E501 line too long (96 > 79 characters)
Line 132:80: E501 line too long (95 > 79 characters)
Line 339:80: E501 line too long (92 > 79 characters)
Line 340:80: E501 line too long (95 > 79 characters)

Comment last updated at 2022-09-09 18:03:04 UTC

@orbeckst
Copy link
Member

orbeckst commented Aug 2, 2022

Does pytng have conda packages already?

@hmacdope
Copy link
Member Author

hmacdope commented Aug 2, 2022

Does pytng have conda packages already?

Yep ! https://github.com/conda-forge/pytng-feedstock

@richardjgowers
Copy link
Member

@IAlibay I think your review comments have been addressed here

@IAlibay
Copy link
Member

IAlibay commented Sep 12, 2022

@IAlibay I think your review comments have been addressed here

Thanks, unless this has a time sensitive component (please let me know if that is the case), I'll re-review later this week (after the 13th).

@IAlibay
Copy link
Member

IAlibay commented Sep 18, 2022

Sorry about the lack of review here, this is still on my radar the week has just been a bit busy. I'll try to go over it tomorrow.

@hmacdope
Copy link
Member Author

hmacdope commented Oct 27, 2022

Any chance of a final review here @MDAnalysis/coredevs? :)

@IAlibay
Copy link
Member

IAlibay commented Oct 27, 2022

Yeah sorry I did note it down earlier today when I was looking at what PRs needed merging. I'll try to re-review over the weekend.

@IAlibay IAlibay added this to the 2.4.0 milestone Nov 11, 2022
@hmacdope hmacdope mentioned this pull request Nov 29, 2022
4 tasks
Copy link
Member

@IAlibay IAlibay left a comment

Choose a reason for hiding this comment

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

Sorry about the very long time back to review this. Just a couple of tiny things.

I'm concurrently updating CI on pytng just to make sure upstream is all good when we do a release.

try:
import pytng
except ImportError:
#: Indicates whether pytng is found.
Copy link
Member

Choose a reason for hiding this comment

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

readthedocs is having a field day here, can you confirm this renders fine locally @hmacdope ? https://mdanalysis--3765.org.readthedocs.build/en/3765/documentation_pages/coordinates/TNG.html

Copy link
Member Author

Choose a reason for hiding this comment

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

Seems to be ok locally, what specifically where you looking at?

Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Member Author

Choose a reason for hiding this comment

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

Removing the comments of the form #: fixed it.

@IAlibay
Copy link
Member

IAlibay commented Dec 12, 2022

We can ignore most of the linter stuff, but do have a look at the output if there's anything you think is worth it. Specifically the assert calls might make more sense without the brackets.

@hmacdope hmacdope requested a review from IAlibay December 13, 2022 02:25
@hmacdope
Copy link
Member Author

@IAlibay I think i have addressed everything including formatting. :)

Copy link
Member

@IAlibay IAlibay left a comment

Choose a reason for hiding this comment

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

lgtm!

@IAlibay IAlibay merged commit 1f48778 into MDAnalysis:develop Dec 15, 2022
@jbarnoud
Copy link
Contributor

This has been years in the making. Thank you for making this milestone happen!

@orbeckst
Copy link
Member

Well done, everyone!

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

Successfully merging this pull request may close these issues.

PyTNG integration into MDA.
7 participants