source: trunk/config_example.py @ 1823

Last change on this file since 1823 was 1823, checked in by toby, 7 years ago

revise paint of data tab

File size: 2.1 KB
Line 
1# -*- coding: utf-8 -*-
2#config.py - Variables used to set optional configuration options
3########### SVN repository information ###################
4# $Date: $
5# $Author: toby $
6# $Revision: $
7# $URL: $
8# $Id: $
9########### SVN repository information ###################
10'''
11*config.py: Configuration options*
12----------------------------------
13
14This file contains optional configuration options for GSAS-II. Note that
15this file is not required to be present and code should be written to
16provide the default behavior if the file is not present or if any configuration
17variable is not set, but please do place a docstring here for every used
18config variable explaining what it does. Access these variables using
19:func:`GSASIIpath.GetConfigValue`.
20'''
21
22debug = False
23'''Set to True to turn on debugging mode. This enables use of IPython on
24exceptions and on calls to :func:`GSASIIpath.IPyBreak`. Calls to
25:func:`GSASIIpath.pdbBreak` will invoke pdb at that location.
26If debug is false calls to :func:`GSASIIpath.IPyBreak` and
27:func:`GSASIIpath.pdbBreak` are ignored.
28'''
29
30Enable_logging = False
31'Set to True to enable use of command logging'
32
33logging_debug = False
34'Set to True to enable debug for logging'
35
36Help_mode = None
37'Set to "internal" to use a Python-based web viewer rather than a web browser'
38
39Tutorial_location = None
40'''Change this to place tutorials by in a different spot. If None, this defaults to
41~/My Documents/G2tutorials (on windows) or ~/G2tutorials. If you want to use a different
42location (such as to use the GSASII installation directory), this can be set here.
43As an example, to always use ~/G2tutorials do this::
44
45    import os.path
46    Tutorial_location = os.path.join(os.path.expanduser('~'),'G2tutorials')
47
48To install into the location where GSAS-II is installed, use this::
49
50    import GSASIIpath
51    Tutorial_location = GSASIIpath.path2GSAS2
52
53'''
54
55Starting_directory=None
56'''Specifies a default location for starting GSAS-II
57'''
58
59Import_directory=None
60'''Specifies a default location for starting GSAS-II
61'''
62
63wxInspector = None
64'''If set to True, the wxInspector widget is displayed
65'''
Note: See TracBrowser for help on using the repository browser.