source: trunk/config_example.py @ 1719

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

implement default starting and import directories

File size: 1.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.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
41the location where GSAS-II is loaded GSASIIpath.path2GSAS2. For installations where
42G2 is installed by an administrator, it is a good idea to use something like this::
43
44    import os.path
45    Tutorial_location = os.path.join(os.path.expanduser('~'),'G2tutorials')
46
47This will allow users to download tutorial files into their own file space.
48'''
49
50Starting_directory=None
51'''Specifies a default location for starting GSAS-II
52'''
53
54Import_directory=None
55'''Specifies a default location for starting GSAS-II
56'''
Note: See TracBrowser for help on using the repository browser.