source: trunk/config_example.py @ 3974

Last change on this file since 3974 was 3974, checked in by toby, 3 years ago

more minor doc updates

  • Property svn:eol-style set to native
  • Property svn:keywords set to Date Author Revision URL Id
File size: 7.0 KB
Line 
1# -*- coding: utf-8 -*-
2#config.py - Variables used to set optional configuration options
3########### SVN repository information ###################
4# $Date: 2019-05-13 03:21:49 +0000 (Mon, 13 May 2019) $
5# $Author: toby $
6# $Revision: 3974 $
7# $URL: trunk/config_example.py $
8# $Id: config_example.py 3974 2019-05-13 03:21:49Z toby $
9########### SVN repository information ###################
10'''
11*config_example.py: Configuration options*
12-------------------------------------------
13
14This file contains optional configuration options for GSAS-II. The variables
15in this file can be copied to file config.py, which is imported if present.
16Access these variables using :func:`GSASIIpath.GetConfigValue`, which returns
17None if the variable is not set. Note that a config.py file need not
18be present, but if in use it will typically be found with the GSAS-II source
19directory (GSASIIpath.Path2GSAS2) or a directory for local GSAS-II
20modifications (~/.G2local/ or /Documents and Settings/<User>/.G2local/). 
21
22When defining new config variables for GSAS-II, define them here with a
23default value: use None or a string for strings, or use integers or real
24values. Include a doc string after each variable is defined to explain
25what it does. Use names ending in _location or _directory for items
26that will contain directory names.
27
28For example::
29
30    test_int = 0
31    test_float = 0.0
32    test_string = None (or)
33    test_string = 'value'
34'''
35
36debug = False
37'''Set to True to turn on debugging mode.This enables use of IPython on
38exceptions and on calls to :func:`GSASIIpath.IPyBreak`. Calls to
39:func:`GSASIIpath.pdbBreak` will invoke pdb at that location.
40
41If debug is False, calls to :func:`GSASIIpath.IPyBreak` and
42:func:`GSASIIpath.pdbBreak` are ignored.
43'''
44
45Clip_on = True
46''' if True then line plots willl be clipped at plot border;
47if False line plots extend nto white space around plot frme
48'''
49
50Transpose = False
51'Set to True to cause images to be Transposed when read (for code development)'
52
53Enable_logging = False
54'Set to True to enable use of command logging (under development.)'
55
56logging_debug = False
57'Set to True to enable debug for logging (under development.)'
58
59Help_mode = "browser"
60'''Set to "internal" to use a Python-based web viewer to display
61help documentation and tutorials. If set to the default ("browser")
62the default web browser is used.
63'''
64
65Tutorial_location = None
66'''Change this to place tutorials by in a different spot. If None, this defaults to
67<user>/My Documents/G2tutorials (on windows) or <user>/G2tutorials. If you want to
68use a different location, this can be set here. To install into the location where
69GSAS-II is installed, use this::
70
71    Tutorial_location = GSASIIpath.path2GSAS2
72
73As another example, to use ~/.G2tutorials do this::
74
75    Tutorial_location = '~/.G2tutorials'
76
77Note that os.path.expanduser is run on Tutorial_location before it is used.
78Also note that GSASIIpath is imported inside config.py; other imports should be
79avoided.
80'''
81
82Save_paths=False
83'''When set to True, the last-used path for saving of .gpx and for
84importing of input files is saved in the configuration file.
85Note that since this causes the config.py file to be updated whenever files are
86saved/imported, any temporary config settings can be saved to disk at that
87point.
88'''
89
90Starting_directory=None
91'''Specifies a default location for starting GSAS-II and where .gpx files
92should be read from. Will be updated if Save_paths is True.
93Note that os.path.expanduser is run on this before it is used, so the user's
94home directory can be specified with a '~'.
95'''
96
97Import_directory=None
98'''Specifies a default location for importing (reading) input files. Will be
99updated if Save_paths is True.
100Note that os.path.expanduser is run on this before it is used, so the user's
101home directory can be specified with a '~'.
102'''
103
104wxInspector = False
105'''If set to True, the wxInspector widget is displayed when
106GSAS-II is started.
107'''
108
109Spot_mask_diameter = 1.0
110'''Specifies the default diameter for creation of spot masks. Default is 1.0 mm
111'''
112
113Ring_mask_thickness = 0.1
114'''Specifies the default thickness for creation of ring and arc masks.
115Default is 0.1 degrees 2-theta.
116'''
117
118Arc_mask_azimuth = 10.0
119'''Specifies the default azimuthal range for creation of arc masks.
120Default is 10.0 degrees 2-theta.
121'''
122
123Autoint_PollTime = 30.
124'''Specifies the frequency, in seconds that AutoInt checks for new files.
125Default is 30 seconds
126'''
127
128Autoscale_ParmNames = ['userComment2',r'extraInputs\1\extraInputs','Ion_Chamber_I0',]
129DefaultAutoScale = "userComment2"
130'''Gives the possible selection of incident monitor names as found in an image metadata file.
131DefaultAutoScale must be one of the AutoScale_ParmNames
132Used in AutoIntegration
133'''
134Main_Size = '(700,450)'
135'''Main window size (width, height) - initially uses wx.DefaultSize but will updated
136 and saved as the user changes the window
137'''
138Main_Pos = '(100,100)'
139'''Main window location - will be updated & saved when user moves
140it. If position is outside screen then it will be repositioned to default
141'''
142Plot_Size = '(700,600)'
143'''Plot window size (width, height) - initially uses wx.DefaultSize but will updated
144 and saved as the user changes the window
145'''
146Plot_Pos = '(200,200)'
147'''Plot window location - will be updated & saved when user moves it
148these widows. If position is outside screen then it will be repositioned to default
149'''
150
151Tick_length = 8.0
152'''Specifies the length of phase tick marks in pixels. Default is 8.'''
153
154Tick_width = 1.0
155'''Specifies the width of phase tick marks in pixels.
156Fractional values do seem to produce an effect. Default is 1.'''
157
158Contour_color = 'Paired'
159''' Specifies the color map to be used for contour plots (images, pole figures, etc.)
160will be applied for new images and if Saved for a new start of GSAS-II
161'''
162
163Movie_fps = 10
164''' Specifies movie frames-per-second; larger number will make smoother modulation movies but larger files.
165'''
166
167Movie_time = 5
168''' Specifices time in sec for one modulation loop; larger number will give more frames for same fps'
169'''
170fullIntegrate = True
171''' If True then full image integration is default; False otherwise
172'''
173
174Multiprocessing_cores = 0
175''' Specifies the number of cores to use when performing multicore computing. A number less
176than zero causes the recommended number of cores [using multiprocessing.cpu_count()/2]
177to be used. Setting this number to 0 or 1 avoids use of the multiprocessing module: all
178computations are performed in-line.
179'''
180
181Show_timing = False
182'''If True, shows various timing results.'''
183
184Column_Metadata_directory = None
185'''When specified and when images are read, GSAS-II will read metadata from a 1-ID
186style .par and a .EXT_lbls (EXT = image extension) or .lbls file. See :func:`GSASIIfiles.readColMetadata` for
187information on how this is done.
188'''
189
190Instprm_default = False
191'''when True, GSAS-II instprm file are shown as default; when False, old GSAS stype prm, etc files are default
192'''
193
194Plot_Colors = 'k r g b m c'
195'''The colors for line plots: use one of 'k'-black, 'r'-red, 'b'-blue, 'g'-green, 'm'-magenta, 'c'-cyan for the
196line colors in order of obs., calc., back., diff., color5 & color6 separated by spaces; 6 items required.
197'''
198
199PDF_Rmax = 100.
200'''Maximum radius for G(r) calculations: range is from 10-200A; default is 100A
201'''
Note: See TracBrowser for help on using the repository browser.