mdanalysis icon indicating copy to clipboard operation
mdanalysis copied to clipboard

Added an info method to Universe Class

Open AHMED-salah00 opened this issue 2 years ago • 7 comments

This PR is still under development.

Changes made in this Pull Request:

Added an info method to Universe Class: - Number of atoms, residues, segments, bonds, angles, dihedrals, impropers. - Periodic boundary conditions. - Number of frames. - Timestep. - Time range. - Trajectory format.

PR Checklist

  • [x] Tests?
  • [x] Issue raised/referenced?
  • [ ] CHANGELOG updated?
  • [ ] Docs?

AHMED-salah00 avatar Mar 01 '23 05:03 AHMED-salah00

Codecov Report

Patch coverage: 11.11% and project coverage change: -0.07 :warning:

Comparison is base (c452da7) 93.56% compared to head (fe5ae10) 93.50%.

:exclamation: Current head fe5ae10 differs from pull request most recent head 7b03cea. Consider uploading reports for the commit 7b03cea to get more accurate results

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #4046      +/-   ##
===========================================
- Coverage    93.56%   93.50%   -0.07%     
===========================================
  Files          191      191              
  Lines        25075    25083       +8     
  Branches      4049     4045       -4     
===========================================
- Hits         23462    23454       -8     
- Misses        1093     1109      +16     
  Partials       520      520              
Impacted Files Coverage Δ
package/MDAnalysis/core/universe.py 93.85% <11.11%> (-3.41%) :arrow_down:

... and 2 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

codecov[bot] avatar Mar 01 '23 06:03 codecov[bot]

Hi @AHMED-salah00, welcome to MDAnalysis and thank you for your PR.

This PR is still under development, Still needs a lot of work...

If this is the case, could you please convert the PR into a draft PR? The reason is that everyone following the MDAnalysis repo is notified of changes to an open PR, but this does not happen for a draft PR IIRC. You can then convert back to an open PR once you think it is ready for review.

RMeli avatar Mar 01 '23 07:03 RMeli

Although this PR may need some changes, but also your reviews really matters to make these changes :100: .

AHMED-salah00 avatar Mar 01 '23 07:03 AHMED-salah00

@AHMED-salah00 with new features it's better to start a discussion on the developer mailing list or the #developer discord channel or open an issue with a feature request where you're describing what you're looking for. The developers can then discuss with you if the feature fits into the overall philosophy of the project. When you're new to a project you might not know all the considerations that have been going into developing the API (or all the quirks). MDAnalysis has been around for almost 15 years so there are many reasons why things are a certain way, what fits into the library and what doesn't.

Instead of spending time on coding something that you don't know if it's actually needed, spend time on figuring out requirements.

I appreciate your enthusiasm and I like that you're thinking about what might be a useful enhancement. I just have to say, though, that we are generally very careful when adding new code to the library because new code means a increasing maintenance burden. Therefore, it's not a given that we would accept your PR here.

I would suggest that you first ask for feedback on your general idea before embarking on a lot of coding work.

orbeckst avatar Mar 01 '23 17:03 orbeckst

Please see https://github.com/MDAnalysis/mdanalysis/issues/4050#issuecomment-1453844297 for right now — I won't review until we have discussed the fundamentals.

orbeckst avatar Mar 03 '23 17:03 orbeckst

@orbeckst @AHMED-salah00 is this still active or has this contribution fully stalled?

IAlibay avatar Jul 31 '23 10:07 IAlibay

@orbeckst @AHMED-salah00 is this still active or has this contribution fully stalled?

I was waiting actually for an update to know the final features "shape" for the method or else I might make a summary for what we stopped lastly. What do you think. Orbackst suggested that we should know more about the needs of the users.

AHMED-salah00 avatar Jul 31 '23 12:07 AHMED-salah00

See https://github.com/MDAnalysis/mdanalysis/issues/4050#issuecomment-1659150195 — given that we are essentially still in the design stage, I'm keeping comments on the issue itself.

orbeckst avatar Jul 31 '23 20:07 orbeckst

I summarized the requirements in https://github.com/MDAnalysis/mdanalysis/issues/4050#issuecomment-2221364697.

orbeckst avatar Jul 10 '24 20:07 orbeckst