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

Haddock3 online user manual #677

Draft
wants to merge 9 commits into
base: master
Choose a base branch
from
Draft

Haddock3 online user manual #677

wants to merge 9 commits into from

Conversation

VGPReys
Copy link
Contributor

@VGPReys VGPReys commented Jun 26, 2024

Pull request related to the haddock3 user manual.

TODO list:

  • [x] Manual.md
  • [ ] Introduction
    • [x] HADDOCK
    • [x] Haddock3 modularity
  • [ ] Installation
    • [ ] GitHub repository
    • [ ] CNS
    • [ ] Virtual environments (conda / venv)
  • [x] Command Line Interfaces (CLI)
    • [x] haddock3
    • [x] haddock3-cfg
    • [x] haddock3-restraints
    • [x] haddock3-score
    • [ ] haddock3-analyse
    • [ ] haddock3-traceback
    • [ ] haddock3-re
    • [x] haddock3-copy
    • [ ] haddock3-clean
    • [ ] haddock3-unpack
    • [ ] haddock3-mpitask
    • [ ] haddock3-dmn
    • [ ] haddock3-pp
    • [ ] haddock3-bm
  • [ ] Preparing input files
    • [ ] Haddock3 requirements (chains, no resid duplicates, no altloc, etc...)
    • [ ] pdb tools to manipulate input structures
  • [ ] Generating restraints for HADDOCK
    • [ ] General introduction
    • [ ] haddock-restraints command line interface
      • [ ] calc_accessibility
      • [ ] passive_from_active
      • [ ] active_passive_to_ambig
      • [ ] restrain_bodies
    • [ ] Symmetry restraints
    • [ ] Ab-initio docking mode
    • [x] Flexibility
      • [x] Molecules Segments
      • [x] Semi-flexible
      • [x] Fully-flexible
  • [ ] Generating a docking protocol
    • [ ] Global parameters
    • [ ] Concept of modules / parameters
  • [ ] Available modules
    • [ ] Topology
    • [ ] Sampling
    • [ ] Refinements
    • [ ] Scoring
    • [ ] Analysis
  • [ ] Docking scenario examples
  • [ ] Getting support / How to ask for help
  • [ ] Citing haddock3
  • [ ] Acknowledgement

Copy link
Member

@amjjbonvin amjjbonvin left a comment

Choose a reason for hiding this comment

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

It's start! Nice.

software/haddock3/index.md Outdated Show resolved Hide resolved
@amjjbonvin
Copy link
Member

I would also add sections about:

  • flexibility options
  • ab-initio docking mode (for CM restraints and random airs)
  • symmetry restraints

May-be as part of a general section about restraints in HADDOCK3 and this is also where the haddock-restraints part should be residing

@AnnaKravchenko
Copy link
Contributor

Question about flexibility options. It is about explaining how to make molecule/part of molecule flexible/semi-flexible in haddokc3, only practical things, right?
Or would you like to see a more theoretical explanation about flexibility in haddock, i.e. that semi-flexible refinement is happening in torsion angle space etc.?

@VGPReys
Copy link
Contributor Author

VGPReys commented Aug 1, 2024

Question about flexibility options. It is about explaining how to make molecule/part of molecule flexible/semi-flexible in haddokc3, only practical things, right? Or would you like to see a more theoretical explanation about flexibility in haddock, i.e. that semi-flexible refinement is happening in torsion angle space etc.?

flexref is a module and will have its own documentation.

In my opinion, it is more about explaining how to make molecules/segments flexible/semi-flexible.
Detailed explanation on the various parameters used to define it, and in which modules they can be used.

Basic instructions on how to define fully and semi-flexible segments + an example of each.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants