View source for Jmol

Jmol<ref>Jmol was initiated before 2000 by [http://openscience.org Dan Gezelter], and many programmers contributed to it including Bradley A. Smith, Egon Willighagen, and Cristoph Steinbeck. In 2002, Miguel Howard volunteered as the primary developer. He made many major enhancements including drastically improved performance, support for macromolecules, and implementation of the [[RasMol]] / [[Chime]] script command language. Howard's work culminated in the release of an open-source replacement for [[Chime]] in 2006. Subsequently, [http://www.stolaf.edu/people/hansonr/ Robert M. Hanson] became lead developer, and has vastly enhanced Jmol's capabilities. For more, see [http://jmol.sourceforge.net/history/ History of Jmol Development].</ref><ref>Biomolecules in the computer: Jmol to the rescue. Angel Herráez,[http://www3.interscience.wiley.com/journal/113449000/abstract  ''Biochem. Mol. Biol. Ed.'' '''34''':255-61, 2006].</ref><ref name="jmolparadigmshift" /><ref>[http://wiki.jmol.org:81/index.php/Literature Jmol Literature] at the Jmol.Org wiki.</ref> is a free, open-source [[Molecular modeling and visualization software|molecular visualization]] software package. It is the primary visualization software used in Proteopedia. Jmol is a [http://en.wikipedia.org/wiki/Cross-platform cross-platform] program written in [[Java]], but able to run in an HTML5/Javascript-mode called &quot;'''JSmol'''&quot;<ref>Hanson, RH, Prilusky, J,  Renjian, Z, Nakane, T & Sussman, JL. JSmol and the Next-Generation Web-Based Representation of 3D Molecular Structure as Applied to Proteopedia [http://onlinelibrary.wiley.com/doi/10.1002/ijch.201300024  ''Israel Journal of Chemistry'' '''33''':207-16, 2013]</ref> that does not require [[Java]]. Jmol is also available as a stand-alone [[Jmol/Application|application]]. See [[#Jmol Has Four Forms|2 forms of Jmol]] and [[How JSmol Works]]. An overview of other Jmol resources is at [[Jmol/Index]].

'''JSmol''' has proven quite satisfactory for interactive displays of most macromolecules in Proteopedia, and is the default.
<!-- COMMENTED OUT BY ERIC MARTZ 2023.11.07
This avoids the need for Protepedia users to [[Installing_and_enabling_Java|install and enable Java]]. The Java applet Jmol [[User:Eric_Martz/JSmol_Notes#JSmol_is_slower_than_Jmol|performs much faster]], but this enhanced performance is not needed unless the model contains >~30,000 atoms, or multiple larger models (see [[NMR]]).
-->

For very large assemblies, the [[Molstar|Mol*]] ([[Molstar]]) viewer is used instead of JSmol (example: [[6mx4]]).
<!--
Should you wish to try the Java applet, see [[Using Java for Rendering Structures]]. [[Java]], particularly in web browsers, may be a [[Java#Java is a security threat|security risk]], and some [[Java#How to be as safe as possible with Java|simple precautions are recommended]]. -->

For more information and downloads: [[#See Also|See Also]].

==Jmol Has Two Forms==
Originally, Jmol had 4 forms. Two (Java applets, signed and unsigned) are now obsolete.
<center><table border="1" cellpadding="5">
<tr>
   <td>
Form
   </td>
   <td>
[[Java]]?
   </td>
   <td>
Performance
   </td>
   <td>
Examples
   </td>

<tr>
   <td>
<font color="orange"><b>JSmol</b></font> (in web browser)
   </td>
   <td>
No (HTML5).<br>Runs on tablets and smart phones as well as laptop computers.
   </td>
   <td>
Slower, especially if >30,000 atoms or
multiple models, but with patience, can handle up to a million atoms.
   </td>
   <td>
Recently updated websites:
Proteopedia, [[FirstGlance in Jmol]], [http://molviz.org MolviZ.Org],
most of [http://biomodel.uah.es/en/ Biomodel].
   </td>

<!-- COMMENTED OUT BY ERIC MARTZ 2023.11.07
<tr>
   <td>
OBSOLETE <font color="red"><b>Jmol_S</b></font> (in web browser)
   </td>
   <td>
{{font color|gray|Yes: signed applet}}
   </td>
   <td>
Faster; Good with >30,000 atoms, multiple models.
   </td>
   <td>
As of mid-2017, [[Installing and enabling Java|popular web browsers no longer support Java]].
Optional: see [[Using_Java_for_Rendering_Structures#Java-mode:_setting_a_preference_to_use_Jmol_S_.28Java.29_automatically_for_rendering_structures_in_Proteopedia|Preferences in Proteopedia]] (requires account/login). Proteopedia will use [[Using_Java_for_Rendering_Structures|Java on a page by page basis]] when "?use=java" is added at the end of the address (URL). The Jmol Java applet is no longer supported by [[FirstGlance in Jmol]].
   </td>

<tr>
   <td>
<font color="gray"><b>Jmol</b></font> (in web browser)
   </td>
   <td>
Yes: unsigned applet
   </td>
   <td>
Faster but [http://en.wikipedia.org/wiki/Deprecation deprecated]. Requires a [[Installing_and_enabling_Java#Enable_Unsigned_Java_Applets|Java Exception]].
   </td>
   <td>
Older legacy websites that have not been updated. These will no longer operate in popular web browsers, which by mid-2017 [[Installing and enabling Java|no longer support Java]].
   </td>
-->
<tr>
   <td>
Jmol.jar application (stand alone; not in web browser)
   </td>
   <td>
Yes, Java is required.
   </td>
   <td>
Faster; Good with >30,000 atoms, multiple models.
   </td>
   <td>
Advanced use (usually with [http://chemapps.stolaf.edu/jmol/docs/ Jmol command language]).
[http://firstglance.jmol.org/animation_kit_instructions.pdf Animation Kit of FirstGlance]. 
[http://molviz.org/pacupp PACUPP]: Pockets And Cavities Using Pseudoatoms in Proteins.
   </td>


</tr>
</table>
Both forms of Jmol can be downloaded in a single package from [http://jmol.org Jmol.Org].
</center>

==Use in Scientific Journals==

Jmol is used in traditional scientific journals in three main ways.
<ol>

<li>'''[[Interactive_3D_Complement_in_Proteopedia|Interactive 3D Complement]]''' pages in Proteopedia. Authors of scientific journal publications, working in collaboration with a dedicated team in Proteopedia, develop rich interactive pages that complement their journal paper, making its structural aspects more comprehensible to a wider audience. See examples at [[Interactive_3D_Complement_in_Proteopedia|Interactive 3D Complements]].

<li>
'''Interactive 3D figures.''' Following the lead set by [[Kinemages, Mage and KiNG|Protein Science with Kinemages in the early 1990's]], figures in scientific journal articles have been implemented in Jmol so they can be rotated, etc. This involves manual implementation of each figure, a laborious task requiring a person knowledgeable in Jmol programming. Probably the first instance was in November, 2006, in [http://pubs.acs.org/journal/acbcct ACS Chemical Biology], and subsequently in June, 2007, in [http://biochemj.org Biochemical Journal] with interactive 3D figures in Jmol implemented by Frieda Reichsman. Authoring of these interactive 3D figures remains time consuming, and only about a dozen articles have been so illustrated as of early 2010  (listed at Reichsman's site [http://moleculesinmotion.com MoleculesInMotion.Com]). In 2008, the International Union of Crystallography developed a toolkit to facilitate the authoring of interactive figures in Jmol in their journals<ref>PMID: 19461848</ref>. Outstanding examples are in the 2010 article by Robert M. Hanson (principal author of Jmol after 2005) <i>Jmol – a paradigm shift in crystallographic visualization</i><ref name="jmolparadigmshift">Hanson, R. M. Jmol – a paradigm shift in crystallographic visualization. <i>J. Appl. Crystallography</i> 43 (2010). Open Access [http://dx.doi.org/10.1107/S0021889810030256 doi:10.1107/S0021889810030256]</ref>, as well as in a talk given by him in early 2011 at the ICSTI Workshop <ref>Robert Hanson's talk is about 37 minutes in at the [http://research.microsoft.com/apps/video/default.aspx?id=145181&l=i International Council for Scientific and Technical Information 2011 Workshop "Multimedia & Visualization for Science", @ Microsoft Research, Redmond, WA Feb. 8 2011]</ref>. In  2009, [http://www.proteinscience.org/view/0/editorMessage.html Protein Science began using this technology]<ref>A. G. Palmer and B. W. Matthews, [http://www.proteinscience.org/details/journalArticle/174315/Interactive_graphics_return_to_protein_science.html Interactive graphics return to protein science], Protein Science 18:677 (2009).</ref>.

</li><li>
'''[[FirstGlance in Jmol]]''' is used by several journals for interactive 3D display and exploration of newly published macromolecular structures. Typically, a link labeled ''3D View'' appears in the online journal articles and contents. The first journal to do this was [http://nature.com/nsmb Nature Structural and Molecular Biology] in [http://www.nature.com/nsmb/journal/v13/n2/index.html February, 2006], and others, including [http://nature.com/nature Nature], soon followed -- see [http://firstglance.jmol.org/adoption.htm Adoptions of FirstGlance in Jmol].
</li>
</ol>

See also:
*[[Proteopedia:Supplementary materials]]
* [http://wiki.jmol.org/index.php?title=Journals_Using_Jmol Journals using Jmol].

==Command Scripting Language==
Jmol has an extensive and powerful command language<ref name="jmol-commands">Documentation for Jmol's command language is available from [http://jmol.org Jmol.Org]. An overview is at [http://jmol.sourceforge.net/docs/ jmol.org/docs], and additional coverage of specific topics is at the [http://wiki.jmol.org Jmol Wiki]. The command reference manual is at [http://chemapps.stolaf.edu/jmol/docs/ chemapps.stolaf.edu/jmol/docs/].</ref> that specifies molecular scenes. A molecular scene consists of the rendering or display for each part of the molecular model (e.g. ribbon cartoon, ball and stick, etc.), optionally hiding some parts of the model, the color or color scheme for each moiety, optional labels (attached to an atom) or signs (text in fixed locations), and the orientation and zoom (magnification) of the molecule. Jmol's command language is a superset of the [[RasMol]] and [[Chime]] command languages.

A '''command script''' or simply '''script''' is a series of commands recorded in a file. Script files are [[plain text]], and their filenames end with '''.spt'''.

Proteopedia's [[SAT|Scene Authoring Tools]] free Proteopedia users from the burden of learning Jmol's command language, by enabling them to author complex molecular scenes from menus, buttons, checkboxes and forms. Further, Proteopedia saves customized molecular scenes in the form of '''state scripts'''.

For advanced users who wish to use Jmol commands, instructions are provided:
*[[Scene_authoring_tools#Using_Jmol.27s_Command_Language|Using Jmol commands in the '''applet''']]
*[[Jmol/Application|Using Jmol commands in the '''application''']]

==State Scripts==
Jmol has the capability to generate a command script that will recreate whatever molecular scene it is currently displaying, including all details and the orientation of the molecule. Proteopedia uses this capability to save scenes created with its [[SAT|Scene Authoring Tools]] so they can be displayed in its web pages and thereby easily shared.

A state script recreates a '''single''' molecular scene, possibly including an ''animation'' among multiple models (when the [[PDB file]] contains more than one model -- see [[Morphs]]). Each green link in Proteopedia runs a state script in Jmol, recreating a single scene.

==Complex Animations==
In addition to the straightforward animations and/or [[Morphs]] which were mentioned in the previous paragraph and that can be specified in the [[Scene authoring tools]], more complex animations, typically involving timed transitions between multiple scenes, can also be played in Proteopedia. Examples are may be seen at [[Molecular Playground/Tamiflu]] and [[Molecular Playground/HIV Protease Inhibitor]]. Command scripts for complex animations must be authored by hand by someone familiar with Jmol's command language. The resulting script file(s) are then uploaded to Proteopedia. Uploaded scripts are not played by typical green scene links, but can be played from buttons (see the above-linked examples) or text linked to the script that looks like the typical Proteopedia green scene links, as described [[Demonstration of a complex animation playing from a green link|here]].

<!--- OBSOLETE, COMMENTED OUT BY ERIC MARTZ DECEMBER 2025. NO WEB BROWSERS STILL ENABLE JAVA APPLETS.
==Distinguishing if Jmol is running in HTML5/Javascript-mode or Java-mode==
Jmol is the primary visualization software used in Proteopedia. Jmol is a [http://en.wikipedia.org/wiki/Cross-platform cross-platform] program written in [[Java]], but able to run in an HTML/Javascript-mode that does not require [[Java]].  The HTML/Javascript mode is presently the default on Proteopedia as it runs on more platforms.
'''At this time, Jmol still performs best in Java mode and users are encouraged to use that on Proteoepdia.''' See [[Using Java for Rendering Structures|here]] for how to opt in to Java mode.

You can easily distinguish which mode Jmol is presently running in by looking in the bottom right corner. You'll see <font color="maroon">Jmol_S</font> in the bottom right corner of the Proteopedia structure scene windows when Jmol is running with the signed Java applet. You'll see <font color="gold">JSmol</font> in the bottom right corner of structure windows when Jmol is operating in HTML/Javascript mode. A visual representation of that can be seen [[Distinguishing the modes of Jmol on Proteopedia|here]].
-->

==What version of Jmol is running?==
The version of Jmol currently running in Proteopedia is reported in the line ''JmolExtension'' at [[Special:Version]] in the column ''(now loaded Jmol version .....)''.

==Loading Pages with Custom Versions of the Jmol applet==
Advanced users may wish to load a Proteopedia page with a version of the Jmol applet other than the currently used version. This works best when Jmol comes from the Proteopedia.Org server, in which case both the unsigned and signed applets work. Testing new versions of the Jmol applet in Proteopedia, or running the signed applet in order to save an image file in the local drive, would involve running such custom versions. 

To load a page with a custom version of the Jmol applet, in your browser's address bar, immediately after the normal Proteopedia page URL, paste code that is similar to below pointing at the files for the chosen version of the Jmol applet. The normal Proteopedia page URL in this example is '<nowiki>http://proteopedia.org/wiki/index.php/1stp</nowiki>'.


EXAMPLE CODE TO PASTE AFTER A TYPICAL PROTEOPEDIA PAGE URL IN THE ADDRESS BAR:
<pre>?JMOLJAR=http://proteopedia.org/jmol12.2.16/JmolAppletSigned0.jar</pre>

Resulting example of the URL in your browser's address bar of:
<pre>http://proteopedia.org/wiki/index.php/1stp?JMOLJAR=http://proteopedia.org/jmol12.2.16/JmolAppletSigned0.jar</pre>

Please note that although URLs, such as '<nowiki>http://www.proteopedia.org/wiki/index.php/1stp</nowiki>', will work to load a normal Proteopedia page, '''you cannot have 'www.' in front of 'proteopedia.org' for URLs where you want to load custom Jmol versions'''.

==Available previous Jmol versions==
Proteopedia used Jmol 11.8.24 until March 25, 2012, when it was upgraded to 12.2.19.
<pre>
?JMOLJAR=http://proteopedia.org/old/11.8.24/JmolAppletSigned0.jar
?JMOLJAR=http://proteopedia.org/old/11.8.24/JmolApplet0.jar

?JMOLJAR=http://proteopedia.org/old/12.2.19/JmolAppletSigned0.jar
?JMOLJAR=http://proteopedia.org/old/12.3.20/JmolAppletSigned0.jar
?JMOLJAR=http://proteopedia.org/old/12.3.22/JmolAppletSigned0.jar
?JMOLJAR=http://proteopedia.org/old/13.0.1/JmolAppletSigned0.jar
</pre>
Versions of Jmol in use by Proteopedia at various dates (incomplete list):
*April 23, 2008: Using 11.5.24
*May 7, 2008: Upgraded to 11.5.35
*October, 2009: Using 11.6.14
*October 21, 2009: Upgrade to 11.8.7 then reverted to 11.6.14
*Nov 12, 2009: Upgraded to 11.8.9
*March 21, 2012: Upgraded to 12.2.19_dev
*April 17, 2012: Upgraded to 12.3.22
*June 27, 2012: Upgraded to 12.3.32
*August 23, 2012: Upgraded to 13.0.1
*January 26, 2014: Upgraded to 14.0.7 - Proteopedia upgraded to using a version of Jmol  that allows two modes. Proteopedia defaults to run Jmol in an HTML5/Javascript-mode not requiring [[Java]], but users can optionally use Jmol running as a signed Java applet. See [[Using Java for Rendering Structures|here]] for how to opt in to Java mode.
* June 23, 2016: Upgraded to 14.6.0
* February 20, 2017: Upgraded to 14.9.1
* January 25, 2018: Upgraded to 14.28.4
* ??: Upgraded to 14.29.16

The version of Jmol currently running in Proteopedia is reported in the line ''JmolExtension'' at [[Special:Version]] in the column ''(now loaded Jmol version .....)''

==See Also==
*[[Jmol/Index]], a list of Jmol resources.
*[[How JSmol Works]] (Minimally technical.)
*[http://jmol.org Jmol.Org]: Download all forms of Jmol here. Wiki has lots of documentation.
*[http://en.wikipedia.org/wiki/Jmol Jmol at Wikipedia]
*[[FirstGlance in Jmol]]
*Using JSmol: [[User:Eric_Martz/JSmol_Notes]]
*[[Jmol/Visualizing large molecules]]
*[[Jmol/Application]]: How to use the Jmol application.
*[[Jmol/Synchronization]] of two or more molecules so they rotate and zoom together.
*[[Scene authoring tools]]
*[http://wiki.jmol.org/index.php?title=Journals_Using_Jmol Journals Using Jmol]
*[[Proteopedia:Supplementary materials]]
*[[Molecular modeling and visualization software]]
*[https://chemapps.stolaf.edu/jmol/docs/ Jmol Script Command Reference Manual] for advanced users. Proteopedia's [[Scene authoring tools]] make learning this language unnecessary for most Proteopedia users.

* [[Molstar]] (Mol*), an alternative to JSmol in Proteopedia. Molstar is especially suited to very large molecules.

==References==
<references />