re-introduce gdock module#1576
Open
rvhonorato wants to merge 43 commits into
Open
Conversation
Member
Author
|
The However I've hit a conceptual wall in the way restraints are treated. So I will pause work on this while I implement ambiguous restraints in For now I'll keep the PR open since its just additive - but if the code diverges too much I'll reopen it. |
Member
Author
|
@amjjbonvin please add whoever else you think is relevant for this review |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Checklist
Modifications / enhancements are reflected on the haddock3 user-manualCHANGELOG.mdis updated to incorporate new changesgdockhas a zero-clause license so it's fully compatible hereDoes not add any dependencies, if it does please add a thorough explanationgdock-pywhich has no parent dependenciesSummary of the Pull Request
This PR re-introduces
gdockas a sampling module. It was first introduced in #72 and then removed in #1454. The reason for removal is thatgdockdepended on an external dependency for its scoring function that was no longer available - so the whole software was not functional anymore.Since then I have completely re-written
gdockfrom scratch and implemented the energy calculation myself (see the release notes for more info about the re-write)To fulfill this integration into haddock3 I have written thin bindings (bits of code that wrap the
gdock's source code in python) to make the addition here simpler - seegdock-py.Since haddock uses ambiguous restraints, I have also added this concept in
gdockso it can seamlessly read haddock's tbl file and can handle theORlogic. I have implemented, to the best of my knowledge, the same function that haddock uses for its AIR restraint calculation - https://github.com/rvhonorato/gdock/pull/64As for the integration itself I also added some compatibility to be in line with the other sampling module;
[gdock]can handle ensembles by running each combination and it can also handlecrossdock=True.The key parameters I have exposed in the
gdockinterface are:ambig_fnamemax_generationsnumber_of_individualssamplingseedcrossdockI have also created some example files for the compatible scenarios replacing
rigidbodywithgdock- however we cannot make a one-to-one comparison given thatgdockandhaddockare using different formulations of the OPLS forcefields.We would need a deeper investigation to properly parametrize which parameter and module configurations we should use to obtain similar results - this is however way far beyond the scope of this PR.
Here I am "just" adding
gdockas a module and I think this can also serve as a good example of how to add new (external)-modules, so please keep the discussion in this PR so it serves for future reference.Related Issue
#1595
Additional Info
Please have a look at gdock.org for full information about how
gdockworks. I did not add the whole information here since its described elsewhere.