-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathgetting-started.html
More file actions
224 lines (210 loc) · 12.6 KB
/
Copy pathgetting-started.html
File metadata and controls
224 lines (210 loc) · 12.6 KB
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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>Getting Started — PyDSM 0.14.0.0 documentation</title>
<link rel="stylesheet" href="_static/agogo.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/style_variations.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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>
<script type="text/javascript" src="_static/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Getting started guide for Linux systems" href="linux-getting-started.html" />
<link rel="prev" title="Introduction" href="intro.html" />
</head><body>
<div class="header-wrapper" role="banner">
<div class="header">
<p class="logo"><a href="index.html">
<img class="logo" src="_static/pydsm_logo_small.png" alt="Logo"/>
</a></p>
<div class="headertitle"><a
href="index.html">PyDSM 0.14.0.0 documentation</a></div>
<div class="rel" role="navigation" aria-label="related navigation">
<a href="intro.html" title="Introduction"
accesskey="P">previous</a> |
<a href="linux-getting-started.html" title="Getting started guide for Linux systems"
accesskey="N">next</a> |
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |
<a href="genindex.html" title="General Index"
accesskey="I">index</a>
</div>
</div>
</div>
<div class="content-wrapper">
<div class="content">
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="getting-started">
<h1>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h1>
<p>PyDSM is meant to run on all major platforms (Linux, Windows, Mac,
etc.). It is free software and it is written so that all its
prerequisites are also free. This means that anyone can try and use
it. PyDSM is routinely built and tested by its developers on Linux and
Windows 7. On a more occasional basis, it is tested on MacOs too. The
code is written in Python and includes some C extensions for
efficiency reasons. Currently, it requires a Python 2 environment
(<a class="reference external" href="http://www.python.org/download/releases/2.7/">Python 2.7</a> recommended) or a Python 3 environment (at least at
version 3.2, <a class="reference external" href="http://www.python.org/download/releases/3.4/">Python 3.4</a> recommended).</p>
<p>Apart from a generic Python environment, PyDSM has the following
prerequisites:</p>
<dl class="simple">
<dt><a class="reference external" href="http://sourceforge.net/projects/numpy/">Numpy</a></dt><dd><p>A powerful library that adds vector and matrix manipulation
routines to Python. Currently tested with version 1.8.0 and
current. May work with previous releases.</p>
</dd>
<dt><a class="reference external" href="http://sourceforge.net/projects/scipy/">Scipy</a></dt><dd><p>A package of tools for science and engineering for
Python. Currently tested with version 0.13.2 and current. May work
with previous releases.</p>
</dd>
<dt><a class="reference external" href="http://matplotlib.org/">Matplotlib</a></dt><dd><p>A python plotting library. Currently tested with version
1.3.1 and current. May work with previous releases.</p>
</dd>
<dt><a class="reference external" href="http://abel.ee.ucla.edu/cvxopt/">CVXOPT</a></dt><dd><p>A free software package for convex optimization based on the
Python programming language. Currently tested with version 1.1.6
and current. May work with previous releases.</p>
</dd>
</dl>
<p>Furthermore, the following pre-requisites may exist in case one wants to build
from source (which is expected in Linux and MacOS and optional in Windows):</p>
<dl class="simple">
<dt><a class="reference external" href="http://www.cython.org/">Cython</a></dt><dd><p>A language to write C extensions for the Python
language. This is actually necessary only for compiling the
code. Tested with versions 0.19.2 and current. May work with
previous releases.</p>
</dd>
<dt>A C compiler</dt><dd><p>This is only for compiling the
extension modules and after that is not used anymore. In Linux,
the C compiler can typically be installed from the distribution
package manager. In MacOs, Xcode can be obtained from the app
store. In Windows, just in case you want to build from source, the
recommended compiler is Visual C++ Express 2008 (namely, the
default compiler used for Python 2.7 itself), that is provided at
no cost from Microsoft. Note that the 64 bit compiler needs to be
purchased separately with the Microsoft Windows SDK for Windows 7
and .NET Framework 3.5 SP1, also available at no cost from
Microsoft.</p>
</dd>
</dl>
<p>In Linux only, two different versions of the simulator are built,
using two different sets of libraries for matrix manipulation (this is
to have a term of comparison for the simulator speed, but is likely to
change). Consequently, the Linux build also requires:</p>
<dl class="simple">
<dt>CBlas</dt><dd><p>Blas is a library of routines for performing basic
vector and matrix operations. CBlas is its edition tailored for C
code. For its building, PyDSM requires a <em>development version</em> of
CBlas, namely a version including header files. For running PyDSM
on Linux, a mere CBlas <em>runtime</em> library is needed. CBlas may be
available from many sources including <a class="reference external" href="http://www.netlib.org">Netlib</a>, <a class="reference external" href="http://math-atlas.sourceforge.net/">Atlas</a>, <a class="reference external" href="http://www.openblas.net/">Openblas</a>,
etc. On Linux use your distribution package manager to select one.
The use of a CBLAS edition fully optimized for your CPU and system
architecture is highly recommended.</p>
</dd>
</dl>
<p>Although the prerequisites appear to be numerous, their management is
actually quite easy.</p>
<p>A detailed getting started guide is provided for <a class="reference internal" href="linux-getting-started.html"><span class="doc">Linux</span></a>, <a class="reference internal" href="windows-getting-started.html"><span class="doc">Windows</span></a> and
<a class="reference internal" href="macos-getting-started.html"><span class="doc">MacOs</span></a>.</p>
<p>In addition to the above prerequisites, we suggest to try <a class="reference external" href="http://code.google.com/p/spyderlib/">Spyder</a> as
an environment to run the code. This is a Python development
environment specifically tailored to suit the need of scientific
applications and to ease the learning path for those with an
experience in Matlab. Conveniently, it offers online help for
coding. The functions in PyDSM are internally documented to work with
this online help system.</p>
<p>Recent version of PyDSM may also benefit from alternative modeling
languages for convex optimization. The interested user may want to
install also the <a class="reference external" href="http://www.cvxpy.org">CVXPY</a> and/or the <a class="reference external" href="http://picos.zib.de/">PICOS</a> Python packages.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="linux-getting-started.html">Getting started guide for Linux systems</a><ul>
<li class="toctree-l2"><a class="reference internal" href="linux-getting-started.html#installation-of-the-prerequisites">Installation of the prerequisites</a></li>
<li class="toctree-l2"><a class="reference internal" href="linux-getting-started.html#installation-of-pydsm-itself">Installation of PyDSM itself</a></li>
<li class="toctree-l2"><a class="reference internal" href="linux-getting-started.html#testing-the-code">Testing the code</a></li>
<li class="toctree-l2"><a class="reference internal" href="linux-getting-started.html#using-the-code">Using the code</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="windows-getting-started.html">Getting started guide for Windows systems</a><ul>
<li class="toctree-l2"><a class="reference internal" href="windows-getting-started.html#installation-of-the-prerequisites">Installation of the prerequisites</a></li>
<li class="toctree-l2"><a class="reference internal" href="windows-getting-started.html#installation-of-pydsm-itself">Installation of PyDSM itself</a></li>
<li class="toctree-l2"><a class="reference internal" href="windows-getting-started.html#building-from-source">Building from source</a></li>
<li class="toctree-l2"><a class="reference internal" href="windows-getting-started.html#testing-the-code">Testing the code</a></li>
<li class="toctree-l2"><a class="reference internal" href="windows-getting-started.html#using-the-code">Using the code</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="macos-getting-started.html">Getting started guide for MacOs systems</a><ul>
<li class="toctree-l2"><a class="reference internal" href="macos-getting-started.html#installation-of-the-prerequisites">Installation of the prerequisites</a></li>
<li class="toctree-l2"><a class="reference internal" href="macos-getting-started.html#installation-of-pydsm-itself">Installation of PyDSM itself</a></li>
<li class="toctree-l2"><a class="reference internal" href="macos-getting-started.html#testing-the-code">Testing the code</a></li>
<li class="toctree-l2"><a class="reference internal" href="macos-getting-started.html#using-the-code">Using the code</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sidebar">
<h3>Table of Contents</h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Getting Started</a><ul>
<li class="toctree-l2"><a class="reference internal" href="linux-getting-started.html">Getting started guide for Linux systems</a></li>
<li class="toctree-l2"><a class="reference internal" href="windows-getting-started.html">Getting started guide for Windows systems</a></li>
<li class="toctree-l2"><a class="reference internal" href="macos-getting-started.html">Getting started guide for MacOs systems</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="reference.html">Reference guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="replicate-results.html">How to replicate the results in some recent scientific papers</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
<li class="toctree-l1"><a class="reference internal" href="included_code.html">Code included in PyDSM</a></li>
<li class="toctree-l1"><a class="reference internal" href="more-references.html">References not provided inline in this manual</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
</ul>
<div role="search">
<h3 style="margin-top: 1.5em;">Search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<div class="clearer"></div>
</div>
</div>
<div class="footer-wrapper">
<div class="footer">
<div class="left">
<div role="navigation" aria-label="related navigaton">
<a href="intro.html" title="Introduction"
>previous</a> |
<a href="linux-getting-started.html" title="Getting started guide for Linux systems"
>next</a> |
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |
<a href="genindex.html" title="General Index"
>index</a>
</div>
<div role="note" aria-label="source link">
</div>
</div>
<div class="right">
<div class="footer" role="contentinfo">
© Copyright © 2012-2014, Sergio Callegari.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.2.0.
</div>
</div>
<div class="clearer"></div>
</div>
</div>
</body>
</html>