RPXDock
Version 2 of the venerable tcdock and rpxdock programs in rosetta. This version will be faster, simpler, and mostly in python.
.. figure:: doc/img/general_software_structure.jpg :width: 900px :align: center :height: 400px :alt: alternate text :figclass: align-center
Read the RPXDock manuscript <https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1010680>_.
Running Rpxdock ############### Here is a simple example, tested with python 3.12. The first time you run rpxdock, it will build some C++ files, this takes a few minutes. ::
virtualenv rpxdock_venv source ./rpxdock_venv/bin/activate # if not bash, use appropriate script in this dir
pip install git+https://github.com/willsheffler/rpxdock
python -m pytest --pyargs rpxdock # optional
python -mrpxdock --architecture C3 --inputs1 rpxdock/data/pdb/C3_1na0-1_1.pdb.gz --dump_pdbs --hscore_data_dir /data/sheffler/data/rpx/hscore/willsheffler/ python -mrpxdock --architecture C17 --inputs1 rpxdock/data/pdb/C3_1na0-1_1.pdb.gz --dump_pdbs --hscore_data_dir /data/sheffler/data/rpx/hscore/willsheffler/
python -mrpxdock --architecture T32 --inputs1 rpxdock/data/pdb/C3_1na0-1_1.pdb.gz --inputs2 rpxdock/data/pdb/C2_REFS10_1.pdb.gz --dump_pdbs --hscore_data_dir /data/sheffler/data/rpx/hscore/willsheffler/ python -mrpxdock --architecture O32 --inputs1 rpxdock/data/pdb/C3_1na0-1_1.pdb.gz --inputs2 rpxdock/data/pdb/C2_REFS10_1.pdb.gz --dump_pdbs --hscore_data_dir /data/sheffler/data/rpx/hscore/willsheffler/ python -mrpxdock --architecture I32 --inputs1 rpxdock/data/pdb/C3_1na0-1_1.pdb.gz --inputs2 rpxdock/data/pdb/C2_REFS10_1.pdb.gz --dump_pdbs --hscore_data_dir /data/sheffler/data/rpx/hscore/willsheffler/
deactivate # leave rpxdock_venv rm -rf rpxdock_venv # delete rpxdock_venv
Useful scripts: ###############
app/dock.py - the main script to initialize and run protein dockingfilters.yml - Example filter parameters passed in as RPXDock --filters flagapp/options.py - List of input parameters, descriptions, and default valuestools/dock.sh - simple docking example to execute RPXDocktools/dump_pdb_from_output.py - Output pdb from RPXDock tarball or pickle filestools/rpxdock_to_design.sh - simple example for using RosettaScripts to design RPXDock outputstools/rpxdock_to_design.xml - simple xml file used for RosettaScripts to design RPXDock outputstools/symdef/*.sym - symmetry definition files for polyhedral architecturesInput preparation for RPXDock: ##############################
Example input pdb files are provided in tools/input/scaffolds/*.pdb. Input .pdb files are provided to the dock.py application using the --inputs1 option. The input can be a path to a single .pdb (e.g., example.pdb) file, or a path with a wildcard (e.g., /path/to/files/*.pdb) can be supplied for multiple inputs. For multicomponent docking, additional inputs can be provided using the --inputs2 and --inputs3 option as necessary. For trajectories with multiple input lists provided to --inputs[n], each object in the list will be sampled against every other object in a partner list. The results for list inputs are batched and ranked together against one another. Thus, the “top” results may not include representatives from every input .pdb. If results from every input are desired, the user can either analyze the entire output list or execute each input or pair of inputs in separate RPXDock trajectories.
To dock two distinct monomers asymmetrically or to form cyclic oligomers, monomeric building blocks should have their center of mass at [0,0,0]. RPXDock will not center the inputs by default, but the --recenter_input option can be passed to translate a monomeric building block such that its center of mass is at [0,0,0]. The final transform values reported are relative to the recentered pose, so it is recommended that inputs are pre-centered if the user plans to use these values.
To form dihedral, stacking, wallpaper, and polyhedral group symmetries such as tetrahedral, octahedral, and icosahedral architectures, the input building blocks must be cyclic oligomers. The input .pdb files must be pre-aligned such that their internal rotational symmetry axes are aligned to the Z axis and the center of mass of the oligomer should be centered at [0,0,0]. It is important to note that the input .pdb files should only contain the asymmetric unit (asu) of the cyclic oligomer rather than the full symmetric building block, as RPXDock will generate the symmetry-related chains. Currently, dihedral docking only supports one-component (i.e., homomeric) architectures; stacking supports two-component architectures; polyhedral group docking supports one-, two-, and three-component architectures; and wallpaper docking supports two- and three-component architectures.
Using Pyrosetta ###############
To run RPXDock, clone this github repo and set up a proper conda environment using the environment.yml file. Note that a user must obtain a pyrosetta license (free for non-profit users) and update the username and password fields for their pyrosetta license in the environment.yml file before creating the environment. Users may need to also install additional packages in their conda environment such as pyyaml and willutil <https://github.com/willsheffler/willutil>_ to properly build the application. To build and compile the codebase with the newly created conda environment, a user may simply run the pytest command using a gcc>9-compatible compiler. To verify that the code compiled properly, execute rpxdock/app/dock.py –-help in the new conda environment. The output should provide a list of options that are relevant for docking.