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

deprecate hydrogen bond analysis in water bridge analysis to master #3111

Merged
merged 15 commits into from
Mar 13, 2021

Conversation

xiki-tempula
Copy link
Contributor

@xiki-tempula xiki-tempula commented Jan 28, 2021

deprecate hydrogen bond analysis in water bridge analysis.
The hydrogen bond analysis is not used in the original water bridge analysis and I have cleared some reference to the hydrogen bond analysis in the doc sections.
Move water bridge analysis from hbonds to hydorgenbonds

Related to #2913, #2739 and #2746

PR Checklist

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

@pep8speaks
Copy link

pep8speaks commented Jan 28, 2021

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

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2021-03-13 17:09:43 UTC

@xiki-tempula xiki-tempula marked this pull request as draft January 28, 2021 10:06
@codecov
Copy link

codecov bot commented Jan 28, 2021

Codecov Report

Merging #3111 (1eecb1a) into master (232b4dc) will increase coverage by 0.84%.
The diff coverage is 97.46%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #3111      +/-   ##
==========================================
+ Coverage   90.96%   91.81%   +0.84%     
==========================================
  Files         161      167       +6     
  Lines       22181    22699     +518     
  Branches     3198     3198              
==========================================
+ Hits        20177    20841     +664     
- Misses       1381     1774     +393     
+ Partials      623       84     -539     
Impacted Files Coverage Δ
...nalysis/analysis/hydrogenbonds/wbridge_analysis.py 97.43% <97.43%> (ø)
...age/MDAnalysis/analysis/hbonds/wbridge_analysis.py 100.00% <100.00%> (+7.10%) ⬆️
...kage/MDAnalysis/analysis/hydrogenbonds/__init__.py 100.00% <100.00%> (ø)
package/MDAnalysis/topology/tpr/obj.py 96.82% <0.00%> (-3.18%) ⬇️
...onality_reduction/DimensionalityReductionMethod.py 97.14% <0.00%> (-2.86%) ⬇️
package/MDAnalysis/tests/__init__.py 100.00% <0.00%> (ø)
package/MDAnalysis/tests/datafiles.py 31.25% <0.00%> (ø)
package/MDAnalysis/analysis/legacy/x3dna.py 0.00% <0.00%> (ø)
package/MDAnalysis/due.py 56.09% <0.00%> (ø)
... and 88 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 232b4dc...1eecb1a. Read the comment docs.

@xiki-tempula xiki-tempula marked this pull request as ready for review January 28, 2021 10:51
@IAlibay IAlibay added this to the 1.0.2 milestone Jan 28, 2021
@IAlibay IAlibay added the deprecation Deprecated functionality to give advance warning for API changes. label Jan 28, 2021
@IAlibay
Copy link
Member

IAlibay commented Jan 28, 2021

Couple of things maintenance things:

  1. I've made this a target for 1.0.2, the code freeze is currently on for 1.0.1, so please don't merge until we release.
  2. I've restarted the failed Travis job, hopefully that'll complete this time.

Quick question @xiki-tempula, did you make any changes to the moved waterbridge analysis code (or it is just a standard move)? Github has done the really annoying thing of doing +1.5k -1.5k so it's pseudo-impossible to review anything from the diff.

@xiki-tempula
Copy link
Contributor Author

@IAlibay Nothing has changed in waterbridge analysis code. Just PEP8 changes.

Copy link
Member

@orbeckst orbeckst left a comment

Choose a reason for hiding this comment

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

Looks good (for 1.0.2). Thank you, @xiki-tempula !

orbeckst pushed a commit that referenced this pull request Feb 5, 2021
* Move water bridge analysis from hbonds to hydrogenbonds (PR #2913)
* part of #2739
* deprecate hydrogen bond analysis in water bridge in PR #3111 
* Update CHANGELOG

Co-authored-by: Irfan Alibay <IAlibay@users.noreply.github.com>
@orbeckst
Copy link
Member

@IAlibay you will merge this PR when 1.0.1 is out, right?

@IAlibay
Copy link
Member

IAlibay commented Feb 17, 2021

@IAlibay you will merge this PR when 1.0.1 is out, right?

Yup, I've placed it as a 1.0.2 milestone so we don't forget about it.

@IAlibay
Copy link
Member

IAlibay commented Mar 13, 2021

@xiki-tempula if you can update against the current master (probably will need to move the changelog entry to 1.0.2), I think we're at a point where we can merge this.

@xiki-tempula
Copy link
Contributor Author

xiki-tempula commented Mar 13, 2021

@IAlibay So I have merged the master and updated the changelog.
It seems that the test failed for py27 importlib.reload is introduced from py33.
I wonder if the master branch still needs to support py27?

@IAlibay
Copy link
Member

IAlibay commented Mar 13, 2021

@IAlibay So I have merged the master and updated the changelog.
It seems that the test failed for py27 importlib.reload is introduced from py33.
I wonder if the master branch still needs to support py27?

Yes unfortunately it does. I think you should be able to use reload_module from six.moves instead?

@xiki-tempula
Copy link
Contributor Author

@IAlibay I think everything is fixed now.

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.

Just some thoughts on py2 backward compatibility, and then one changelog addition.

of a water bridge existence.

"""
from __future__ import division
Copy link
Member

@IAlibay IAlibay Mar 13, 2021

Choose a reason for hiding this comment

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

to ensure proper backwards compatibility we'll need six.move's range and zip too (worth having a look for other deprecated py2 things, but I think that's it?).

Probably worth adding absolute_import here too.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have added them but given that tests have all passed so I think should be fine.

Copy link
Member

Choose a reason for hiding this comment

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

Cheers. Yeah, it's really just for the sake of "correctness".

package/CHANGELOG Show resolved Hide resolved
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.

Thanks @xiki-tempula I'll merge once CI returns green.

@IAlibay IAlibay merged commit 7ed893d into MDAnalysis:master Mar 13, 2021
@xiki-tempula xiki-tempula deleted the wb_master branch March 13, 2021 19:50
PicoCentauri pushed a commit to PicoCentauri/mdanalysis that referenced this pull request Mar 30, 2021
…s#2913)

* Move water bridge analysis from hbonds to hydrogenbonds (PR MDAnalysis#2913)
* part of MDAnalysis#2739
* deprecate hydrogen bond analysis in water bridge in PR MDAnalysis#3111 
* Update CHANGELOG

Co-authored-by: Irfan Alibay <IAlibay@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component-Analysis deprecation Deprecated functionality to give advance warning for API changes. maintainability
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants