Difference between revisions of "Manuals"

From Phaserwiki
Line 1: Line 1:
 
The manuals for Phaser are in four sections
 
The manuals for Phaser are in four sections
#'''Modes''': The different functions that Phaser can perform (e.g. automated MR, automated SAD). The number of modes increases as major new functionality is added.
+
;Modes
#'''Keywords''': Detailed descriptions of the keywords. The keywords change significantly between versions. We attempt to keep backwards compatibility in the use and meaning of keywords between versions but this is not always possible. The ccp4i interface must be compatible with the keywords of the phaser version run. The ccp4-style keyword and phenix-style python input functions are described on the same page (''n.b.'' the manual pages for versions prior to Phaser-2.5 describe these on separate pages).
+
: The different functions that Phaser can perform (e.g. automated MR, automated SAD). The number of modes increases as major new functionality is added.
#'''Keyword Example Scripts''': Copy and edit to start using Phaser from keyword input. These are very stable as the core functionality rarely changes.
+
;Keywords
#'''Python Example Scripts''': Copy and edit to start using Phaser from python.  These are very stable as the core functionality rarely changes.
+
: Detailed descriptions of the keywords. The keywords change significantly between versions. We attempt to keep backwards compatibility in the use and meaning of keywords between versions but this is not always possible. The ccp4i interface must be compatible with the keywords of the phaser version run. The ccp4-style keyword and phenix-style python input functions are described on the same page (''n.b.'' the manual pages for versions prior to Phaser-2.5 describe these on separate pages).
 +
;Keyword Example Scripts
 +
: Copy and edit to start using Phaser from keyword input. These are very stable as the core functionality rarely changes.
 +
;Python Example Scripts
 +
: Copy and edit to start using Phaser from python.  These are very stable as the core functionality rarely changes.
 +
 
 
The manual pages for versions prior to Phaser-2.5 also have information on XML output
 
The manual pages for versions prior to Phaser-2.5 also have information on XML output
  

Revision as of 13:54, 13 January 2015

The manuals for Phaser are in four sections

Modes
The different functions that Phaser can perform (e.g. automated MR, automated SAD). The number of modes increases as major new functionality is added.
Keywords
Detailed descriptions of the keywords. The keywords change significantly between versions. We attempt to keep backwards compatibility in the use and meaning of keywords between versions but this is not always possible. The ccp4i interface must be compatible with the keywords of the phaser version run. The ccp4-style keyword and phenix-style python input functions are described on the same page (n.b. the manual pages for versions prior to Phaser-2.5 describe these on separate pages).
Keyword Example Scripts
Copy and edit to start using Phaser from keyword input. These are very stable as the core functionality rarely changes.
Python Example Scripts
Copy and edit to start using Phaser from python. These are very stable as the core functionality rarely changes.

The manual pages for versions prior to Phaser-2.5 also have information on XML output

Currently Supported Releases

Bug.png See also: Bugs

Obsolete

Ancient

Versions older than Phaser-2.1 are located at the obsolete Phaser website