Skip to content

Commit 8001cbb

Browse files
committed
Docs updates, dependency fix
1 parent 25fec6b commit 8001cbb

2 files changed

Lines changed: 13 additions & 3 deletions

File tree

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ A utility to automatically prepare structures from the PDB for molecular dynamic
3838

3939
## Preparing structure files for simulation with prepmd
4040

41-
Note: When runnig `prepmd`, we recommend using .mmCif files where possible. The .pdb file format is deprecated, and is provided for legacy compatibility.
41+
Note: When running `prepmd`, we recommend using .mmCif files where possible. The .pdb file format is deprecated, and is provided for legacy compatibility.
4242

4343
### prepmd workflow
4444
Steps in the `prepmd` workflow:
@@ -65,9 +65,11 @@ Steps in the `prepmd` workflow:
6565
#### Use your own alignments and sequences to fill missing loops
6666
By default, `prepmd` will read missing residues from the pdb/mmcif SEQRES records, attempt to align the missing residues with the currently present residues, and then build missing loops with MODELLER. You can manually provide an aligned FASTA file containing the the complete and incomplete sequences with `--fasta`. You can also ask prepmd to get the sequence data from UNIPROT instead, with `--download`, though this is not recommended, as the raw sequence data can be substantially different from the PDB and cause the alignment to fail.
6767
#### Handling ligands
68-
By default, `prepmd` removes ligands and other molecules from the input and saves each HETATM residue to its own SDF file. If you don't intend to include the hetatms, you can disable this behaviour with the `--ignore_hetatams` flag. The co-ordinates inside the SDF files correspond to the co-ordinates of the ligands in the structure file, so the ligands can be added back into the original structure easily. `prepmd` uses [rdkit]() to add hydrogens and correct the geometry of small molecules.
68+
By default, `prepmd` removes ligands and other molecules from the input and saves each HETATM residue to its own SDF file. If you don't intend to include the hetatms, you can disable this behaviour with the `--ignore_hetatams` flag. The co-ordinates inside the SDF files correspond to the co-ordinates of the ligands in the structure file, so the ligands can be added back into the original structure easily. `prepmd` uses [rdkit](https://www.rdkit.org/) to add hydrogens and correct the geometry of small molecules.
6969
#### Working directory
7070
By default, `prepmd` will leave intermediate files in a randomly-named temporary directory. You can set the name of this directory: `prepmd --wdir 6xov_temp 6xov 6xov.cif`.
71+
#### Other notes
72+
Warning: `prepmd`'s output does not contain any of the metadata found in the original pdb. This is an intentional omission - a lot of metadata (pdb REMARKs, for example) is specific to the indexing of atoms, residues and chains in that file, which are usually changed by prepmd.
7173

7274
## Running MD simulations with runmd
7375
Steps in the `runmd` workflow:
@@ -97,7 +99,7 @@ The default settings result in a rather loose coupling to the heat bath. You can
9799
`runmd pre.cif -m post.cif -o minimised_out.pdb` will create a trajectory that smoothly transitions between the structures in pre.cif and post.cif. This trajectory is created using openmmtools' metadynamics features. The metadynamics run applies arbitrary biasing forces to perform the transition, so this should only be used for visualisation/illustration, and may not represent the underlying physics and biology.
98100
If you have two files for the same structure which aren't aligned (e.g. they have slightly different starting/ending residues), you can trim the ends to align them: `aligntogether pre.cif post.cif pre_cropped.cif post_cropped.cif`
99101
### Numerical integrators
100-
* Set the numerical integrator with the `-i` flag. This can be either `VariableLangevinIntegrator` or `LangevinMiddleIntegrator`. By default, `runmd` will attempt to use the latter, and fall back to the former if the simulation becomes numerically unstable. The parameter `--minimise-err` sets the error tolerance or the variable langevin integrator. Its value is arbitrary - 0.001 is a good starting point, increasing it will make the simulation run faster at the expense of accuracy.
102+
Set the numerical integrator with the `-i` flag. This can be either `VariableLangevinIntegrator` or `LangevinMiddleIntegrator`. By default, `runmd` will attempt to use the latter, and fall back to the former if the simulation becomes numerically unstable. The parameter `--minimise-err` sets the error tolerance or the variable langevin integrator. Its value is arbitrary - 0.001 is a good starting point, increasing it will make the simulation run faster at the expense of accuracy.
101103
### Other settings
102104
By default, `runmd` will try to select the most optimal nonbonded interaction method, but this can be overridden with `-nb` or `--nonbonded`, which can be one of `PME`, `CutoffPeriodic`, or `CutoffNonPeriodic`. Similarly, it will constrain the length of all bonds involving a hydrogen atom, which can allow for longer timesteps at the cost of some accuracy. This can be disabled by setting `-c None` or `--constraints None`. This setting is also disabled if the backbone is fixed.
103105

prepmd/pdb2pqr.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,13 @@ def run_pdb2pqr(infile, outfile, ff="AMBER"):
1919
Returns:
2020
nothing, but writes 'outfile'
2121
"""
22+
23+
if pdb2pqr.__version__ < "3.7.0":
24+
error = "Old version of pdb2pqr detected, please install a version"
25+
" after 3.7.0. If you installed everything via conda, please install "
26+
"pdb2pqr via pip (pip install pdb2pqr) as the conda package is "
27+
"abandoned."
28+
raise NotImplementedError(error)
29+
2230
pdb2pqr.run_pdb2pqr([infile, outfile, "--titration-state-method=propka",
2331
"--with-ph=7", "--ff="+ff, "--ffout="+ff, "--drop-water"])

0 commit comments

Comments
 (0)