/
installation_instruction.html
198 lines (189 loc) · 10.2 KB
/
installation_instruction.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Installation instruction — OpenPIV v1 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="OpenPIV v1 documentation" href="../index.html" />
<link rel="next" title="Information for developers and contributors" href="developers.html" />
<link rel="prev" title="Download OpenPIV Example" href="downloads_page.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="../np-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="developers.html" title="Information for developers and contributors"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="downloads_page.html" title="Download OpenPIV Example"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">OpenPIV v1 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="installation-instruction">
<span id="id1"></span><h1>Installation instruction<a class="headerlink" href="#installation-instruction" title="Permalink to this headline">¶</a></h1>
<div class="section" id="dependencies">
<span id="id2"></span><h2>Dependencies<a class="headerlink" href="#dependencies" title="Permalink to this headline">¶</a></h2>
<p>OpenPIV would not have been possible if other great open source projects did not
exist. We make extensive use of code and tools that other people have created, so
you should install them before you can use OpenPIV.</p>
<p>The dependencies are:</p>
<ul class="simple">
<li><a class="reference external" href="http://python.org/">python</a></li>
<li><a class="reference external" href="http://numpy.scipy.org/">scipy</a></li>
<li><a class="reference external" href="http://www.scipy.org/">numpy</a></li>
<li><a class="reference external" href="http://cython.org/">cython</a></li>
</ul>
<p>On all platforms, the binary Enthought Python Distribution (EPD) is recommended.
Visit <a class="reference external" href="http://www.enthought.com">http://www.enthought.com</a></p>
<div class="section" id="how-to-install-the-dependencies-on-linux">
<h3>How to install the dependencies on Linux<a class="headerlink" href="#how-to-install-the-dependencies-on-linux" title="Permalink to this headline">¶</a></h3>
<p>On a Linux platform installing these dependencies should be trick. Often, if not always,
python is installed by default, while the other dependencies should appear in your package
manager.</p>
</div>
<div class="section" id="how-to-install-the-dependencies-on-windows">
<h3>How to install the dependencies on Windows<a class="headerlink" href="#how-to-install-the-dependencies-on-windows" title="Permalink to this headline">¶</a></h3>
<p>On Windows all these dependencies, as well as several other useful packages, can be installed
using the Python(x,y) distribution, available at <a class="reference external" href="http://www.pythonxy.com/">http://www.pythonxy.com/</a>. Note: Install it in Custom Directories,
without spaces in the directory names (i.e. Program Files are prohibited), e.g. C:Pythonxy</p>
</div>
<div class="section" id="how-to-install-the-dependencies-on-a-mac">
<h3>How to install the dependencies on a Mac<a class="headerlink" href="#how-to-install-the-dependencies-on-a-mac" title="Permalink to this headline">¶</a></h3>
<p>The binary (32 or 64 bit) Enthought Python Distribution (EPD) is recommended. Visit <a class="reference external" href="http://www.enthought.com">http://www.enthought.com</a></p>
</div>
</div>
<div class="section" id="get-openpiv-source-code">
<h2>Get OpenPIV source code!<a class="headerlink" href="#get-openpiv-source-code" title="Permalink to this headline">¶</a></h2>
<p>At this moment the only way to get OpenPIV’s source code is using git.
<a class="reference external" href="http://en.wikipedia.org/wiki/Git_%28software%29">Git</a> Git is a distributed revision control system and
our code is hosted at <a class="reference external" href="www.github.com">GitHub</a>.</p>
<div class="section" id="bleeding-edge-development-version">
<h3>Bleeding edge development version<a class="headerlink" href="#bleeding-edge-development-version" title="Permalink to this headline">¶</a></h3>
<p>If you are interested in the source code you are welcome to browse out git repository
stored at <a class="reference external" href="https://github.com/alexlib/openpiv-python">https://github.com/alexlib/openpiv-python</a>. If you want to download the source code
on your machine, for testing, you need to set up git on your computer. Please look at
<a class="reference external" href="http://help.github.com/">http://help.github.com/</a> which provide extensive help for how to set up git.</p>
<p>To follow the development of OpenPIV, clone our repository with the command:</p>
<div class="highlight-python"><pre>git clone http://github.com/alexlib/openpiv-python.git</pre>
</div>
<p>and update from time to time. You can also download a tarball containing everything.</p>
<p>Then add the path where the OpenPIV source are to the PYTHONPATH environment variable, so
that OpenPIV module can be imported and used in your programs. Remeber to build the extension
with</p>
<div class="highlight-python"><pre>python setup.py build</pre>
</div>
</div>
</div>
<div class="section" id="having-problems">
<h2>Having problems?<a class="headerlink" href="#having-problems" title="Permalink to this headline">¶</a></h2>
<p>If you encountered some issues, found difficult to install OpenPIV following these instructions
please drop us an email to <a class="reference external" href="mailto:openpiv-develop%40lists.sourceforge.net">openpiv-develop<span>@</span>lists<span>.</span>sourceforge<span>.</span>net</a> , so that we can help you and
improve this page!</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Installation instruction</a><ul>
<li><a class="reference internal" href="#dependencies">Dependencies</a><ul>
<li><a class="reference internal" href="#how-to-install-the-dependencies-on-linux">How to install the dependencies on Linux</a></li>
<li><a class="reference internal" href="#how-to-install-the-dependencies-on-windows">How to install the dependencies on Windows</a></li>
<li><a class="reference internal" href="#how-to-install-the-dependencies-on-a-mac">How to install the dependencies on a Mac</a></li>
</ul>
</li>
<li><a class="reference internal" href="#get-openpiv-source-code">Get OpenPIV source code!</a><ul>
<li><a class="reference internal" href="#bleeding-edge-development-version">Bleeding edge development version</a></li>
</ul>
</li>
<li><a class="reference internal" href="#having-problems">Having problems?</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="downloads_page.html"
title="previous chapter">Download OpenPIV Example</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="developers.html"
title="next chapter">Information for developers and contributors</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/src/installation_instruction.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="../np-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="developers.html" title="Information for developers and contributors"
>next</a> |</li>
<li class="right" >
<a href="downloads_page.html" title="Download OpenPIV Example"
>previous</a> |</li>
<li><a href="../index.html">OpenPIV v1 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2011, The OpenPIV Contributors.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
</div>
</body>
</html>