Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
a part of the readme was moved to the website
  • Loading branch information
wojdyr committed Mar 8, 2016
1 parent f864ead commit 655cc2f
Showing 1 changed file with 1 addition and 78 deletions.
79 changes: 1 addition & 78 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,84 +1,7 @@
# dimple
Macromolecular crystallography pipeline for refinement and ligand screening.

Requires several programs from the CCP4 suite.

## How it works ##

You provide data (merged mtz) and Apo model (pdb) and tell the pipeline
where it should dump the results:

$ dimple my.mtz apo.pdb output-dir

<a href="https://asciinema.org/a/awgcb045doxjstods15xfqi1r" target="_blank"><img src="https://asciinema.org/a/awgcb045doxjstods15xfqi1r.png" width="589px"/></a>

If you wish you can give more than one model or pdb code
(only one of them will be used - the one with most similar unit cell):

$ dimple my.mtz apo.pdb my-other.pdb 4uqi output-dir

DIMPLE will do what it can to quickly return refined model,
pointing to unmodelled electron density blobs - potential ligand sites.

Simplifying a bit:
the pipeline runs macromolecular refinement after a few usual
preparatory steps (I to F, choosing Rfree set, reindexing if needed).
Sometimes it needs to run Molecular Replacement before refinement.
And at the end it checks for unmodelled blobs - suspected ligands.

<a href="https://asciinema.org/a/awg0n6qr6ez14oe8ugverg4bb" target="_blank"><img src="https://asciinema.org/a/awg0n6qr6ez14oe8ugverg4bb.png" width="589px"/></a>

It's quick. Running time depends of course on data, model and computer,
but about 3 minutes is typical. With MR it is usually 5-10 minutes,
but from time to time much, much longer.

### Options ###

DIMPLE has a lot of options (`dimple -h` lists all of them),
but since the goal of the pipeline is to make things simple,
we'll focus on one:

`--slow` (or `-s` for short) -- recommended if you are not in hurry.
DIMPLE will take twice more time, spending it mostly on extra cycles
of refinement. If this is still too fast, give this option twice --
to get 100 cycles of jelly-body refinement.

`-M` is also quite popular. It decides when MR should kick in:
`-M0` - always, `-M1` - never, `-M 0.4` - (default) if Rfactor after
rigid-body refinement is above 0.4. Rfactor for this purpose
is calculated only in data up to 3.5A.

### Selected Details ###

**reindexing (Pointless)** - if the data and model are in compatible
but different spacegroups, we change the spacegroup in the MTZ file.
We also check all possible _settings_ - Pointless calculates structure
factors from the model and compares the CC on E^2 to find the best
matching settings, reindexing data if necessary.
In some cases this steps saves as a couple minutes by avoiding MR.

**_free_ reflections** -
Rfree statistic depend to some degree on how lucky is the pseudo-random
set of free flags. To eliminate this luck factor when comparing
different data collection one may want to use the same set of free
flags. It is possible by passing external set of reference flags
(option `--free-r-flags`), but we wanted to do even without the
reference file. This was implemented by generating the same free set
for the same pdb file and should work if the space group is the same
and the resolution is below 1A (we had to pick arbitrary limit).

**scoring blobs** - it is rather simplistic now, we need to work on it

**generating pictures** - we have an option (`-f`) to generate static
images (PNG or JPEG) of the blobs. They are used by
[SynchWeb](https://github.com/DiamondLightSource/SynchWeb) in DLS.
Pictures are generated with Coot+Raster3d - this combines
the familiar look and feel of Coot with nicer graphics and headless
rendering.

<img src="http://i.imgur.com/cTDWIzK.png" width="300px"/>
<img src="http://i.imgur.com/e61cB7G.png" width="300px"/>

#### See docs at http://ccp4.github.io/dimple

## Installation ##

Expand Down

0 comments on commit 655cc2f

Please sign in to comment.