source: fact/tools/pyscripts/doc/_build/html/introduction.html@ 13316

Last change on this file since 13316 was 13316, checked in by lusterma, 13 years ago
worked on doc
File size: 6.0 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<html xmlns="http://www.w3.org/1999/xhtml">
7 <head>
8 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9
10 <title>Introduction &mdash; pyfact v0.1 documentation</title>
11 <link rel="stylesheet" href="_static/default.css" type="text/css" />
12 <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
13 <script type="text/javascript">
14 var DOCUMENTATION_OPTIONS = {
15 URL_ROOT: '',
16 VERSION: '0.1',
17 COLLAPSE_INDEX: false,
18 FILE_SUFFIX: '.html',
19 HAS_SOURCE: true
20 };
21 </script>
22 <script type="text/javascript" src="_static/jquery.js"></script>
23 <script type="text/javascript" src="_static/underscore.js"></script>
24 <script type="text/javascript" src="_static/doctools.js"></script>
25 <link rel="top" title="pyfact v0.1 documentation" href="index.html" />
26 <link rel="next" title="Getting Started" href="getting_started.html" />
27 <link rel="prev" title="Welcome to pyfact’s documentation!" href="index.html" />
28 </head>
29 <body>
30 <div class="related">
31 <h3>Navigation</h3>
32 <ul>
33 <li class="right" style="margin-right: 10px">
34 <a href="genindex.html" title="General Index"
35 accesskey="I">index</a></li>
36 <li class="right" >
37 <a href="getting_started.html" title="Getting Started"
38 accesskey="N">next</a> |</li>
39 <li class="right" >
40 <a href="index.html" title="Welcome to pyfact’s documentation!"
41 accesskey="P">previous</a> |</li>
42 <li><a href="index.html">pyfact v0.1 documentation</a> &raquo;</li>
43 </ul>
44 </div>
45
46 <div class="document">
47 <div class="documentwrapper">
48 <div class="bodywrapper">
49 <div class="body">
50
51 <div class="section" id="introduction">
52<h1>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h1>
53<p>pyfact provides support for analysing FACT data using python. This comprises:</p>
54<ul class="simple">
55<li>classes for accessing and analysing FACT data</li>
56<li>tools for specific tasks</li>
57<li>general python language support</li>
58<li>examples</li>
59</ul>
60<p>If you are new to python you need to learn the basics. In any case it would be wise to study the following book:</p>
61<p><em>A Primer on Scientific Programming with Python - Hans Petter Langtangen</em></p>
62<p>pyfact is supposed to follow closely the programming style thought in this book.</p>
63<p><a class="reference external" href="http://docs.python.org/">python documentation pages</a></p>
64<p><a class="reference external" href="http://www.astropython.org/resources">astropython.org</a></p>
65<div class="section" id="python-version-and-modules-used">
66<h2>Python version and modules used<a class="headerlink" href="#python-version-and-modules-used" title="Permalink to this headline">¶</a></h2>
67<p>As long as you work on the ISDC FACT cluster most things should be just fine.
68<a href="#id1"><span class="problematic" id="id2">|</span></a>python version: 2.6.6
69<a href="#id3"><span class="problematic" id="id4">|</span></a>&#8212; add later: list of modules</p>
70</div>
71<div class="section" id="style-guide-and-coding-conventions">
72<h2>Style guide and coding conventions<a class="headerlink" href="#style-guide-and-coding-conventions" title="Permalink to this headline">¶</a></h2>
73<p>The code of pyfact follows the <a href="#id5"><span class="problematic" id="id6">`</span></a>Style Guide for python code &lt;<a class="reference external" href="http://www.python.org/dev/peps/pep-0008/">http://www.python.org/dev/peps/pep-0008/</a>&gt;.</p>
74</div>
75</div>
76
77
78 </div>
79 </div>
80 </div>
81 <div class="sphinxsidebar">
82 <div class="sphinxsidebarwrapper">
83 <h3><a href="index.html">Table Of Contents</a></h3>
84 <ul>
85<li><a class="reference internal" href="#">Introduction</a><ul>
86<li><a class="reference internal" href="#python-version-and-modules-used">Python version and modules used</a></li>
87<li><a class="reference internal" href="#style-guide-and-coding-conventions">Style guide and coding conventions</a></li>
88</ul>
89</li>
90</ul>
91
92 <h4>Previous topic</h4>
93 <p class="topless"><a href="index.html"
94 title="previous chapter">Welcome to pyfact&#8217;s documentation!</a></p>
95 <h4>Next topic</h4>
96 <p class="topless"><a href="getting_started.html"
97 title="next chapter">Getting Started</a></p>
98 <h3>This Page</h3>
99 <ul class="this-page-menu">
100 <li><a href="_sources/introduction.txt"
101 rel="nofollow">Show Source</a></li>
102 </ul>
103<div id="searchbox" style="display: none">
104 <h3>Quick search</h3>
105 <form class="search" action="search.html" method="get">
106 <input type="text" name="q" size="18" />
107 <input type="submit" value="Go" />
108 <input type="hidden" name="check_keywords" value="yes" />
109 <input type="hidden" name="area" value="default" />
110 </form>
111 <p class="searchtip" style="font-size: 90%">
112 Enter search terms or a module, class or function name.
113 </p>
114</div>
115<script type="text/javascript">$('#searchbox').show(0);</script>
116 </div>
117 </div>
118 <div class="clearer"></div>
119 </div>
120 <div class="related">
121 <h3>Navigation</h3>
122 <ul>
123 <li class="right" style="margin-right: 10px">
124 <a href="genindex.html" title="General Index"
125 >index</a></li>
126 <li class="right" >
127 <a href="getting_started.html" title="Getting Started"
128 >next</a> |</li>
129 <li class="right" >
130 <a href="index.html" title="Welcome to pyfact’s documentation!"
131 >previous</a> |</li>
132 <li><a href="index.html">pyfact v0.1 documentation</a> &raquo;</li>
133 </ul>
134 </div>
135 <div class="footer">
136 &copy; Copyright 2012, Werner Lustermann.
137 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.4.
138 </div>
139 </body>
140</html>
Note: See TracBrowser for help on using the repository browser.