source: pvMail/doc/build/html/pvMail/modules.html @ 933

Last change on this file since 933 was 933, checked in by jemian, 10 years ago

report the documentation build date rather than SVN revision number

  • Property svn:mime-type set to text/html
File size: 8.1 KB
Line 
1
2
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6
7<html xmlns="http://www.w3.org/1999/xhtml">
8  <head>
9    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10   
11    <title>PvMail as a Python package &mdash; PvMail (v3.0, 2012-06-14) documentation</title>
12   
13    <link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
14    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
15   
16    <script type="text/javascript">
17      var DOCUMENTATION_OPTIONS = {
18        URL_ROOT:    '../',
19        VERSION:     '(v3.0, 2012-06-14)',
20        COLLAPSE_INDEX: false,
21        FILE_SUFFIX: '.html',
22        HAS_SOURCE:  true
23      };
24    </script>
25    <script type="text/javascript" src="../_static/jquery.js"></script>
26    <script type="text/javascript" src="../_static/underscore.js"></script>
27    <script type="text/javascript" src="../_static/doctools.js"></script>
28    <link rel="top" title="PvMail (v3.0, 2012-06-14) documentation" href="../index.html" />
29    <link rel="up" title="Contents" href="../contents.html" />
30    <link rel="next" title="PvMail Python Package" href="pvMail.html" />
31    <link rel="prev" title="EPICS test database" href="../test_database.html" /> 
32  </head>
33  <body>
34    <div class="related">
35      <h3>Navigation</h3>
36      <ul>
37        <li class="right" style="margin-right: 10px">
38          <a href="../genindex.html" title="General Index"
39             accesskey="I">index</a></li>
40        <li class="right" >
41          <a href="../py-modindex.html" title="Python Module Index"
42             >modules</a> |</li>
43        <li class="right" >
44          <a href="pvMail.html" title="PvMail Python Package"
45             accesskey="N">next</a> |</li>
46        <li class="right" >
47          <a href="../test_database.html" title="EPICS test database"
48             accesskey="P">previous</a> |</li>
49        <li><a href="../index.html">PvMail (v3.0, 2012-06-14) documentation</a> &raquo;</li>
50          <li><a href="../contents.html" accesskey="U">Contents</a> &raquo;</li> 
51      </ul>
52    </div>
53      <div class="sphinxsidebar">
54        <div class="sphinxsidebarwrapper">
55  <h3><a href="../index.html">Table Of Contents</a></h3>
56  <ul>
57<li><a class="reference internal" href="#">PvMail as a Python package</a><ul>
58<li><a class="reference internal" href="#installation">installation</a></li>
59<li><a class="reference internal" href="#starter-program">starter program</a></li>
60</ul>
61</li>
62<li><a class="reference internal" href="#pvmail-source-code-documentation">PvMail source code documentation</a><ul>
63</ul>
64</li>
65</ul>
66
67  <h4>Previous topic</h4>
68  <p class="topless"><a href="../test_database.html"
69                        title="previous chapter">EPICS test database</a></p>
70  <h4>Next topic</h4>
71  <p class="topless"><a href="pvMail.html"
72                        title="next chapter">PvMail Python Package</a></p>
73  <h3>This Page</h3>
74  <ul class="this-page-menu">
75    <li><a href="../_sources/pvMail/modules.txt"
76           rel="nofollow">Show Source</a></li>
77  </ul>
78<div id="searchbox" style="display: none">
79  <h3>Quick search</h3>
80    <form class="search" action="../search.html" method="get">
81      <input type="text" name="q" />
82      <input type="submit" value="Go" />
83      <input type="hidden" name="check_keywords" value="yes" />
84      <input type="hidden" name="area" value="default" />
85    </form>
86    <p class="searchtip" style="font-size: 90%">
87    Enter search terms or a module, class or function name.
88    </p>
89</div>
90<script type="text/javascript">$('#searchbox').show(0);</script>
91        </div>
92      </div>
93
94    <div class="document">
95      <div class="documentwrapper">
96        <div class="bodywrapper">
97          <div class="body">
98           
99  <div class="section" id="pvmail-as-a-python-package">
100<h1>PvMail as a Python package<a class="headerlink" href="#pvmail-as-a-python-package" title="Permalink to this headline">¶</a></h1>
101<p>This section provides the source code documentation.
102The documentation here may be of little or no use
103to the casual user of this software.</p>
104<div class="section" id="installation">
105<h2>installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
106<p>The PvMail project can be installed as a Python package.</p>
107<ol class="arabic simple">
108<li>Checkout the project from subversion</li>
109<li>Change into the project working directory</li>
110<li>Run <tt class="docutils literal"><span class="pre">setup.py</span> <span class="pre">install</span></tt></li>
111</ol>
112</div>
113<div class="section" id="starter-program">
114<h2>starter program<a class="headerlink" href="#starter-program" title="Permalink to this headline">¶</a></h2>
115<p>Once the PvMail project has been installed as a package, the
116PvMail application can be run using a simple Python script (included
117in the project tree at the top-level directory as <tt class="docutils literal"><span class="pre">pvMail.py</span></tt>).
118Here is the current version of that script.</p>
119<div class="highlight-python"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre> 1
120 2
121 3
122 4
123 5
124 6
125 7
126 8
127 9
12810
12911
13012
13113
13214
13315
13416</pre></div></td><td class="code"><div class="highlight"><pre><span class="c">#!/usr/bin/env python</span>
135
136<span class="sd">&#39;&#39;&#39; </span>
137<span class="sd">runs the PvMail application</span>
138
139<span class="sd">Documentation:</span>
140<span class="sd">    https://subversion.xray.aps.anl.gov/bcdaext/pvMail/doc/build/html/index.html</span>
141
142<span class="sd">see the help option for immediate details about the command-line::</span>
143
144<span class="sd">    pvMail.py --help</span>
145
146<span class="sd">&#39;&#39;&#39;</span>
147
148<span class="kn">from</span> <span class="nn">PvMail</span> <span class="kn">import</span> <span class="n">pvMail</span>
149<span class="n">pvMail</span><span class="o">.</span><span class="n">main</span><span class="p">()</span>
150</pre></div>
151</td></tr></table></div>
152</div>
153</div>
154<div class="section" id="pvmail-source-code-documentation">
155<h1>PvMail source code documentation<a class="headerlink" href="#pvmail-source-code-documentation" title="Permalink to this headline">¶</a></h1>
156<div class="toctree-wrapper compound">
157<ul>
158<li class="toctree-l1"><a class="reference internal" href="pvMail.html">PvMail Python Package</a><ul>
159<li class="toctree-l2"><a class="reference internal" href="pvMail.html#module-PvMail.pvMail"><tt class="docutils literal"><span class="pre">pvMail</span></tt> Module</a><ul>
160<li class="toctree-l3"><a class="reference internal" href="pvMail.html#pvmail-combined-cli-and-gui">pvMail: combined CLI and GUI</a><ul>
161<li class="toctree-l4"><a class="reference internal" href="pvMail.html#summary">Summary</a></li>
162</ul>
163</li>
164</ul>
165</li>
166<li class="toctree-l2"><a class="reference internal" href="pvMail.html#module-PvMail.traits_gui"><tt class="docutils literal"><span class="pre">traits_gui</span></tt> Module</a><ul>
167<li class="toctree-l3"><a class="reference internal" href="pvMail.html#pvmail-just-the-gui">pvMail: just the GUI</a></li>
168</ul>
169</li>
170</ul>
171</li>
172</ul>
173</div>
174</div>
175
176
177          </div>
178        </div>
179      </div>
180      <div class="clearer"></div>
181    </div>
182    <div class="related">
183      <h3>Navigation</h3>
184      <ul>
185        <li class="right" style="margin-right: 10px">
186          <a href="../genindex.html" title="General Index"
187             >index</a></li>
188        <li class="right" >
189          <a href="../py-modindex.html" title="Python Module Index"
190             >modules</a> |</li>
191        <li class="right" >
192          <a href="pvMail.html" title="PvMail Python Package"
193             >next</a> |</li>
194        <li class="right" >
195          <a href="../test_database.html" title="EPICS test database"
196             >previous</a> |</li>
197        <li><a href="../index.html">PvMail (v3.0, 2012-06-14) documentation</a> &raquo;</li>
198          <li><a href="../contents.html" >Contents</a> &raquo;</li> 
199      </ul>
200    </div>
201    <div class="footer">
202        &copy; Copyright (c) 2009-2012, UChicago Argonne, LLC (see LICENSE file for details).
203      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
204    </div>
205  </body>
206</html>
Note: See TracBrowser for help on using the repository browser.