Help:Copying FirstGlance Scenes into Proteopedia: Difference between revisions

From Proteopedia
Jump to navigation Jump to search
Eric Martz (talk | contribs)
added OS X drag and drop workaround
Eric Martz (talk | contribs)
No edit summary
 
(79 intermediate revisions by 3 users not shown)
Line 1: Line 1:
1. Be sure to start ''FirstGlance in Jmol'' from the''' link beneath the molecule in Proteopedia'''. This link goes to a version of FirstGlance in Jmol that uses a Jmol version matched to the version of Jmol in Proteopedia. If you go to firstglance.jmol.org, you will get an older version that will not work for copying scenes in to Proteopedia. If you upload a custom PDB file, even from the older version of ''FirstGlance in Jmol'', the uploaded model will automatically be displayed in the newer Proteopedia-compatible version of ''FirstGlance in Jmol'' (version 1.39 or higher).
[[FirstGlance in Jmol]] makes it easy to obtain '''certain types''' of molecular scenes more easily than generating those scenes in Proteopedia's [[Scene Authoring Tools]]. This page explains how to move those scenes into Proteopedia, attaching them to a green link.
 
<StructureSection size='350' side='right' caption="Selected contacts between an anti-Alzheimer`s drug analog and acetylcholinesterase in [[1gpk]]. Scene generated largely and quite easily in [[FirstGlance in Jmol]]. Atoms shown as balls are within non-covalent bonding distances. Use '''popup''' to see details in this scene!" scene='23/236474/Selected_hup_contacts2/3'>
==Procedure==
''This procedure was improved in July, 2024.''
 
