Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rvhonorato committed Aug 13, 2024
1 parent 6724401 commit f542cbb
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,5 @@
- [`ti`](./ti.md)
- [`restraint`](./restraint.md)
- [`interface`](./interface.md)
- [`z`](./z.md)
- [Development](./development.md)
2 changes: 2 additions & 0 deletions docs/src/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,5 @@
- [`restraint`: Generate _unambiguous restraints_ to keep molecules together during docking](./restraint.md)

- [`interface`: List residues in the interface](./interface.md)

- [`z`: Generate restraints to keep the molecule aligned to the Z-axis](./z.md)
21 changes: 21 additions & 0 deletions docs/src/z.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Generate `z` restraints to keep the molecule aligned to the Z-axis

This subcommand generates restraints to keep the molecule aligned to the Z-axis. This is useful when you want to keep the molecule in a specific orientation during docking.

As input you need to pass at least one selection of residues, this will be used to define a plane perpendicular to the Z-axis. The restraints will be generated to keep the molecule aligned to this plane.

## Usage

To run the `z` subcommand, you need to provide the path to the PDB file, the selection of residues, the output file which will contain the shape beads, the number of beads to generate, and the distance between the beads. For example:

```bash
./haddock-restraints z \
--residues 19,83,145,119,167 \
path/to/the/input.pdb \
path/to/the/output/shape.pdb \
20 \ # spacing between the beads in angstrom - 20A
6 \ # grid size in dimension - 6x6
> z_restraints.tbl
```

Further, follow the HADDOCK documentation **\<pending\>** to use the generated restraints in the docking protocol.

0 comments on commit f542cbb

Please sign in to comment.