source: trunk/config_example.py @ 1971

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

Add preferences option to edit configuration options

File size: 2.9 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_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
45Enable_logging = False
46'Set to True to enable use of command logging (under development.)'
47
48logging_debug = False
49'Set to True to enable debug for logging (under development.)'
50
51Help_mode = "browser"
52'''Set to "internal" to use a Python-based web viewer to display
53help documentation and tutorials. If set to the default ("browser")
54the default web browser is used.
55'''
56
57Tutorial_location = None
58'''Change this to place tutorials by in a different spot. If None, this defaults to
59<user>/My Documents/G2tutorials (on windows) or <user>/G2tutorials. If you want to
60use a different location, this can be set here. To install into the location where
61GSAS-II is installed, use this::
62
63    Tutorial_location = GSASIIpath.path2GSAS2
64
65As another example, to use ~/.G2tutorials do this::
66
67    Tutorial_location = os.path.expanduser('~/.G2tutorials')
68
69Note that os.path and GSASIIpath are imported inside config.py; other imports will
70require manual editing of the file.
71'''
72
73Starting_directory=None
74'''Specifies a default location for starting GSAS-II
75'''
76
77Import_directory=None
78'''Specifies a default location for finding exercise files used for
79Tutorials.
80'''
81
82wxInspector = False
83'''If set to True, the wxInspector widget is displayed when
84GSAS-II is started.
85'''
Note: See TracBrowser for help on using the repository browser.