Skip to content

Commit d8923e2

Browse files
Add link to AIRviewer3 to advanced protein-DNA tuto (#727)
* add link to AIRviewer on python3, and related info
1 parent 9f0aeec commit d8923e2

File tree

1 file changed

+17
-6
lines changed
  • education/HADDOCK24/HADDOCK24-protein-DNA-advanced

1 file changed

+17
-6
lines changed

education/HADDOCK24/HADDOCK24-protein-DNA-advanced/index.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -505,11 +505,14 @@ In this part we will introduce you to some of the more powerful methods for gene
505505
### Using this part
506506
The topics covered in this part assume that you are familiar with the concept of "Ambiguous Interaction Restraints" and their basic setup using *active* and *passive* residues (See Reference for more information).
507507

508-
In this part, you will use a custom-made plugin for the `PyMol` molecular viewer to construct and visualise *AIR*s for the Cro-OR1 system.
509-
This plugin (`AIRviewer.py`) comes as part of the tutorial data set, and you will be instructed on how to use it during the course of this part.
510-
The plugin combines the ability to construct custom restraint sets for multi-body systems with the convenience of a visual appreciation of the resulting restraints network.
508+
In this part, you will use a custom-made plugin for the PyMOL molecular viewer to construct and visualise *AIR*s for the Cro-OR1 system.
509+
The plugin combines the ability to construct custom restraint sets for multi-body systems with the convenience of a visual appreciation of the resulting restraints network. **Download `AIRviewer3.py` using this** [**link**](https://surfdrive.surf.nl/files/index.php/s/GX1zKtcaCWq0nFk){:target="_blank"}.
511510

512-
An alternative to the use of this plugin is a special HADDOCK `Generate Restraints` web interface available at: [https://wenmr.science.uu.nl/haddock-restraints/](https://wenmr.science.uu.nl/haddock-restraints/)
511+
**Note** that data archive includes `tools/AIRviewer.py`, which differs from the version linked above. The linked AIRviewer3 requires Python 3, while the one in `tools/` requires Python 2.
512+
513+
**Note** that `AIRviewer` is mainly useful when AIRs are generated by manually selecting residues in PyMOL. In most cases, it is more convenient and up to date to use the HADDOCK [Generate Restraints](https://wenmr.science.uu.nl/haddock-restraints/){:target="_blank"} web interface, the [haddock-restraints](https://github.com/haddocking/haddock-restraints){:target="_blank"} command-line tool, or to simply specify active/passive residues directly in the `Input parameters` section of the HADDOCK web server.
514+
515+
**Note** that `AIRviewer` is not the only way to visualize the restraints network. You can also use `haddock-restraints` with the `--pml` flag. See the [documentation](https://github.com/haddocking/haddock-restraints/pull/47){:target="_blank"} for more details.
513516

514517

515518
#### Constructing AIRs for protein-DNA systems
@@ -558,10 +561,12 @@ load airsession.pdb
558561

559562
2) Setup PyMol to use the AIRviewer plugin
560563

561-
On the PyMol Command line (1):
564+
Click on `Plugin`>>`Plugin Manager` on the top-right of the screen. A plugin menu will appear. Click on `Install New Plugin`, and `Choose file...`. Select `AIRviewer.py`, follow PyMol's instructions.
565+
566+
Alternatively, on the PyMol Command line (1):
562567

563568
<a class="prompt prompt-pymol">
564-
run ../tools/AIRviewer.py<br>
569+
run ../path/to/AIRviewer3.py # add actual path to AIRviewer3.py on your machine<br>
565570
Activate PyMols sequence viewer (`S` button Figure 3, bottom-right option bar (3)).
566571
</a>
567572

@@ -574,6 +579,12 @@ The sequence viewer can be used to select residues.
574579

575580
The plugin is now activated and its functionality is available as a number of buttons on the right side panel (**Figure 3.2**). Let's start constructing the restraint set for our system in 4 steps (3-6). All steps are performed in the same PyMol session:
576581

582+
**Note** that AIRviewer3 requires manual actvation every time new PyMOL window is open. To do so, go to `Plugin Manager`>>`Installed Plugins`,
583+
find `AIRviewer3` in the list and click `Load`. Please note that it is **mandatory** to upload a complex to PyMOL before loading `AIRviewer3`.
584+
If no molecules are open in PyMOL, `AIRviewer3` loading will fail with the next error message:
585+
`ERROR: no chain ID and no segid ID defined. Need one of these object of type 'NoneType' has no len()`
586+
`Unable to initialize plugin 'AIRviewer' (pmg_tk.startup.AIRviewer3)`
587+
577588
3) Setup AIRs between conserved residues of helix 3 and nucleotide bases of OR1
578589

579590
<a class="prompt prompt-pymol">

0 commit comments

Comments
 (0)