Phaser: Manual - Revision history

Airlie at 12:37, 9 March 2018

2018-03-09T12:37:14Z

Airlie at 10:39, 9 March 2018

2018-03-09T10:39:26Z

Airlie: Clear page ready for autogen wiki tests

2018-03-09T09:54:59Z

Clear page ready for autogen wiki tests

Airlie at 13:59, 11 December 2013

2013-12-11T13:59:17Z

Airlie at 13:05, 25 October 2013

2013-10-25T13:05:56Z

Airlie at 15:44, 10 April 2013

2013-04-10T15:44:00Z

Airlie at 14:39, 22 January 2013

2013-01-22T14:39:23Z

Airlie at 10:30, 4 October 2012

2012-10-04T10:30:49Z

Airlie: moved Phaser: Manual to Phaser-2.5.1: Manual

2012-10-04T10:30:12Z

moved Phaser: Manual to Phaser-2.5.1: Manual

New page

#REDIRECT [[Phaser-2.5.1: Manual]]

← Older revision		Revision as of 12:37, 9 March 2018
Line 26:		Line 26:

	Phaser can be compiled as a python library. The python interface takes a phaser keyword string as input.		Phaser can be compiled as a python library. The python interface takes a phaser keyword string as input.
−
−
−
−
−
−	~~==Basic Keywords==~~
−	~~===[[Image:User1.gif\|link=]]ATOM===~~
−
−
−
−
−	~~==Output Control Keywords==~~
−	~~===[[Image:Output.png\|link=]]DEBUG===~~
−	~~; DEBUG [ON\|OFF]~~
−	~~: Extra verbose output for debugging~~
−	* Default: DEBUG OFF
−
−	~~==Advanced Keywords==~~
−	~~===[[Image:User2.gif\|link=]]ELLG===~~
−	~~; ELLG TARGET <TARGET>~~
−	~~: Target value for expected LLG for determining resolution limits and search order~~
−	~~<!--; ELLG HIRES <HIRES> Internal control only-->~~
−	* Default: ELLG TARGET 225
−
−
−
−
−	~~==Expert Keywords==~~
−
−	~~===[[Image:Expert.gif\|link=]]MACANO===~~
−	~~; MACANO PROTOCOL [DEFAULT\|CUSTOM\|OFF\|ALL]~~
−	~~: Protocol for the refinement of SigmaN in the anisotropy correction~~
−	~~; MACANO ANISO [ON\|OFF] BINS [ON\|OFF] SOLK [ON\|OFF] SOLB [ON\|OFF] ''{NCYCle <NCYC>} {MINIMIZER [BFGS\|NEWTON\|DESCENT]}''~~
−	~~: Macrocycle for the custom refinement of SigmaN in the anisotropy correction. Macrocycles are performed in the order in which they are entered.~~
−	* Default: MACANO PROTOCOL DEFAULT
−
−
−
−	~~==Developer Keywords==~~
−	~~===[[Image:Developer.gif\|link=]]BINS===~~
−	~~; BINS DATA [ <sup>1</sup>MIN <L> \| <sup>2</sup>MAX <H> \| <sup>3</sup>WIDTH <W> ]~~
−	~~: The binning of the data.~~
−	~~: <sup>1</sup> L = minimum number of bins~~
−	~~: <sup>2</sup> H = maximum number of bins.~~
−	~~: <sup>3</sup> W = width of the bins in number of reflections~~

