-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathinstallation.html
More file actions
172 lines (144 loc) · 10.7 KB
/
installation.html
File metadata and controls
172 lines (144 loc) · 10.7 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
<!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="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Installation — pyropython documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.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>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Usage" href="usage.html" />
<link rel="prev" title="PyroPython – Parameter estimation for FDS pyrolysis models written in python" href="index.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="installation">
<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1>
<p>Pyropython is a command line tool written in python. You will need access to
the command line, a python distribution (e.g. <a class="reference external" href="https://www.anaconda.com/download/">anaconda</a>), <a class="reference external" href="https://git-scm.com/">git</a> version control software and a text editor (e.g. <a class="reference external" href="https://atom.io/">atom</a>).</p>
<p>The sources to pyropython are available at <a class="reference external" href="https://github.com/PyroId/PyroPython">https://github.com/PyroId/PyroPython</a>.
Download the sources.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">PyroId</span><span class="o">/</span><span class="n">PyroPython</span><span class="o">.</span><span class="n">git</span> <span class="n">PyroPython</span>
</pre></div>
</div>
<p>In the download directory type:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">setup</span><span class="o">.</span><span class="n">py</span> <span class="n">develop</span>
</pre></div>
</div>
<p>The above command installs a <em>development</em> version of the software. This
means that if you modify the source you just downloaded, you do not need
to install the software again.</p>
<dl class="docutils">
<dt>Prerequisites</dt>
<dd><ol class="first last arabic simple">
<li><a class="reference external" href="https://pages.nist.gov/fds-smv/">FDS</a></li>
<li>Python 3</li>
<li>Python packages: Numpy, Scipy, Matplotlib, pandas, yaml, scikit-learn, scikit-optimize, Jinja2</li>
</ol>
</dd>
</dl>
<p>Probably the easiest way to install the prerequisites</p>
<blockquote>
<div><ol class="arabic simple">
<li>Install Anaconda (or miniconda) [<a class="reference external" href="https://www.anaconda.com/download/">https://www.anaconda.com/download/</a>]</li>
<li>Type:</li>
</ol>
</div></blockquote>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">install</span> <span class="n">pandas</span> <span class="n">scikit</span><span class="o">-</span><span class="n">learn</span> <span class="n">jinja2</span>
<span class="n">conda</span> <span class="n">install</span> <span class="o">-</span><span class="n">c</span> <span class="n">conda</span><span class="o">-</span><span class="n">forge</span> <span class="n">scikit</span><span class="o">-</span><span class="n">optimize</span>
</pre></div>
</div>
<p>Matplotlib and numpy should already be included in the download of anaconda, if you downloaded miniconda or otherwise are missing packages:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">install</span> <span class="n">numpy</span> <span class="n">scipy</span> <span class="n">matplotlib</span>
<span class="n">pip</span> <span class="n">install</span> <span class="n">pyDOE</span>
</pre></div>
</div>
<p>pyDOE is needed for lhs sampling. Test installation by typing:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pyropython</span> <span class="o">-</span><span class="n">h</span>
</pre></div>
</div>
<p>This should output the following help message</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">usage</span><span class="p">:</span> <span class="n">pyropython</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">v</span> <span class="n">VERBOSITY</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">n</span> <span class="n">NUM_JOBS</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">m</span> <span class="n">MAX_ITER</span><span class="p">]</span>
<span class="p">[</span><span class="o">-</span><span class="n">i</span> <span class="n">NUM_INITIAL</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">p</span> <span class="n">NUM_POINTS</span><span class="p">]</span>
<span class="n">fname</span>
<span class="n">positional</span> <span class="n">arguments</span><span class="p">:</span>
<span class="n">fname</span> <span class="n">Input</span> <span class="n">file</span> <span class="n">name</span>
<span class="n">optional</span> <span class="n">arguments</span><span class="p">:</span>
<span class="o">-</span><span class="n">h</span><span class="p">,</span> <span class="o">--</span><span class="n">help</span> <span class="n">show</span> <span class="n">this</span> <span class="n">help</span> <span class="n">message</span> <span class="ow">and</span> <span class="n">exit</span>
<span class="o">-</span><span class="n">v</span> <span class="n">VERBOSITY</span><span class="p">,</span> <span class="o">--</span><span class="n">verbosity</span> <span class="n">VERBOSITY</span>
<span class="n">increase</span> <span class="n">output</span> <span class="n">verbosity</span>
<span class="o">-</span><span class="n">n</span> <span class="n">NUM_JOBS</span><span class="p">,</span> <span class="o">--</span><span class="n">num_jobs</span> <span class="n">NUM_JOBS</span>
<span class="n">number</span> <span class="n">of</span> <span class="n">concurrent</span> <span class="n">jobs</span>
<span class="o">-</span><span class="n">m</span> <span class="n">MAX_ITER</span><span class="p">,</span> <span class="o">--</span><span class="n">max_iter</span> <span class="n">MAX_ITER</span>
<span class="n">maximum</span> <span class="n">number</span> <span class="n">of</span> <span class="n">iterations</span>
<span class="o">-</span><span class="n">i</span> <span class="n">NUM_INITIAL</span><span class="p">,</span> <span class="o">--</span><span class="n">num_initial</span> <span class="n">NUM_INITIAL</span>
<span class="n">number</span> <span class="n">of</span> <span class="n">points</span> <span class="ow">in</span> <span class="n">initial</span> <span class="n">design</span>
<span class="o">-</span><span class="n">p</span> <span class="n">NUM_POINTS</span><span class="p">,</span> <span class="o">--</span><span class="n">num_points</span> <span class="n">NUM_POINTS</span>
<span class="n">number</span> <span class="n">of</span> <span class="n">points</span> <span class="n">per</span> <span class="n">iteration</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">pyropython</a></h1>
<h3>Navigation</h3>
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration files</a></li>
<li class="toctree-l1"><a class="reference internal" href="templates.html">Template files</a></li>
<li class="toctree-l1"><a class="reference internal" href="optimizers.html">Optimizers</a></li>
<li class="toctree-l1"><a class="reference internal" href="plots.html">Plotting</a></li>
<li class="toctree-l1"><a class="reference internal" href="filters.html">Filters</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="index.html" title="previous chapter">PyroPython – Parameter estimation for FDS pyrolysis models written in python</a></li>
<li>Next: <a href="usage.html" title="next chapter">Usage</a></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2018, Topi Sikanen.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.9</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
|
<a href="_sources/installation.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>