PropertiesFile.rst 15.2 KB
Newer Older
1
2
.. _Properties File:

3
Properties File
4
5
===============

6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
The two .Properties Files
-------------------------

The Mantid framework is configured using two simple text .properties files that are read an interpreted every time the framework is started. These properties are not the same as the properties of algorithms.

Mantid.Properties
*****************

This file defines the default configuration that the development team suggest as sensible defaults. This file should not be altered by users as it will be replaced with every new install or upgrade of Mantid.

Mantid.User.Properties
**********************

This is where users may override any property setting in Mantid. Any Property setting in this file will override anything set in the Mantid.Properties file. Simply either enter the property you wish to override in this file together with it's new value. The change will take effect the next time Mantid is started. Subsequent installs or upgrades of Mantid will never alter this file.

The Properties
--------------

Note: Use forward slash (/) or double up on the number of backslash (\) characters for all paths

General properties
******************

+------------------------------+---------------------------------------------------+-------------+
|Property                      |Description                                        |Example value|
+==============================+===================================================+=============+
|algorithms.retained           |The Number of algorithms properties to retain in   | 50          |
|                              |memory for refence in scripts.                     |             |
+------------------------------+---------------------------------------------------+-------------+
|algorithms.categories.hidden  |A comma separated list of any categories of        | Mouns, Test |
|                              |algorithms that should be hidden in Mantid.        | Category    |
+------------------------------+---------------------------------------------------+-------------+
|MultiThreaded.MaxCores        |Sets the maximum number of cores available to be   | 0           |
|                              |used for threads for OpenMP. If zero it will use   |             |
|                              |one thread per logical core available.             |             |
+------------------------------+---------------------------------------------------+-------------+

Facility and instrument properties
**********************************

+------------------------------+---------------------------------------------------+-------------+
|Property                      |Description                                        |Example value|
+==============================+===================================================+=============+
|default.facility              |The name of the default facility. The facility must| ISIS        |
|                              |be defined within the facilites.xml file to be     |             |
|                              |considered valid. The file is described here.      |             |
|                              |:ref:`here <Facilities file>`.                     |             |
+------------------------------+---------------------------------------------------+-------------+
|default.instrument            |The name of the default instrument. The instrument | WISH        |
|                              |must be defined within the facilities.xml file to  |             |
|                              |be valid. The file is described                    |             |
|                              |:ref:`here <Facilities file>`.                     |             |
+------------------------------+---------------------------------------------------+-------------+

Directory Properties
********************

+--------------------------------+---------------------------------------------------+-----------------------+
|Property                        |Description                                        |Example value          |
+================================+===================================================+=======================+
|datasearch.directories          |A semi-colon(;) separated list of directories to   |../data;               |
|                                |use to search for data.                            |\\\\isis\\isis$\\ndxgem|
+--------------------------------+---------------------------------------------------+-----------------------+
|defaultsave.directory           |A default directory to use for saving files.       |../data                |
|                                |the data archive                                   |                       |
+--------------------------------+---------------------------------------------------+-----------------------+
|instrumentDefinition.directory  |Where to load instrument definition files from     |../Test/Instrument     |
+--------------------------------+---------------------------------------------------+-----------------------+
|parameterDefinition.directory   |Where to load parameter definition files from      |../Test/Instrument     |
+--------------------------------+---------------------------------------------------+-----------------------+
|pythonscripts.directories       |Python will also search the listed directories when|../scripts;            |
|                                |importing modules.                                 |C:/MyScripts           |
+--------------------------------+---------------------------------------------------+-----------------------+
|pythonscripts.directory         |DEPRECATED: Use pythonscripts.directories          |../scripts             |
|                                |A single location for the Python scripts directory |                       |
+--------------------------------+---------------------------------------------------+-----------------------+
|requiredpythonscript.directories|A list of directories containing Python scripts    |../scripts/SANS;       |
|                                |that Mantid requires to function correctly.        |../scripts/Excitations |
|                                |WARNING: Do not alter the default value.           |                       |
+--------------------------------+---------------------------------------------------+-----------------------+
|plugins.directory               |The path to the directory that contains the Mantid |../Plugins             |
|                                |plugin libraries                                   |                       |
+--------------------------------+---------------------------------------------------+-----------------------+
|requiredpythonscript.directories|A list of directories containing Python scripts    |../scripts/SANS;       |
|                                |that Mantid requires to function correctly.        |../scripts/Excitations |
|                                |WARNING: Do not alter the default value.           |                       |
+--------------------------------+---------------------------------------------------+-----------------------+



Logging Properties
******************

99
100
101
102
103
The details of configuring the logging functionality within Mantid will not be explained here. 
For those who want more details look into the POCO logging classes and the Log4J logging module 
that it closely emulates. There are several comments in the properties file itself that explain 
the configuration we provide by default.  However there are some obvious areas that you may want 
to alter and those properties are detailed below.
104
105
106
107
108

