Files Description/Jmol 12
This applies to Jmol versions before 13.2
For the current file set, see Files Description.
The Jmol distribution is available for download as 3 different files:
- jmol-x.x.x-binary.zip contains all files needed for using Jmol, compressed using the
- jmol-x.x.x-binary.tar.gz contains the same files, in a
tarstructure and compressed using the
- jmol-x.x.x-full.tar.gz contains the full source code. This will only be useful to developers and programmers wanting to study Jmol programming design or to modify Jmol.
Following is a description of the files contained in any of the first two downloadable files.
Files with information
The copyright explanations regarding Jmol and its 3rd-party components.
The GNU Lesser General Public License, under which Jmol is released.
A general description of Jmol package and sources of information, including this file list documentation.
The Spanish version of README.txt
A list with a history of the feature additions in each version of Jmol.
Instructions about using the ChemDoodle alternative together with Jmol applets, and about the license for ChemDoodle (which is different from the Jmol license).
Batch and shell files
These can be used to start Jmol application from a command line and, particularly, to impose a certain combination of parameters (see command line options).
???? (Some kind of batch file)
A batch file to start Jmol application under Windows.
??? (Some kind of batch file)
A shell script to start Jmol application under Unix-like systems, like Linux, BSD, Solaris and Cygwin for Windows.
sh jmol.sh // start Jmol under the jmol-xxx folder sh yourpath/jmol-xxx/jmol.sh // start Jmol from anywhere
chmod +x jmol.sh // make the jmol.sh script executable jmol.sh // start Jmol inside the jmol-xxx directory, or yourpath/jmol-xxx/jmol.sh // start Jmol anywhere
chmod +x jmol.sh // make the jmol.sh script executable ln -s yourpath/jmol-xxx/jmol.sh /usr/local/bin/jmol.sh //create a symbolic link under /usr/local/bin
Reboot your computer or execute
jmol.sh // start Jmol anywhere
chmod +x jmol.sh // make the jmol.sh script executable ln -s /usr/bin/jmol-xxx/jmol.sh /usr/bin/jmol.sh // or ln -s /usr/bin/jmol-xxx/jmol.sh /usr/local/bin/jmol.sh // or ln -s /usr/local/bin/jmol-xxx/jmol.sh /usr/bin/jmol.sh //or ln -s /usr/local/bin/jmol-xxx/jmol.sh /usr/local/bin/jmol.sh jmol.sh // start Jmol from anywhere
Files of Jmol application
This is used as a standalone program.
The application executable file (a program written in Java). This works as any other program: opens in its own window, can be resized or minimized, admits drag-and-drop of files over it, has a top menu bar, can open and save files, etc. It can be open from the command line (particulary, using the shell or batch files described above), but if Java is properly configured in your system, it's usually enough to double-click on the file (see Starting Jmol Application for more details).
This is a slimmed down version of Jmol.jar that lacks all visualization capabilities. So, it betrays the whole (classic) concept of what Jmol is, but with JmolData and some clever scripting you can get just about any information you want out of a model and output it any way you want.
It operates only from the command line, designed for extracting data from a model or set of models. You are limited to commands that don't have to do with visualization: there are bonds but no "sticks", atoms but no "dots", helices but no "cartoons".
Files of Jmol applet
These are used inside web pages, and include:
- Applet files
The applet, i.e. a version of the program that will only run when embedded in a web page.
The applet is divided up into several pieces according to their function, so that if a page does not require a component, that component is not downloaded from the server. It is still recommended that you put all JmolApplet0*.jar files on your server even if your page does not use the capabilities provided by some of the files, because the pop-up menu and Jmol console both allow users to access parts of Jmol you might not have considered.
This split version is the one that will be used by default if you use Jmol.js (which is the recommended method). For that, use the simplest form of jmolInitialize(), just indicating the directory or folder containing the set of jar files:
jmolInitialize(".") // jar files are in the same folder as the web page jmolInitialize("../jmol") // jar files are in a parallel folder, named 'jmol'.
An equivalent version of the applet, but this is a "signed" applet (a term in Java security language). This means it must be authorized by the web page visitor for it to run, but then it will have less security restrictions for file access. For example, it can access files on any part of the user's hard disk or from any other web server.
Typically users get a message asking if they want to accept the "certificate" or if they "trust" the applet (see notes below). JmolAppletSigned.jar should be used with this in mind. Other than reading files, Jmol does not currently use other capabilities of signed applets, such as accessing the system clipboard or writing files. Use only if you know what you are doing and have considered the security issues.
To use this with Jmol.js, use the form:
- The security feature requesting to trust the applet may not always be enabled on users' systems.
- The message requesting permission will be displayed for each of the 14 (or more) loadable files.
- The user may have the option to trust the applet permanently and so avoid having to give permission every time (s)he visits a page that uses Jmol.
This is an all-in-one or monolithic file, kept mainly for compatibility with old pages that call it explicitly. This single file is equivalent to the whole set of JmolApplet0*.jar files, explained above. The recommended procedure is not to use this monolithic file, but the split version (JmolApplet0.jar etc.). In particular, Jmol.js uses the split version by default.
You may wish to use this if you want to keep your website simple or you just want to upload a single jar file whenever new versions are released. However, this will load Jmol slower than the split versions (described above), as all the modules (adding up to 2.4 MB), needed or not, must get loaded onto a user's machine before any structure is displayed.
To invoke JmolApplet.jar from Jmol.js, either:
a) put it in the directory containing the HTML page requiring it and do not use jmolInitialize(),
b) identify it explicitly in jmolInitialize(), for example:
An equivalent version of the monolithic applet, but this is a "signed" applet (a term in Java security language). This means it must be authorized by the web page visitor for it to run, but then it will have less security restrictions for file access. For example, it can access files on any part of the user's hard disk or from any other web server.
Typically users get a message asking if they want to accept the "certificate" or if they "trust" the applet, but this security feature is not always enabled. JmolAppletSigned.jar should be used with this in mind. Other than reading files, Jmol does not currently utilize other capabilities of signed applets, such as accessing the System clipboard or writing files. Use only if you know what you are doing and have considered the security issues.
To invoke JmolAppletSigned.jar from Jmol.js, use:
- Given the descriptions, you will realize that the distribution package contains 4 full copies of the applet (signed or unsigned, split or not).
- Note: if you have downloaded Jmol version 13.2 or later, this file is not included. You can either copy it from a former Jmol version or get it from the Jmol repository.
This library uses by default the split version of the applet (unsigned or signed).
Fully documented at http://jmol.org/jslibrary/
Creates the object for a Jmol applet.
Contains functions that make the Jmol applets work but are not to be used by the webpage author (private functions).
Support for user-interface controls like buttons, links, checkboxes, etc.
Contains the Application Programming Interface, that is, functions that may be used by the webpage author to interface with the Jmol applets.
Provides the means for adding a JME applet in the webpage (drawing of 2D chemical formulas) and communicate with Jmol applets.
Provides the means for adding a JSpecView applet (viewer for spectral data) in the webpage and communicate with Jmol applets.
Files specific to older versions
Versions before Jmol 11.1.30 had a different setup for the split applet files:
JmolApplet_i18n.jar is the localization module of the applet (i.e., translation of the interface into several languages). This must accompany the JmolApplet#.jar set if you want the interface in a language different from English. (The language shown will depend on the operating system's language.)
The signed version of the above split applet. (See JmolAppletSigned0.jar above for description of what a "signed" applet is.)
Accessory apps and applets
Undocumented and experimental.
An application to convert Chime-using html pages into pages with JmolApplets.
Unsigned and signed versions of the JSpecView applet, a viewer for spectral data that may be intercommunicated with Jmol applets. (see supporting .js file above)
This is currently not included in the distribution, but may be obtained from the development site.
This is a lightweight applet, with no visible interface, that allows to check SMILES strings. This is particularly useful for comparison of stereochemistry, for example from structures drawn using the JME applet.
The same functionality is included in the regular JmolApplet.