forked from materialsproject/pymatgen
-
Notifications
You must be signed in to change notification settings - Fork 0
/
pymatgen.apps.battery.plotter.html
188 lines (172 loc) · 9.41 KB
/
pymatgen.apps.battery.plotter.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
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>pymatgen.apps.battery.plotter module — pymatgen 2019.5.1 documentation</title>
<link rel="stylesheet" href="_static/proBlue.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>
<script type="text/javascript" src="_static/language_data.js"></script>
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="shortcut icon" href="_static/favicon.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-33990148-1']);
_gaq.push(['_trackPageview']);
</script>
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<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="nav-item nav-item-0"><a href="index.html">pymatgen 2019.5.1 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-pymatgen.apps.battery.plotter">
<span id="pymatgen-apps-battery-plotter-module"></span><h1>pymatgen.apps.battery.plotter module<a class="headerlink" href="#module-pymatgen.apps.battery.plotter" title="Permalink to this headline">¶</a></h1>
<p>This module provides plotting capabilities for battery related applications.</p>
<dl class="class">
<dt id="pymatgen.apps.battery.plotter.VoltageProfilePlotter">
<em class="property">class </em><code class="descname">VoltageProfilePlotter</code><span class="sig-paren">(</span><em>xaxis='capacity'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/apps/battery/plotter.html#VoltageProfilePlotter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.plotter.VoltageProfilePlotter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>A plotter to make voltage profile plots for batteries.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>xaxis</strong> – The quantity to use as the xaxis. Can be either capacity (the
default), or the frac_x.</p>
</dd>
</dl>
<dl class="method">
<dt id="pymatgen.apps.battery.plotter.VoltageProfilePlotter.add_electrode">
<code class="descname">add_electrode</code><span class="sig-paren">(</span><em>electrode</em>, <em>label=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/apps/battery/plotter.html#VoltageProfilePlotter.add_electrode"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.plotter.VoltageProfilePlotter.add_electrode" title="Permalink to this definition">¶</a></dt>
<dd><p>Add an electrode to the plot.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>electrode</strong> – An electrode. All electrodes satisfying the
AbstractElectrode interface should work.</p></li>
<li><p><strong>label</strong> – A label for the electrode. If None, defaults to a counting
system, i.e. ‘Electrode 1’, ‘Electrode 2’, …</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="pymatgen.apps.battery.plotter.VoltageProfilePlotter.get_plot">
<code class="descname">get_plot</code><span class="sig-paren">(</span><em>width=8</em>, <em>height=8</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/apps/battery/plotter.html#VoltageProfilePlotter.get_plot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.plotter.VoltageProfilePlotter.get_plot" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a plot object.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>width</strong> – Width of the plot. Defaults to 8 in.</p></li>
<li><p><strong>height</strong> – Height of the plot. Defaults to 6 in.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A matplotlib plot object.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="pymatgen.apps.battery.plotter.VoltageProfilePlotter.get_plot_data">
<code class="descname">get_plot_data</code><span class="sig-paren">(</span><em>electrode</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/apps/battery/plotter.html#VoltageProfilePlotter.get_plot_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.plotter.VoltageProfilePlotter.get_plot_data" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pymatgen.apps.battery.plotter.VoltageProfilePlotter.save">
<code class="descname">save</code><span class="sig-paren">(</span><em>filename</em>, <em>image_format='eps'</em>, <em>width=8</em>, <em>height=6</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/apps/battery/plotter.html#VoltageProfilePlotter.save"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.plotter.VoltageProfilePlotter.save" title="Permalink to this definition">¶</a></dt>
<dd><p>Save the plot to an image file.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>filename</strong> – Filename to save to.</p></li>
<li><p><strong>image_format</strong> – Format to save to. Defaults to eps.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="pymatgen.apps.battery.plotter.VoltageProfilePlotter.show">
<code class="descname">show</code><span class="sig-paren">(</span><em>width=8</em>, <em>height=6</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/apps/battery/plotter.html#VoltageProfilePlotter.show"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.plotter.VoltageProfilePlotter.show" title="Permalink to this definition">¶</a></dt>
<dd><p>Show the voltage profile plot.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>width</strong> – Width of the plot. Defaults to 8 in.</p></li>
<li><p><strong>height</strong> – Height of the plot. Defaults to 6 in.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/pymatgen.apps.battery.plotter.rst.txt"
rel="nofollow">Show Source</a></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" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<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="nav-item nav-item-0"><a href="index.html">pymatgen 2019.5.1 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2011, Pymatgen Development Team.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.0.1.
</div>
<div class="footer">This page uses <a href="http://analytics.google.com/">
Google Analytics</a> to collect statistics. You can disable it by blocking
the JavaScript coming from www.google-analytics.com.
<script type="text/javascript">
(function() {
var ga = document.createElement('script');
ga.src = ('https:' == document.location.protocol ?
'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
ga.setAttribute('async', 'true');
document.documentElement.firstChild.appendChild(ga);
})();
</script>
</div>
</body>
</html>