← Older revision	Revision as of 10:39, 9 March 2018
Line 1:	Line 1:
	+	<div style="margin-left: 25px; float: right;">__TOC__</div>

	+	===Phaser Executable===
	+
	+	The Phaser executable runs in different modes, which perform Phaser's different functionalities. The mode is selected with the [[#MODE \| MODE]] keyword. The different modes and the keywords relevant to each mode are described in [[Modes]].
	+
	+	Most keywords only refer to a single parameter, and if used multiple times, the parameter will take the last value input. However, some keywords are meaningful when entered multiple times. The order may or may not be important.
	+
	+	*[[Image:User1.gif\|link=]] [[#Basic Keywords \| Basic Keywords]]
	+
	+	*[[Image:Output.png\|link=]] [[#Output Control Keywords \| Output Control Keywords]]
	+
	+	*[[Image:User2.gif\|link=]] [[#Advanced Keywords \|Advanced Keywords ]]
	+
	+	*[[Image:Expert.gif\|link=]] [[#Expert Keywords \| Expert Keywords]]
	+
	+	*[[Image:Developer.gif\|link=]] [[#Developer Keywords \| Developer Keywords]]
	+
	+	str string
	+	int integer
	+	float double precision floating point
	+	dvect3 array of 3 doubles
	+
	+
	+	===Python Interface===
	+
	+	Phaser can be compiled as a python library. The python interface takes a phaser keyword string as input.
	+
	+
	+
	+
	+
	+	==Basic Keywords==
	+	===[[Image:User1.gif\|link=]]ATOM===
	+
	+
	+
	+
	+	==Output Control Keywords==
	+	===[[Image:Output.png\|link=]]DEBUG===
	+	; DEBUG [ON\|OFF]
	+	: Extra verbose output for debugging
	+	* Default: DEBUG OFF
	+
	+	==Advanced Keywords==
	+	===[[Image:User2.gif\|link=]]ELLG===
	+	; ELLG TARGET <TARGET>
	+	: Target value for expected LLG for determining resolution limits and search order
	+	<!--; ELLG HIRES <HIRES> Internal control only-->
	+	* Default: ELLG TARGET 225
	+
	+
	+
	+
	+	==Expert Keywords==
	+
	+	===[[Image:Expert.gif\|link=]]MACANO===
	+	; MACANO PROTOCOL [DEFAULT\|CUSTOM\|OFF\|ALL]
	+	: Protocol for the refinement of SigmaN in the anisotropy correction
	+	; MACANO ANISO [ON\|OFF] BINS [ON\|OFF] SOLK [ON\|OFF] SOLB [ON\|OFF] ''{NCYCle <NCYC>} {MINIMIZER [BFGS\|NEWTON\|DESCENT]}''
	+	: Macrocycle for the custom refinement of SigmaN in the anisotropy correction. Macrocycles are performed in the order in which they are entered.
	+	* Default: MACANO PROTOCOL DEFAULT
	+
	+
	+
	+	==Developer Keywords==
	+	===[[Image:Developer.gif\|link=]]BINS===
	+	; BINS DATA [ <sup>1</sup>MIN <L> \| <sup>2</sup>MAX <H> \| <sup>3</sup>WIDTH <W> ]
	+	: The binning of the data.
	+	: <sup>1</sup> L = minimum number of bins
	+	: <sup>2</sup> H = maximum number of bins.
	+	: <sup>3</sup> W = width of the bins in number of reflections

← Older revision		Revision as of 09:54, 9 March 2018
Line 1:		Line 1:
−	~~<div style="margin-left: 25px; float: right;">__NOTOC__</div>~~

−	~~This is the documentation for Phaser–2.5.4. There are some changes between this version and previous versions so input scripts may need editing.~~
−
−	~~; [[ Modes \| Modes]]~~
−	~~: The different functions that Phaser can perform and the keywords relevant for each mode~~
−	~~; [[Keywords \| Keywords]]~~
−	~~: Detailed descriptions of the keywords~~
−	~~; [[Keyword Example Scripts \| Keyword Example Scripts]]~~
−	~~: Copy and edit to start using Phaser from keyword input~~
−	~~; [[Python Example Scripts \| Python Example Scripts ]]~~
−	~~: Copy and edit to start using Phaser from python~~
−	~~; [[Error Codes \| Error Codes]]~~
−	~~: Meanings of the return integer error codes from phaser~~

← Older revision		Revision as of 13:59, 11 December 2013
Line 11:		Line 11:
	; [[Python Example Scripts \| Python Example Scripts ]]		; [[Python Example Scripts \| Python Example Scripts ]]
	: Copy and edit to start using Phaser from python		: Copy and edit to start using Phaser from python
		+	; [[Error Codes \| Error Codes]]
		+	: Meanings of the return integer error codes from phaser

@@ Line 1: / Line 1: @@
 <div style="margin-left: 25px; float: right;">__NOTOC__</div>
-This is the documentation for Phaser&#8211;2.5.3. There are some changes between this version and previous versions so input scripts may need editing.
+This is the documentation for Phaser&#8211;2.5.4. There are some changes between this version and previous versions so input scripts may need editing.
 ; [[ Modes | Modes]]

@@ Line 3: / Line 3: @@
 This is the documentation for Phaser&#8211;2.5.3. There are some changes between this version and previous versions so input scripts may need editing.
-;[[ Modes | Modes]]
+; [[ Modes | Modes]]
 : The different functions that Phaser can perform and the keywords relevant for each mode
 ; [[Keywords | Keywords]]

← Older revision		Revision as of 10:30, 4 October 2012
Line 1:		Line 1:
−	#~~REDIRECT [[Phaser-~~2.5.1: ~~Manual~~]]	+	<div style="margin-left: 25px; float: right;">__NOTOC__</div>
		+
		+	This is the documentation for Phaser–2.5.2. There are some changes between this version and previous versions so input scripts may need editing.
		+
		+	;[[ Modes \| Modes]]
		+	: The different functions that Phaser can perform and the keywords relevant for each mode
		+	; [[Keywords \| Keywords]]
		+	: Detailed descriptions of the keywords
		+	; [[Keyword Example Scripts \| Keyword Example Scripts]]
		+	: Copy and edit to start using Phaser from keyword input
		+	; [[Python Example Scripts \| Python Example Scripts ]]
		+	: Copy and edit to start using Phaser from python