-
Notifications
You must be signed in to change notification settings - Fork 836
/
pymatgen.apps.battery.battery_abc.html
701 lines (535 loc) · 45.9 KB
/
pymatgen.apps.battery.battery_abc.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
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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>pymatgen.apps.battery.battery_abc module — pymatgen 2021.1.28 documentation</title>
<link rel="canonical" href="https://pymatgen.orgpymatgen.apps.battery.battery_abc.html"/>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="pymatgen.apps.battery.conversion_battery module" href="pymatgen.apps.battery.conversion_battery.html" />
<link rel="prev" title="pymatgen.apps.battery.analyzer module" href="pymatgen.apps.battery.analyzer.html" />
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-33990148-1']);
_gaq.push(['_trackPageview']);
</script>
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" style="background: linear-gradient(0deg, rgba(23,63,162,1) 0%, rgba(0,70,192,1) 100%)" >
<a href="index.html" class="icon icon-home"> pymatgen
</a>
<div class="version">
2021.1.28
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="change_log.html">Change log</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="team.html">Development Team</a></li>
<li class="toctree-l1"><a class="reference internal" href="references.html">References</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">API Docs</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="pymatgen.html">pymatgen package</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="pymatgen.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l4"><a class="reference internal" href="pymatgen.alchemy.html">pymatgen.alchemy package</a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.analysis.html">pymatgen.analysis package</a></li>
<li class="toctree-l4 current"><a class="reference internal" href="pymatgen.apps.html">pymatgen.apps package</a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.cli.html">pymatgen.cli package</a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.command_line.html">pymatgen.command_line package</a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.core.html">pymatgen.core package</a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.electronic_structure.html">pymatgen.electronic_structure package</a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.entries.html">pymatgen.entries package</a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.ext.html">pymatgen.ext package</a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.io.html">pymatgen.io package</a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.optimization.html">pymatgen.optimization package</a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.phonon.html">pymatgen.phonon package</a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.plugins.html">pymatgen.plugins package</a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.symmetry.html">pymatgen.symmetry package</a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.transformations.html">pymatgen.transformations package</a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.util.html">pymatgen.util package</a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.vis.html">pymatgen.vis package</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.html#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.html#module-pymatgen">Module contents</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">pymatgen</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content style-external-links">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li><a href="modules.html">pymatgen</a> »</li>
<li><a href="pymatgen.html">pymatgen package</a> »</li>
<li><a href="pymatgen.apps.html">pymatgen.apps package</a> »</li>
<li><a href="pymatgen.apps.battery.html">pymatgen.apps.battery package</a> »</li>
<li>pymatgen.apps.battery.battery_abc module</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/materialsproject/pymatgen/blob/master/docs_rst/pymatgen.apps.battery.battery_abc.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-pymatgen.apps.battery.battery_abc">
<span id="pymatgen-apps-battery-battery-abc-module"></span><h1>pymatgen.apps.battery.battery_abc module<a class="headerlink" href="#module-pymatgen.apps.battery.battery_abc" title="Permalink to this headline">¶</a></h1>
<p>This module defines the abstract base classes for battery-related classes.
Regardless of the kind of electrode, conversion or insertion, there are many
common definitions and properties, e.g., average voltage, capacity, etc. which
can be defined in a general way. The Abc for battery classes implements some of
these common definitions to allow sharing of common logic between them.</p>
<dl class="py class">
<dt id="pymatgen.apps.battery.battery_abc.AbstractElectrode">
<em class="property">class </em><code class="sig-name descname">AbstractElectrode</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">voltage_pairs</span><span class="p">:</span> <span class="n">Tuple<span class="p">[</span><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair" title="pymatgen.apps.battery.battery_abc.AbstractVoltagePair">pymatgen.apps.battery.battery_abc.AbstractVoltagePair</a><span class="p">]</span></span></em>, <em class="sig-param"><span class="n">working_ion_entry</span><span class="p">:</span> <span class="n"><a class="reference internal" href="pymatgen.entries.computed_entries.html#pymatgen.entries.computed_entries.ComputedEntry" title="pymatgen.entries.computed_entries.ComputedEntry">pymatgen.entries.computed_entries.ComputedEntry</a></span></em>, <em class="sig-param"><span class="n">_framework_formula</span><span class="p">:</span> <span class="n">str</span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py#L98-L452"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">collections.abc.Sequence</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">monty.json.MSONable</span></code></p>
<p>An Abstract Base Class representing an Electrode. It is essentially a
sequence of VoltagePairs. Generally, subclasses only need to implement
three abstract properties: voltage_pairs, working_ion and
working_ion_entry.</p>
<p>The general concept is that all other battery properties such as capacity,
etc. are derived from voltage pairs.</p>
<p>One of the major challenges with representing battery materials is keeping
track of the normalization between different entries. For example, one
entry might be TiO2 with one unit cell whereas another is LiTi2O4 with two
unit cells. When computing battery properties, it is needed to always use
a universal reference state otherwise you have normalization errors (e.g.,
the energy of LiTi2O4 must be divided by two to be compared with TiO2).</p>
<p>For properties such as volume, mass, or mAh transferred within the voltage
pair, a universal convention is necessary. AbstractElectrode can query for
extrinsic properties of several different AbstractVoltagePairs belonging to
a single charge/discharge path and be confident that the normalization is
being carried out properly throughout, even if more AbstractVoltagePairs
are added later.</p>
<p>The universal normalization is defined by the reduced structural framework
of the entries, which is common along the entire charge/discharge path. For
example, LiTi2O4 has a reduced structural framework of TiO2. Another
example is Li9V6P16O58 which would have a reduced structural framework of
V3P8O29. Note that reduced structural frameworks need not be
charge-balanced or physical, e.g. V3P8O29 is not charge-balanced, they are
just a tool for normalization.</p>
<p>Example: for a LiTi2O4 -> TiO2 AbstractVoltagePair, extrinsic quantities
like mAh or cell volumes are given per TiO2 formula unit.</p>
<p>Developers implementing a new battery (other than the two general ones
already implemented) need to implement a VoltagePair and an Electrode.
.. attribute:: voltage_pairs</p>
<blockquote>
<div><p>Objects that represent each voltage step</p>
</div></blockquote>
<dl class="py attribute">
<dt id="pymatgen.apps.battery.battery_abc.AbstractElectrode.working_ion">
<code class="sig-name descname">working_ion</code><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.working_ion" title="Permalink to this definition">¶</a></dt>
<dd><p>Representation of the working ion that only contains element type</p>
</dd></dl>
<dl class="py attribute">
<dt id="pymatgen.apps.battery.battery_abc.AbstractElectrode.working_ion_entry">
<code class="sig-name descname">working_ion_entry</code><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.working_ion_entry" title="Permalink to this definition">¶</a></dt>
<dd><p>Representation of the working_ion that contains the energy</p>
</dd></dl>
<dl class="py attribute">
<dt id="pymatgen.apps.battery.battery_abc.AbstractElectrode.framework">
<code class="sig-name descname">framework</code><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.framework" title="Permalink to this definition">¶</a></dt>
<dd><p>The compositions of one formula unit of the host material</p>
</dd></dl>
<dl class="py method">
<dt id="id0">
<em class="property">property </em><code class="sig-name descname">framework</code><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#id0" title="Permalink to this definition">¶</a></dt>
<dd><p>The composition object representing the framework</p>
</dd></dl>
<dl class="py method">
<dt id="pymatgen.apps.battery.battery_abc.AbstractElectrode.get_average_voltage">
<code class="sig-name descname">get_average_voltage</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">min_voltage</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">max_voltage</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py#L266-L285"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.get_average_voltage" title="Permalink to this definition">¶</a></dt>
<dd><p>Average voltage for path satisfying between a min and max voltage.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>min_voltage</strong> (<em>float</em>) – The minimum allowable voltage for a given
step.</p></li>
<li><p><strong>max_voltage</strong> (<em>float</em>) – The maximum allowable voltage allowable for a
given step.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Average voltage in V across the insertion path (a subset of the
path can be chosen by the optional arguments)</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="pymatgen.apps.battery.battery_abc.AbstractElectrode.get_capacity_grav">
<code class="sig-name descname">get_capacity_grav</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">min_voltage</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">max_voltage</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">use_overall_normalization</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py#L287-L313"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.get_capacity_grav" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the gravimetric capacity of the electrode.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>min_voltage</strong> (<em>float</em>) – The minimum allowable voltage for a given
step.</p></li>
<li><p><strong>max_voltage</strong> (<em>float</em>) – The maximum allowable voltage allowable for a
given step.</p></li>
<li><p><strong>use_overall_normalization</strong> (<em>booL</em>) – If False, normalize by the
discharged state of only the voltage pairs matching the voltage
criteria. if True, use default normalization of the full
electrode path.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Gravimetric capacity in mAh/g across the insertion path (a subset
of the path can be chosen by the optional arguments).</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="pymatgen.apps.battery.battery_abc.AbstractElectrode.get_capacity_vol">
<code class="sig-name descname">get_capacity_vol</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">min_voltage</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">max_voltage</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">use_overall_normalization</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py#L315-L343"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.get_capacity_vol" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the volumetric capacity of the electrode.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>min_voltage</strong> (<em>float</em>) – The minimum allowable voltage for a given
step.</p></li>
<li><p><strong>max_voltage</strong> (<em>float</em>) – The maximum allowable voltage allowable for a
given step.</p></li>
<li><p><strong>use_overall_normalization</strong> (<em>booL</em>) – If False, normalize by the
discharged state of only the voltage pairs matching the voltage
criteria. if True, use default normalization of the full
electrode path.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Volumetric capacity in mAh/cc across the insertion path (a subset
of the path can be chosen by the optional arguments)</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="pymatgen.apps.battery.battery_abc.AbstractElectrode.get_energy_density">
<code class="sig-name descname">get_energy_density</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">min_voltage</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">max_voltage</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">use_overall_normalization</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py#L369-L389"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.get_energy_density" title="Permalink to this definition">¶</a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>min_voltage</strong> (<em>float</em>) – The minimum allowable voltage for a given
step.</p></li>
<li><p><strong>max_voltage</strong> (<em>float</em>) – The maximum allowable voltage allowable for a
given step.</p></li>
<li><p><strong>use_overall_normalization</strong> (<em>booL</em>) – If False, normalize by the
discharged state of only the voltage pairs matching the voltage
criteria. if True, use default normalization of the full
electrode path.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Energy density in Wh/L across the insertion path (a subset of the
path can be chosen by the optional arguments).</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="pymatgen.apps.battery.battery_abc.AbstractElectrode.get_specific_energy">
<code class="sig-name descname">get_specific_energy</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">min_voltage</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">max_voltage</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">use_overall_normalization</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py#L345-L367"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.get_specific_energy" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the specific energy of the battery in mAh/g.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>min_voltage</strong> (<em>float</em>) – The minimum allowable voltage for a given
step.</p></li>
<li><p><strong>max_voltage</strong> (<em>float</em>) – The maximum allowable voltage allowable for a
given step.</p></li>
<li><p><strong>use_overall_normalization</strong> (<em>booL</em>) – If False, normalize by the
discharged state of only the voltage pairs matching the voltage
criteria. if True, use default normalization of the full
electrode path.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Specific energy in Wh/kg across the insertion path (a subset of
the path can be chosen by the optional arguments)</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="pymatgen.apps.battery.battery_abc.AbstractElectrode.get_sub_electrodes">
<code class="sig-name descname">get_sub_electrodes</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">adjacent_only</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py#L248-L264"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.get_sub_electrodes" title="Permalink to this definition">¶</a></dt>
<dd><p>If this electrode contains multiple voltage steps, then it is possible
to use only a subset of the voltage steps to define other electrodes.
Must be implemented for each electrode object.
:param adjacent_only: Only return electrodes from compounds that are</p>
<blockquote>
<div><p>adjacent on the convex hull, i.e. no electrodes returned
will have multiple voltage steps if this is set true</p>
</div></blockquote>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>A list of Electrode objects</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="pymatgen.apps.battery.battery_abc.AbstractElectrode.get_summary_dict">
<code class="sig-name descname">get_summary_dict</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">print_subelectrodes</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span> → Dict<a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py#L412-L452"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.get_summary_dict" title="Permalink to this definition">¶</a></dt>
<dd><p>Generate a summary dict.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>print_subelectrodes</strong> – Also print data on all the possible
subelectrodes.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A summary of this electrode”s properties in dict format.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="pymatgen.apps.battery.battery_abc.AbstractElectrode.max_delta_volume">
<em class="property">property </em><code class="sig-name descname">max_delta_volume</code><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.max_delta_volume" title="Permalink to this definition">¶</a></dt>
<dd><p>Maximum volume change along insertion</p>
</dd></dl>
<dl class="py method">
<dt id="pymatgen.apps.battery.battery_abc.AbstractElectrode.max_voltage">
<em class="property">property </em><code class="sig-name descname">max_voltage</code><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.max_voltage" title="Permalink to this definition">¶</a></dt>
<dd><p>Highest voltage along insertion</p>
</dd></dl>
<dl class="py method">
<dt id="pymatgen.apps.battery.battery_abc.AbstractElectrode.max_voltage_step">
<em class="property">property </em><code class="sig-name descname">max_voltage_step</code><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.max_voltage_step" title="Permalink to this definition">¶</a></dt>
<dd><p>Maximum absolute difference in adjacent voltage steps</p>
</dd></dl>
<dl class="py method">
<dt id="pymatgen.apps.battery.battery_abc.AbstractElectrode.min_voltage">
<em class="property">property </em><code class="sig-name descname">min_voltage</code><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.min_voltage" title="Permalink to this definition">¶</a></dt>
<dd><p>Lowest voltage along insertion</p>
</dd></dl>
<dl class="py method">
<dt id="pymatgen.apps.battery.battery_abc.AbstractElectrode.normalization_mass">
<em class="property">property </em><code class="sig-name descname">normalization_mass</code><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.normalization_mass" title="Permalink to this definition">¶</a></dt>
<dd><p>Mass used for normalization. This is the mass of the discharged
electrode of the last voltage pair.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>Returns</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="pymatgen.apps.battery.battery_abc.AbstractElectrode.normalization_volume">
<em class="property">property </em><code class="sig-name descname">normalization_volume</code><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.normalization_volume" title="Permalink to this definition">¶</a></dt>
<dd><p>Mass used for normalization. This is the vol of the discharged
electrode of the last voltage pair.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>Returns</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="pymatgen.apps.battery.battery_abc.AbstractElectrode.num_steps">
<em class="property">property </em><code class="sig-name descname">num_steps</code><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.num_steps" title="Permalink to this definition">¶</a></dt>
<dd><p>The number of distinct voltage steps in from fully charge to discharge
based on the stable intermediate states</p>
</dd></dl>
<dl class="py attribute">
<dt id="pymatgen.apps.battery.battery_abc.AbstractElectrode.voltage_pairs">
<code class="sig-name descname">voltage_pairs</code><em class="property">: Tuple[AbstractVoltagePair]</em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.voltage_pairs" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="id1">
<em class="property">property </em><code class="sig-name descname">working_ion</code><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#id1" title="Permalink to this definition">¶</a></dt>
<dd><p>working ion as pymatgen Element object</p>
</dd></dl>
<dl class="py attribute">
<dt id="id2">
<code class="sig-name descname">working_ion_entry</code><em class="property">: ComputedEntry</em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#id2" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="pymatgen.apps.battery.battery_abc.AbstractElectrode.x_charge">
<em class="property">property </em><code class="sig-name descname">x_charge</code><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.x_charge" title="Permalink to this definition">¶</a></dt>
<dd><p>The number of working ions per formula unit of host in the charged state</p>
</dd></dl>
<dl class="py method">
<dt id="pymatgen.apps.battery.battery_abc.AbstractElectrode.x_discharge">
<em class="property">property </em><code class="sig-name descname">x_discharge</code><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.x_discharge" title="Permalink to this definition">¶</a></dt>
<dd><p>The number of working ions per formula unit of host in the discharged state</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="pymatgen.apps.battery.battery_abc.AbstractVoltagePair">
<em class="property">class </em><code class="sig-name descname">AbstractVoltagePair</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">voltage</span><span class="p">:</span> <span class="n">float</span></em>, <em class="sig-param"><span class="n">mAh</span><span class="p">:</span> <span class="n">float</span></em>, <em class="sig-param"><span class="n">mass_charge</span><span class="p">:</span> <span class="n">float</span></em>, <em class="sig-param"><span class="n">mass_discharge</span><span class="p">:</span> <span class="n">float</span></em>, <em class="sig-param"><span class="n">vol_charge</span><span class="p">:</span> <span class="n">float</span></em>, <em class="sig-param"><span class="n">vol_discharge</span><span class="p">:</span> <span class="n">float</span></em>, <em class="sig-param"><span class="n">frac_charge</span><span class="p">:</span> <span class="n">float</span></em>, <em class="sig-param"><span class="n">frac_discharge</span><span class="p">:</span> <span class="n">float</span></em>, <em class="sig-param"><span class="n">working_ion_entry</span><span class="p">:</span> <span class="n"><a class="reference internal" href="pymatgen.entries.computed_entries.html#pymatgen.entries.computed_entries.ComputedEntry" title="pymatgen.entries.computed_entries.ComputedEntry">pymatgen.entries.computed_entries.ComputedEntry</a></span></em>, <em class="sig-param"><span class="n">_framework_formula</span><span class="p">:</span> <span class="n">str</span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py#L34-L94"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">monty.json.MSONable</span></code></p>
<p>An Abstract Base Class for a Voltage Pair.</p>
<dl class="py attribute">
<dt id="pymatgen.apps.battery.battery_abc.AbstractVoltagePair.voltage">
<code class="sig-name descname">voltage</code><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.voltage" title="Permalink to this definition">¶</a></dt>
<dd><p>Voltage of voltage pair.</p>
</dd></dl>
<dl class="py attribute">
<dt id="pymatgen.apps.battery.battery_abc.AbstractVoltagePair.mAh">
<code class="sig-name descname">mAh</code><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.mAh" title="Permalink to this definition">¶</a></dt>
<dd><p>Energy in mAh.</p>
</dd></dl>
<dl class="py attribute">
<dt id="pymatgen.apps.battery.battery_abc.AbstractVoltagePair.mass_charge">
<code class="sig-name descname">mass_charge</code><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.mass_charge" title="Permalink to this definition">¶</a></dt>
<dd><p>Mass of charged pair.</p>
</dd></dl>
<dl class="py attribute">
<dt id="pymatgen.apps.battery.battery_abc.AbstractVoltagePair.mass_discharge">
<code class="sig-name descname">mass_discharge</code><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.mass_discharge" title="Permalink to this definition">¶</a></dt>
<dd><p>Mass of discharged pair.</p>
</dd></dl>
<dl class="py attribute">
<dt id="pymatgen.apps.battery.battery_abc.AbstractVoltagePair.vol_charge">
<code class="sig-name descname">vol_charge</code><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.vol_charge" title="Permalink to this definition">¶</a></dt>
<dd><p>Vol of charged pair.</p>
</dd></dl>
<dl class="py attribute">
<dt id="pymatgen.apps.battery.battery_abc.AbstractVoltagePair.vol_discharge">
<code class="sig-name descname">vol_discharge</code><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.vol_discharge" title="Permalink to this definition">¶</a></dt>
<dd><p>Vol of discharged pair.</p>
</dd></dl>
<dl class="py attribute">
<dt id="pymatgen.apps.battery.battery_abc.AbstractVoltagePair.frac_charge">
<code class="sig-name descname">frac_charge</code><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.frac_charge" title="Permalink to this definition">¶</a></dt>
<dd><p>Frac of working ion in charged pair.</p>
</dd></dl>
<dl class="py attribute">
<dt id="pymatgen.apps.battery.battery_abc.AbstractVoltagePair.frac_discharge">
<code class="sig-name descname">frac_discharge</code><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.frac_discharge" title="Permalink to this definition">¶</a></dt>
<dd><p>Frac of working ion in discharged pair.</p>
</dd></dl>
<dl class="py attribute">
<dt id="pymatgen.apps.battery.battery_abc.AbstractVoltagePair.working_ion_entry">
<code class="sig-name descname">working_ion_entry</code><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.working_ion_entry" title="Permalink to this definition">¶</a></dt>
<dd><p>Working ion as an entry.</p>
</dd></dl>
<dl class="py attribute">
<dt id="pymatgen.apps.battery.battery_abc.AbstractVoltagePair.framework">
<code class="sig-name descname">framework</code><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.framework" title="Permalink to this definition">¶</a></dt>
<dd><p>The compositions of one formula unit of the host material</p>
</dd></dl>
<dl class="py attribute">
<dt id="id3">
<code class="sig-name descname">frac_charge</code><em class="property">: float</em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#id3" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="id4">
<code class="sig-name descname">frac_discharge</code><em class="property">: float</em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#id4" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="id5">
<em class="property">property </em><code class="sig-name descname">framework</code><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#id5" title="Permalink to this definition">¶</a></dt>
<dd><p>The composition object representing the framework</p>
</dd></dl>
<dl class="py attribute">
<dt id="id6">
<code class="sig-name descname">mAh</code><em class="property">: float</em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#id6" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="id7">
<code class="sig-name descname">mass_charge</code><em class="property">: float</em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#id7" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="id8">
<code class="sig-name descname">mass_discharge</code><em class="property">: float</em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#id8" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="id9">
<code class="sig-name descname">vol_charge</code><em class="property">: float</em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#id9" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="id10">
<code class="sig-name descname">vol_discharge</code><em class="property">: float</em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#id10" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="id11">
<code class="sig-name descname">voltage</code><em class="property">: float</em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#id11" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="pymatgen.apps.battery.battery_abc.AbstractVoltagePair.working_ion">
<em class="property">property </em><code class="sig-name descname">working_ion</code><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.working_ion" title="Permalink to this definition">¶</a></dt>
<dd><p>working ion as pymatgen Element object</p>
</dd></dl>
<dl class="py attribute">
<dt id="id12">
<code class="sig-name descname">working_ion_entry</code><em class="property">: ComputedEntry</em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#id12" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="pymatgen.apps.battery.battery_abc.AbstractVoltagePair.x_charge">
<em class="property">property </em><code class="sig-name descname">x_charge</code><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.x_charge" title="Permalink to this definition">¶</a></dt>
<dd><p>The number of working ions per formula unit of host in the charged state</p>
</dd></dl>
<dl class="py method">
<dt id="pymatgen.apps.battery.battery_abc.AbstractVoltagePair.x_discharge">
<em class="property">property </em><code class="sig-name descname">x_discharge</code><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2021.1.28/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.x_discharge" title="Permalink to this definition">¶</a></dt>
<dd><p>The number of working ions per formula unit of host in the discharged state</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2011, Pymatgen Development Team
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
<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>