+----------------------------------------+---------------------------------------------------+-----------------------+
|Property                                |Description                                        |Example value          |
+========================================+===================================================+=======================+
|logging.loggers.root.level              |Defines the lowest level of messages to be output  |debug, informtion,     |
109
110
111
112
113
|                                        |by the system, and will override lower settings in |notice, warning,       |
|                                        |filterChannels. The default is information, but    |error, critical        |
|                                        |this can be lowered to debug for more detailed     |or fatal               |
|                                        |feedback.                                          |                       |
|                                        |                                                   |                       |
114
115
116
117
118
119
120
121
122
+----------------------------------------+---------------------------------------------------+-----------------------+
|logging.channels.fileFilterChannel.level|The lowest level messages to output to the log     |debug, informtion,     |
|                                        |file. The default is warning, but this can be      |notice, warning,       |
|                                        |lowered to debug for more detailed feedback. The   |error, critical        |
|                                        |higher level of this and logging.loggers.root.level|or fatal               |
|                                        |will apply.                                        |                       |
+----------------------------------------+---------------------------------------------------+-----------------------+
|logging.channels.fileChannel.path       | The Path to the log file.                         |../logs/mantid.log     |
+----------------------------------------+---------------------------------------------------+-----------------------+
123
124
125
126
127
128
129
130
131
132
133
134
The logging priority levels for the file logging and console logging can also be adjusted in python using the commands:

.. testcode:: LoggingConfigExample

  #Set the console to log at debug level on above (7=debug)
  ConfigService.setConsoleLogLevel(7)
  #Set the file to only log at critical level (1=critical)
  ConfigService.setConsoleLogLevel(7)
  
.. testoutput:: AddSampleLogExample 


135
136
137
138
139
140
141
142
143
144
145
146
147

MantidPlot Properties
*********************

+--------------------------------------+---------------------------------------------------+-----------------------+
|Property                              |Description                                        |Example value          |
+======================================+===================================================+=======================+
|MantidOptions.InvisibleWorkspaces     |Do not show 'invisible' workspaces                 |0, 1                   |
+--------------------------------------+---------------------------------------------------+-----------------------+
|MantidOptions.InstrumentView.UseOpenGL|Controls the use of OpenGL in rendering the        |On, Off                |
|                                      |"unwrapped" (flat) instrument views.               |                       |
+--------------------------------------+---------------------------------------------------+-----------------------+

148
149
150
Network Properties
******************

151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
+----------------------------------------+---------------------------------------------------+---------------------------------+
|Property                                |Description                                        |Example value                    |
+========================================+===================================================+=================================+
|network.default.timeout                 |Defines the default timeout for all network        |30                               |
|                                        |operations (in seconds).                           |                                 |
+----------------------------------------+---------------------------------------------------+---------------------------------+
|network.scriptrepo.timeout              |The timeout for network operations in the script   |5                                |
|                                        |repository, this overrides the deafault timeout.   |                                 |
+----------------------------------------+---------------------------------------------------+---------------------------------+
|proxy.host                              | Allows the system proxy to be overridden, if not  | :literal:`http://www.proxy.org` |
|                                        | set mantid will use the system proxy              |                                 |
+----------------------------------------+---------------------------------------------------+---------------------------------+
|proxy.port                              | Must be set if proxy.host is set                  | 8080                            |
+----------------------------------------+---------------------------------------------------+---------------------------------+
|proxy.httpsTargetUrl                    | A sample url used to determine the system proxy to| :literal:`http://www.google.com`|
|                                        | use on windows.                                   |                                 |
+----------------------------------------+---------------------------------------------------+---------------------------------+
168
169


170
171
172
ScriptRepository Properties
***************************

173
174
175
176
177
178
179
180
181
182
183
184
+-----------------------+-----------------------------------------------+----------------------------------------------------------------------------+
|Property               |Description                                    |Example value                                                               |
+=======================+===============================================+============================================================================+
|ScriptLocalRepository  |Directory where ScriptRepository is Installed. |:literal:`C:\\MantidInstall\\MyScriptRepository`                            |
+-----------------------+-----------------------------------------------+----------------------------------------------------------------------------+
|ScriptRepository       |Base URL for the remote script repository.     |:literal:`http://download.mantidproject.org/scriptrepository/`              |
+-----------------------+-----------------------------------------------+----------------------------------------------------------------------------+
|UploaderWebServer      |URL for uploading scripts.                     |:literal:`http://upload.mantidproject.org/scriptrepository/payload/publish` |
+-----------------------+-----------------------------------------------+----------------------------------------------------------------------------+
|ScriptRepositoryIgnore |CSV patterns for paths that should not be      |:literal:`*pyc;`                                                            |
|                       |listed at ScriptRepository.                    |                                                                            |
+-----------------------+-----------------------------------------------+----------------------------------------------------------------------------+
185
186
187
188
189
190
191
192
193
194
195


Getting access to Mantid properties
***********************************

To get access to, e.g. data saving path property from a C++ program one has to issue the following command:


.. testcode:: properties

  path = ConfigService.getString("defaultsave.directory")
196

197
.. categories:: Concepts