Ucsfdock: Difference between revisions

From DISI
Jump to navigation Jump to search
No edit summary
No edit summary
Line 3: Line 3:
Programs:
Programs:
* blastermaster: given receptor and ligand, generate a specific docking configuration
* blastermaster: given receptor and ligand, generate a specific docking configuration
* dockmaster: evaluate many different docking configurations in parallel using a provided job scheduler (e.g. Slurm)
* dockmaster: evaluate many different docking configurations in parallel using a specified job scheduler (e.g. Slurm)




Line 59: Line 59:
== dockmaster ==
== dockmaster ==


''dockmaster'' allows the evaluation of many different docking configurations in parallel using a provided job scheduler (e.g. Slurm).
''dockmaster'' allows the evaluation of many different docking configurations in parallel using a specified job scheduler (e.g. Slurm).


The name "dockmaster", aside from being an uncreative re-hash of the name "blastermaster", derives from the notion of a literal dockmaster, i.e. the in charge of a dock who manages freight logistics and bosses around numerous dockworkers. In this analogy, a single dockworker processes a single docking configuration.
The name "dockmaster", aside from being an uncreative re-hash of the name "blastermaster", derives from the notion of a literal dockmaster, i.e. the in charge of a dock who manages freight logistics and bosses around numerous dockworkers. In this analogy, a single dockworker processes a single docking configuration.

Revision as of 09:13, 28 July 2022

ucsfdock is a Python package wrapping the DOCK program that provides tools to help standardize and automate the computational methods employed in molecular docking.

Programs:

  • blastermaster: given receptor and ligand, generate a specific docking configuration
  • dockmaster: evaluate many different docking configurations in parallel using a specified job scheduler (e.g. Slurm)


Installation

  1. TODO

Quickstart

blastermaster

blastermaster allows a user to generate a specific docking configuration for a given receptor and ligand.

blastermaster configure

First you need to create the directory for your blastermaster job. To do so, simply type

blastermaster configure

By default, the job directory is named blastermaster_job. To specify a different name, type

blastermaster configure <JOB_DIR_NAME>

The job directory contains two sub-directories:

  1. working: blaster files, sub-directories for individual subroutines
  2. dockfiles: DOCK parameter files & INDOCK file

If your current working directory contains any of the following files

  • rec.pdb
  • xtal-lig.pdb
  • rec.crg.pdb
  • reduce_wwPDB_het_dict.txt
  • filt.params
  • radii
  • amb.crg.oxt
  • vdw.siz
  • delphi.def
  • vdw.parms.amb.mindock
  • prot.table.ambcrg.ambH

then they will be automatically copied into the working directory within the created job directory. This feature is intended to simplify the process of configuring the blastermaster job. If you would like to use files not present in your current working directory, copy them into your job's working directory, e.g.:

cp <FILE_PATH> <JOB_DIR_NAME>/working/

Finally, configure the blastermaster_config.yaml file in the job directory to your specifications. The parameters in this file govern the behavior of blastermaster.

blastermaster run

Once your job has been configured to your liking, navigate to the the job directory and run blastermaster:

cd <JOB_DIR_NAME>
blastermaster run

This will execute the many blastermaster subroutines in sequence. The state of the program will be printed to standard output as it runs.

dockmaster

dockmaster allows the evaluation of many different docking configurations in parallel using a specified job scheduler (e.g. Slurm).

The name "dockmaster", aside from being an uncreative re-hash of the name "blastermaster", derives from the notion of a literal dockmaster, i.e. the in charge of a dock who manages freight logistics and bosses around numerous dockworkers. In this analogy, a single dockworker processes a single docking configuration.

dockmaster configure

dockmaster run