1. View the molecule in FirstGlance.
:*If the molecule has a [[PDB code]], search for the page titled with that PDB code in Proteopedia. At that page, click on the link to ''FirstGlance'' beneath the molecule, in the '''Resources''' block.
:*Or, simply go to [http://firstglance.jmol.org firstglance.jmol.org] and enter the PDB code.
:*If the model does not have a PDB code (e.g. a [[Practical Guide to Homology Modeling|homology model]]), upload the PDB file at [http://firstglance.jmol.org firstglance.jmol.org].
:*If you want to color the protein by evolutionary conservation, there are two methods:
:**It is possible to create a green-linked scene with a molecule colored by evolutionary conservation simply by using the button "evolutionary conservation" in the "color" tab of the [[SAT|Molecular Scene Authoring Tools]]. However, as explained in [[Conservation, Evolutionary#Caveats|Caveats]], this pre-calculated color scheme may obscure important parts of the conservation pattern. This is explained at [[Interpreting_ConSurf_Results#Diversity_in_the_MSA|Diversity in the MSA]] and with an example under [[Interpreting_ConSurf_Results#Average_Pairwise_Distance|Average Pairwise Distance]].
:**You can use custom settings at the ConSurf Server to limit the MSA largely to proteins of a single function. Some examples are explained at [[Interpreting ConSurf Results]], and the basic ConSurf Server procedure is at the [[ConSurf Quick Analysis Procedure]].


2. Obtain the '''desired scene''' in FirstGlance in Jmol. Turn off spinning (even if you want it to spin in Proteopedia), and orient and zoom the molecule as you want it to appear initially.
2. Obtain the '''desired scene''' in FirstGlance in Jmol. Turn off spinning (even if you want it to spin in Proteopedia), and orient and zoom the molecule as you want it to appear initially.


3. '''Open Jmol's Console:''' Click on the word '''Jmol''' at the lower right corner below the molecule. On the menu that opens, click '''Console'''. A new small white window will appear. It is the ''Jmol Console''.
3. Right-click (Mac: Ctrl-click) on or near the molecule to open JSmol's menu. Select '''File''', '''Save script with state'''. A dialog will appear in which you can choose the location on your computer's disk to save the file. Take note of the name of the file and where you are putting it. This file contains a ''state script'' of JSmol commands that will produce your scene.
 
4. '''Delete the load command.''' Edit the state script file with a [[Help:Plain text editors|plain text editor]]. Before you use the state script, you must the entire command at the end of the 3rd block of commands, and then save the file with that change. Delete <font color="red">everything shown below in red</font>: the entire command beginning with "load", deleting everything up until the closing bracket "}" (keeping that closing bracket!). The load command may be long, wrapping onto several lines in your plain text editor.
<blockquote>
function _setFileState() {
<br>
<br> &nbsp; set allowEmbeddedScripts false;
<br> &nbsp; <font color="#808080">... blah blah blah ...  </font>
<br> &nbsp; set smartAromatic true;
<br> &nbsp; <font color="red">load /*file*/"<nowiki>http://www.rcsb.org/pdb/cgi/export.cgi/1GPK.pdb.gz</nowiki>"; </font>
<br><br>
}</blockquote>
 
5. Edit the page in Proteopedia where you want to install the scene from FirstGlance in Jmol. Show the '''Scene Authoring Tool'''.


4. '''Display the state script:''' Click the console buttons ''Clear Output'', then ''State''. A long Jmol command script will appear in the top box of the Console. This script describes the current state or scene in Jmol.
6. '''Load your molecule:''' Use the '''load molecule''' tab to load your PDB code (or uploaded molecule) into JSmol in the ''Scene Authoring Tool''.


5. '''Copy the state script:''' Click in the top box of the Console, then Ctrl-A (Windows) or Cmd-A (Apple) to select the long script. Ctrl-C (Windows) or Cmd-C (Apple) to copy the script to the clipboard.
7. '''Exit load molecule mode''' by clicking on, for example, the ''selections'' tab. Additional options will appear below the molecule.


6. Edit the page in Proteopedia where you want to install the scene from FirstGlance in Jmol. Show the '''Scene Authoring Tool'''.
8. '''Drag''' the edited state script file and '''drop''' it into JSmol (where the molecule is displayed). Your scene should appear in a few seconds.


7. '''Load your molecule:'''
9. Use the '''save scene''' tab to save your scene. Follow the instructions there to insert a green link into the page to show your scene.
Use the '''load molecule''' tab to load your PDB code into the Jmol in the ''Scene Authoring Tool''.


8. Open the '''selections''' tab and click the '''select all''' button.
==Tweaking the Scene from FirstGlance==


9. Open the '''representations''' tab and click the '''hide selection''' button. This hides the molecule -- there will be nothing in Jmol.
[[1gpk]] was displayed in  [[FirstGlance in Jmol]].
<scene name='23/236474/Selected_hup_contacts2/1'>Selected contacts</scene> were visualized in [[FirstGlance in Jmol]] using the ''Contacts..'' and ''Hide..'' dialogs, simply by clicking on controls. The scene was transferred into Proteopedia using the above procedure.


10. Click '''Jmol''' at the lower right of Jmol, to open Jmol's menu. Click '''Console''' to open the console.
Then, in Proteopedia's [[SAT]], the <scene name='23/236474/Selected_hup_contacts2/2'>sizes of labels were reduced</scene> by clicking ''select all'', then in the ''labels'' dialog, reducing the size to 12<ref>The size of the font for distances in Ångstroms was reduced by opening the "measurements" box under the Labels tab, and selecting size 12.</ref>, changing the color to orange, and changing the offsets to 1 and 1 (all without entering any label text or clicking the ''set label'' button). Finally, <scene name='23/236474/Selected_hup_contacts2/3'>the drug was labeled</scene>.


11. '''Paste''' your state script (from the clipboard) into the bottom box of Jmol's Console, and click the '''Execute''' button. Your FirstGlance scene should appear in the ''Scene Authoring Tool's'' Jmol.  On Mac OS X, you may be unable to paste into the Console. In that case, drag the blocked script and drop it into the bottom box of the Console, the click Execute.
</StructureSection>


12. Use the '''save scene''' tab to save the copied scene. Follow the instructions there to insert a green link into the page to show your scene.
==Feedback==
If you have problems getting this to work, or suggestions to clarify this page, please email [[Image:Contact-email.png]]


==Notes==
<references />


(An example will be provided here later.)
==See Also==
*[[Help:How to Insert a ConSurf Result Into a Proteopedia Green Link]]
*[[Help:How to put a PACUPP scene into Proteopedia]]
*[http://wiki.jmol.org/index.php/Copying_and_pasting_scripts Copying and pasting scripts]

Latest revision as of 03:45, 28 July 2024

FirstGlance in Jmol makes it easy to obtain certain types of molecular scenes more easily than generating those scenes in Proteopedia's Scene Authoring Tools. This page explains how to move those scenes into Proteopedia, attaching them to a green link.

Procedure

This procedure was improved in July, 2024.

1. View the molecule in FirstGlance.

  • If the molecule has a PDB code, search for the page titled with that PDB code in Proteopedia. At that page, click on the link to FirstGlance beneath the molecule, in the Resources block.
  • Or, simply go to firstglance.jmol.org and enter the PDB code.
  • If the model does not have a PDB code (e.g. a homology model), upload the PDB file at firstglance.jmol.org.
  • If you want to color the protein by evolutionary conservation, there are two methods:

2. Obtain the desired scene in FirstGlance in Jmol. Turn off spinning (even if you want it to spin in Proteopedia), and orient and zoom the molecule as you want it to appear initially.

3. Right-click (Mac: Ctrl-click) on or near the molecule to open JSmol's menu. Select File, Save script with state. A dialog will appear in which you can choose the location on your computer's disk to save the file. Take note of the name of the file and where you are putting it. This file contains a state script of JSmol commands that will produce your scene.

4. Delete the load command. Edit the state script file with a plain text editor. Before you use the state script, you must the entire command at the end of the 3rd block of commands, and then save the file with that change. Delete everything shown below in red: the entire command beginning with "load", deleting everything up until the closing bracket "}" (keeping that closing bracket!). The load command may be long, wrapping onto several lines in your plain text editor.

function _setFileState() {

  set allowEmbeddedScripts false;
  ... blah blah blah ...
  set smartAromatic true;
  load /*file*/"http://www.rcsb.org/pdb/cgi/export.cgi/1GPK.pdb.gz";

}

5. Edit the page in Proteopedia where you want to install the scene from FirstGlance in Jmol. Show the Scene Authoring Tool.

6. Load your molecule: Use the load molecule tab to load your PDB code (or uploaded molecule) into JSmol in the Scene Authoring Tool.

7. Exit load molecule mode by clicking on, for example, the selections tab. Additional options will appear below the molecule.

8. Drag the edited state script file and drop it into JSmol (where the molecule is displayed). Your scene should appear in a few seconds.

9. Use the save scene tab to save your scene. Follow the instructions there to insert a green link into the page to show your scene.

Tweaking the Scene from FirstGlance

1gpk was displayed in FirstGlance in Jmol.

were visualized in FirstGlance in Jmol using the Contacts.. and Hide.. dialogs, simply by clicking on controls. The scene was transferred into Proteopedia using the above procedure.

Then, in Proteopedia's SAT, the by clicking select all, then in the labels dialog, reducing the size to 12[1], changing the color to orange, and changing the offsets to 1 and 1 (all without entering any label text or clicking the set label button). Finally, .


Selected contacts between an anti-Alzheimer`s drug analog and acetylcholinesterase in 1gpk. Scene generated largely and quite easily in FirstGlance in Jmol. Atoms shown as balls are within non-covalent bonding distances. Use popup to see details in this scene!

Drag the structure with the mouse to rotate

FeedbackFeedback

If you have problems getting this to work, or suggestions to clarify this page, please email

NotesNotes

  1. The size of the font for distances in Ångstroms was reduced by opening the "measurements" box under the Labels tab, and selecting size 12.

See AlsoSee Also

Proteopedia Page Contributors and Editors (what is this?)Proteopedia Page Contributors and Editors (what is this?)

Eric Martz, Wayne Decatur, Eran Hodis