Difference between revisions of "File formats"

From Jmol
Jump to navigation Jump to search
Line 28: Line 28:
  
 
== XYZ format ==
 
== XYZ format ==
 +
Jmol reads XYZ files.
 
[http://local.wasp.uwa.edu.au/~pbourke/dataformats/xyz/ Example] by Paul Bourke.
 
[http://local.wasp.uwa.edu.au/~pbourke/dataformats/xyz/ Example] by Paul Bourke.
  
Line 34: Line 35:
  
 
== CIF format ==
 
== CIF format ==
 +
Jmol reads CIF files.
 
Crystallographic Information File, the official format from the International Union of Crystallography. [http://www.iucr.org/iucr-top/cif/standard/cifstd1.html Original documentation], Acta Cryst. (1991). A47, 655-685, and [http://www.iucr.org/iucr-top/cif/spec/version1.1/index.html 2003 update].
 
Crystallographic Information File, the official format from the International Union of Crystallography. [http://www.iucr.org/iucr-top/cif/standard/cifstd1.html Original documentation], Acta Cryst. (1991). A47, 655-685, and [http://www.iucr.org/iucr-top/cif/spec/version1.1/index.html 2003 update].
  
  
 
== mmCIF format ==
 
== mmCIF format ==
 +
Jmol reads mmCIF files.
 
Macromolecular Crystallographic Information File, an expanded format to cope with macromolecules.
 
Macromolecular Crystallographic Information File, an expanded format to cope with macromolecules.
 
[http://www.pdb.org/robohelp/ftp/files_formats/structures/chemical_component_format/chemical_component_mmcif_format.htm Official documentation].
 
[http://www.pdb.org/robohelp/ftp/files_formats/structures/chemical_component_format/chemical_component_mmcif_format.htm Official documentation].
Line 60: Line 63:
  
 
== (Hyperchem) HIV format ==
 
== (Hyperchem) HIV format ==
 +
Jmol reads HIV files.
 
[http://local.wasp.uwa.edu.au/~pbourke/dataformats/hyperchem/ Example] by Paul Bourke.
 
[http://local.wasp.uwa.edu.au/~pbourke/dataformats/hyperchem/ Example] by Paul Bourke.
  
Line 66: Line 70:
  
 
== (Tripos) Alchemy formats ==
 
== (Tripos) Alchemy formats ==
 +
Jmol reads Alchemy and Alchemy2000 files.
 
[http://local.wasp.uwa.edu.au/~pbourke/dataformats/alc/alc3/ Alchemy example] and [http://local.wasp.uwa.edu.au/~pbourke/dataformats/alc/ Alchemy2000 description] by Paul Bourke.
 
[http://local.wasp.uwa.edu.au/~pbourke/dataformats/alc/alc3/ Alchemy example] and [http://local.wasp.uwa.edu.au/~pbourke/dataformats/alc/ Alchemy2000 description] by Paul Bourke.
  
  
== Jmol Voxel (JVXL) format ==
+
== Jmol Voxel format (JVXL) ==
 
Jmol reads and writes JVXL files.
 
Jmol reads and writes JVXL files.
  
Unique to Jmol, stores isosurface data.
+
This format is unique to Jmol, stores isosurface data.
  
 
Documented at http://www.stolaf.edu/academics/chemapps/jmol/docs/misc/JVXL-format.pdf
 
Documented at http://www.stolaf.edu/academics/chemapps/jmol/docs/misc/JVXL-format.pdf

Revision as of 01:39, 3 February 2007


(An attempt to compile information on file format specifications. It's not complete yet.)

Jmol example/test data files in all formats accepted.

Chemical file formats on Wikipedia.


(MDL) MOL and SD formats

Jmol reads MOL and SD files (and can write MOL files under some circumstances).

Original from Elsevier MDL.

Official document: http://www.mdl.com/downloads/public/ctfile/ctfile.pdf, copied here.

Example files.


PDB format

Jmol reads PDB files.

(Official Protein Data Bank document) Atomic Coordinate Entry Format Description: http://www.pdb.org/pdb/file_formats/pdb/pdbguide2.2/guide2.2_frame.html

Example files.


XYZ format

Jmol reads XYZ files. Example by Paul Bourke.

Example files.


CIF format

Jmol reads CIF files. Crystallographic Information File, the official format from the International Union of Crystallography. Original documentation, Acta Cryst. (1991). A47, 655-685, and 2003 update.


mmCIF format

Jmol reads mmCIF files. Macromolecular Crystallographic Information File, an expanded format to cope with macromolecules. Official documentation.


Gaussian formats

Gaussian input, output and log example files.


(Gaussian) Cube format

Jmol reads Cube files.

Original from Gaussian software (Gaussian website).

Description of Cube Input and Cube Output formats: http://www.nersc.gov/nusers/resources/software/apps/chemistry/gaussian/g98/00000430.htm

Description by Paul Bourke.

Example files.


(Hyperchem) HIV format

Jmol reads HIV files. Example by Paul Bourke.

Example files.


(Tripos) Alchemy formats

Jmol reads Alchemy and Alchemy2000 files. Alchemy example and Alchemy2000 description by Paul Bourke.


Jmol Voxel format (JVXL)

Jmol reads and writes JVXL files.

This format is unique to Jmol, stores isosurface data.

Documented at http://www.stolaf.edu/academics/chemapps/jmol/docs/misc/JVXL-format.pdf


Script format

Jmol reads script files, using not the load command, but the script command. These are plain-text files containing commands in the Jmol/Rasmol/Chime syntax, that will modify the way the molecular model is shown. The file can have any extension.


Inline formats

Molecular data are usually contained in an external file and loaded into Jmol using the load command, but they can also be contained within the webpage (or fed into it using JavaScript or PHP, e.g. from a database).

In turn, script commands can also be contained in the molecular file.

To allow for this "inline" formats, several methods are implemented:

[Please, note that these are advanced procedures. For normal needs, they can be avoided in favour of using normal scripting practices.]

Molecular coordinates inline within a webpage

Can be done using direct instructions for the applet or, more easily, using functions in the Jmol.js library: jmolAppletInline, jmolLoadInline, jmolLoadInlineScript.

Molecular coordinates inline within a script or script file

Can be done using the data "model" command (Jmol 11 only).

Script inline within a molecular coordinates file

Scripts can be included after a #jmolscript: tag (case-sensitive). This must be taken as a comment by the molecular file parser, so its location depends on the file format:

  • In a PDB file, use REMARK #jmolscript: in any line, followed by the script commands in the same line.
  • In a MOL file, use #jmolscript: in the third line, followed by the script commands in the same line. Note, however, that # cannot be the first character on that line, so use an initial space if nothing else.
  • In an XYZ file, use #jmolscript: in the second line, followed by the script commands in the same line.

In all cases, the script will be applied after the whole molecule has loaded.