source: sphinxdocs/build/html/_modules/config_example.html @ 1709

Last change on this file since 1709 was 1709, checked in by toby, 8 years ago

change sphinx docs links; rebuild & fixing minor formatting
  • Property svn:mime-type set to text/html
File size: 6.5 KB
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
4
5<html xmlns="http://www.w3.org/1999/xhtml">
6  <head>
7    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8   
9    <title>config_example &mdash; GSAS-II 0.2.0 documentation</title>
10   
11    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
12    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
13   
14    <script type="text/javascript">
15      var DOCUMENTATION_OPTIONS = {
16        URL_ROOT:    '../',
17        VERSION:     '0.2.0',
18        COLLAPSE_INDEX: false,
19        FILE_SUFFIX: '.html',
20        HAS_SOURCE:  true
21      };
22    </script>
23    <script type="text/javascript" src="../_static/jquery.js"></script>
24    <script type="text/javascript" src="../_static/underscore.js"></script>
25    <script type="text/javascript" src="../_static/doctools.js"></script>
26    <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
27    <link rel="top" title="GSAS-II 0.2.0 documentation" href="../index.html" />
28    <link rel="up" title="Module code" href="index.html" /> 
29  </head>
30  <body>
31    <div class="related">
32      <h3>Navigation</h3>
33      <ul>
34        <li class="right" style="margin-right: 10px">
35          <a href="../genindex.html" title="General Index"
36             accesskey="I">index</a></li>
37        <li class="right" >
38          <a href="../py-modindex.html" title="Python Module Index"
39             >modules</a> |</li>
40        <li><a href="../index.html">GSAS-II 0.2.0 documentation</a> &raquo;</li>
41          <li><a href="index.html" accesskey="U">Module code</a> &raquo;</li> 
42      </ul>
43    </div> 
44
45    <div class="document">
46      <div class="documentwrapper">
47        <div class="bodywrapper">
48          <div class="body">
49           
50  <h1>Source code for config_example</h1><div class="highlight"><pre>
51<span class="c"># -*- coding: utf-8 -*-</span>
52<span class="c">#config.py - Variables used to set optional configuration options</span>
53<span class="c">########### SVN repository information ###################</span>
54<span class="c"># $Date: $</span>
55<span class="c"># $Author: toby $</span>
56<span class="c"># $Revision: $</span>
57<span class="c"># $URL: $</span>
58<span class="c"># $Id: $</span>
59<span class="c">########### SVN repository information ###################</span>
60<span class="sd">&#39;&#39;&#39;</span>
61<span class="sd">*config.py: Configuration options*</span>
62<span class="sd">----------------------------------</span>
63
64<span class="sd">This file contains optional configuration options for GSAS-II. Note that</span>
65<span class="sd">this file is not required to be present and code should be written to</span>
66<span class="sd">provide the default behavior if the file is not present or if any configuration</span>
67<span class="sd">variable is not set, but please do place a docstring here for every used</span>
68<span class="sd">config variable explaining what it does. Access these variables using</span>
69<span class="sd">:func:`GSASIIpath.GetConfigValue`.</span>
70<span class="sd">&#39;&#39;&#39;</span>
71
72<span class="n">debug</span> <span class="o">=</span> <span class="bp">False</span>
73<span class="sd">&#39;&#39;&#39;Set to True to turn on debugging mode. This enables use of IPython on </span>
74<span class="sd">exceptions and on calls to :func:`GSASIIpath.IPyBreak`. Calls to</span>
75<span class="sd">:func:`GSASIIpath.pdbBreak` will invoke pdb at that location.</span>
76<span class="sd">If debug is false calls to :func:`GSASIIpath.IPyBreak` and</span>
77<span class="sd">:func:`GSASIIpath.pdbBreak` are ignored.</span>
78<span class="sd">&#39;&#39;&#39;</span>
79
80<span class="n">Enable_logging</span> <span class="o">=</span> <span class="bp">None</span>
81<span class="s">&#39;Set to True to enable use of command logging&#39;</span>
82
83<span class="n">logging_debug</span> <span class="o">=</span> <span class="bp">None</span>
84<span class="s">&#39;Set to True to enable debug for logging&#39;</span>
85
86<span class="n">Help_mode</span> <span class="o">=</span> <span class="bp">None</span>
87<span class="s">&#39;Set to &quot;internal&quot; to use a Python-based web viewer rather than a web browser&#39;</span>
88
89<span class="n">Tutorial_location</span> <span class="o">=</span> <span class="bp">None</span>
90<span class="sd">&#39;&#39;&#39;Change this to place tutorials by in a different spot. If None, this defaults to</span>
91<span class="sd">the location where GSAS-II is loaded GSASIIpath.path2GSAS2. For installations where</span>
92<span class="sd">G2 is installed by an administrator, it is a good idea to use something like this::</span>
93
94<span class="sd">    import os.path</span>
95<span class="sd">    Tutorial_location = os.path.join(os.path.expanduser(&#39;~&#39;),&#39;G2tutorials&#39;)</span>
96
97<span class="sd">This will allow users to download tutorial files into their own file space.</span>
98<span class="sd">&#39;&#39;&#39;</span>
99</pre></div>
100
101          </div>
102        </div>
103      </div>
104      <div class="sphinxsidebar">
105        <div class="sphinxsidebarwrapper">
106            <p class="logo"><a href="../index.html">
107              <img class="logo" src="../_static/G2_html_logo.png" alt="Logo"/>
108            </a></p>
109<div id="searchbox" style="display: none">
110  <h3>Quick search</h3>
111    <form class="search" action="../search.html" method="get">
112      <input type="text" name="q" />
113      <input type="submit" value="Go" />
114      <input type="hidden" name="check_keywords" value="yes" />
115      <input type="hidden" name="area" value="default" />
116    </form>
117    <p class="searchtip" style="font-size: 90%">
118    Enter search terms or a module, class or function name.
119    </p>
120</div>
121<script type="text/javascript">$('#searchbox').show(0);</script>
122        </div>
123      </div>
124      <div class="clearer"></div>
125    </div>
126    <div class="related">
127      <h3>Navigation</h3>
128      <ul>
129        <li class="right" style="margin-right: 10px">
130          <a href="../genindex.html" title="General Index"
131             >index</a></li>
132        <li class="right" >
133          <a href="../py-modindex.html" title="Python Module Index"
134             >modules</a> |</li>
135        <li><a href="../index.html">GSAS-II 0.2.0 documentation</a> &raquo;</li>
136          <li><a href="index.html" >Module code</a> &raquo;</li> 
137      </ul>
138    </div>
139    <div class="footer">
140        &copy; Copyright 2013, Von Dreele and Toby for Argonne National Laboratory.
141      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
142    </div>
143  </body>
144</html>
Note: See TracBrowser for help on using the repository browser.