-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathplots.html
More file actions
176 lines (143 loc) · 7.28 KB
/
plots.html
File metadata and controls
176 lines (143 loc) · 7.28 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
<!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>Plotting — 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="Filters" href="filters.html" />
<link rel="prev" title="Optimizers" href="optimizers.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="plotting">
<span id="id1"></span><h1>Plotting<a class="headerlink" href="#plotting" title="Permalink to this headline">¶</a></h1>
<p>Pyropython contains a rudimentary plotting tool to quickly inspect the
experimental data, simulation results and goodness of fit. After runniong pyropython.
You can plot the figures defined in the configuration file by typing</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">plot_pyro</span> <span class="n">config</span><span class="o">.</span><span class="n">yml</span>
</pre></div>
</div>
<p>at the command line. The plots are defined in the <strong>config.yml</strong> file under the <strong>plots</strong> keyword.</p>
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="l l-Scalar l-Scalar-Plain">plots</span><span class="p p-Indicator">:</span>
<span class="l l-Scalar l-Scalar-Plain">plotname</span><span class="p p-Indicator">:</span> <span class="p p-Indicator">{</span><span class="nv">variables</span><span class="p p-Indicator">:</span>
<span class="nv">labels</span><span class="p p-Indicator">:</span>
<span class="nv">type</span><span class="p p-Indicator">:</span>
<span class="nv">ylabel</span><span class="p p-Indicator">:</span>
<span class="nv">xlabel</span><span class="p p-Indicator">:</span>
<span class="p p-Indicator">}</span>
</pre></div>
</div>
<dl class="data">
<dt>
<code class="descname">plots :noindex:</code></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="plotname">
<code class="descname">plotname</code><a class="headerlink" href="#plotname" title="Permalink to this definition">¶</a></dt>
<dd><p>Name of the plotfile. This willcreate a file named “plotname.pdf” in
Figs/ or CASENAME_Figs/.</p>
<dl class="attribute">
<dt id="variables">
<code class="descname">variables</code><a class="headerlink" href="#variables" title="Permalink to this definition">¶</a></dt>
<dd><p>Variables to be plotted. The variable names are the same as
those listed under <em>simulation</em> and <em>experiment</em> keywords
:noindex:</p>
</dd></dl>
<dl class="attribute">
<dt id="labels">
<code class="descname">labels</code><a class="headerlink" href="#labels" title="Permalink to this definition">¶</a></dt>
<dd><p>LAbels for the legend of the plot. For comparison plots,
the labels will be appended with “exp” and “sim” for
experimental data and simulation results, respectively</p>
</dd></dl>
<dl class="attribute">
<dt id="type">
<code class="descname">type</code><a class="headerlink" href="#type" title="Permalink to this definition">¶</a></dt>
<dd><p>Type of plot. Choices are “comparison”, “simulation” and
“experimental”. Comparison plots a comparison of
the simulation results in Best/ (or CASENAME/) folder with
experimental data. PLot type “simulation” plots only the
simulation data. This is useful for checking gradient
calculation etc. Plot type “experimental” plots the raw
experimental data together with the filtered version. Useful
for checking filtering ad other transformations.</p>
</dd></dl>
<dl class="attribute">
<dt id="xlabel">
<code class="descname">xlabel</code><a class="headerlink" href="#xlabel" title="Permalink to this definition">¶</a></dt>
<dd><p>Label for the x-axis of the plot.</p>
</dd></dl>
<dl class="attribute">
<dt id="ylabel">
<code class="descname">ylabel</code><a class="headerlink" href="#ylabel" title="Permalink to this definition">¶</a></dt>
<dd><p>Label for the y-axis of the plot.</p>
</dd></dl>
</dd></dl>
</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"><a class="reference internal" href="installation.html">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 current"><a class="current reference internal" href="#">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="optimizers.html" title="previous chapter">Optimizers</a></li>
<li>Next: <a href="filters.html" title="next chapter">Filters</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/plots.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>