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
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
|
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>pymatgen.apps.battery package — pymatgen 2025.1.24 documentation</title>
<link rel="stylesheet" type="text/css" href="assets/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="assets/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="assets/css/custom.css" />
<link rel="canonical" href="https://pymatgen.orgpymatgen.apps.battery.html"/>
<script src="assets/jquery.js?v=5d32c60e"></script>
<script src="assets/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="assets/documentation_options.js?v=d2bc030c"></script>
<script src="assets/doctools.js?v=9bcbadda"></script>
<script src="assets/sphinx_highlight.js?v=dc90522c"></script>
<script src="assets/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
</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">
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="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="Navigation menu">
<!-- Local TOC -->
<div class="local-toc"><ul>
<li><a class="reference internal" href="#">pymatgen.apps.battery package</a><ul>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#module-pymatgen.apps.battery.analyzer">pymatgen.apps.battery.analyzer module</a><ul>
<li><a class="reference internal" href="#pymatgen.apps.battery.analyzer.BatteryAnalyzer"><code class="docutils literal notranslate"><span class="pre">BatteryAnalyzer</span></code></a><ul>
<li><a class="reference internal" href="#pymatgen.apps.battery.analyzer.BatteryAnalyzer.get_max_capgrav"><code class="docutils literal notranslate"><span class="pre">BatteryAnalyzer.get_max_capgrav()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.analyzer.BatteryAnalyzer.get_max_capvol"><code class="docutils literal notranslate"><span class="pre">BatteryAnalyzer.get_max_capvol()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.analyzer.BatteryAnalyzer.get_removals_int_oxid"><code class="docutils literal notranslate"><span class="pre">BatteryAnalyzer.get_removals_int_oxid()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.analyzer.BatteryAnalyzer.max_ion_insertion"><code class="docutils literal notranslate"><span class="pre">BatteryAnalyzer.max_ion_insertion</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.analyzer.BatteryAnalyzer.max_ion_removal"><code class="docutils literal notranslate"><span class="pre">BatteryAnalyzer.max_ion_removal</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#pymatgen.apps.battery.analyzer.is_redox_active_intercalation"><code class="docutils literal notranslate"><span class="pre">is_redox_active_intercalation()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#module-pymatgen.apps.battery.battery_abc">pymatgen.apps.battery.battery_abc module</a><ul>
<li><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode</span></code></a><ul>
<li><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.voltage_pairs"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.voltage_pairs</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.working_ion"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.working_ion</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.working_ion_entry"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.working_ion_entry</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.framework_formula"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.framework_formula</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.framework"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.framework</span></code></a></li>
<li><a class="reference internal" href="#id0"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.framework_formula</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.get_average_voltage"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.get_average_voltage()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.get_capacity_grav"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.get_capacity_grav()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.get_capacity_vol"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.get_capacity_vol()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.get_energy_density"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.get_energy_density()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.get_specific_energy"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.get_specific_energy()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.get_sub_electrodes"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.get_sub_electrodes()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.get_summary_dict"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.get_summary_dict()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.max_delta_volume"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.max_delta_volume</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.max_voltage"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.max_voltage</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.max_voltage_step"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.max_voltage_step</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.min_voltage"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.min_voltage</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.normalization_mass"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.normalization_mass</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.normalization_volume"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.normalization_volume</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.num_steps"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.num_steps</span></code></a></li>
<li><a class="reference internal" href="#id1"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.voltage_pairs</span></code></a></li>
<li><a class="reference internal" href="#id2"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.working_ion</span></code></a></li>
<li><a class="reference internal" href="#id3"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.working_ion_entry</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.x_charge"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.x_charge</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.x_discharge"><code class="docutils literal notranslate"><span class="pre">AbstractElectrode.x_discharge</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair</span></code></a><ul>
<li><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.voltage"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.voltage</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.mAh"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.mAh</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.mass_charge"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.mass_charge</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.mass_discharge"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.mass_discharge</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.vol_charge"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.vol_charge</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.vol_discharge"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.vol_discharge</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.frac_charge"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.frac_charge</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.frac_discharge"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.frac_discharge</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.working_ion_entry"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.working_ion_entry</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.framework_formula"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.framework_formula</span></code></a></li>
<li><a class="reference internal" href="#id4"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.frac_charge</span></code></a></li>
<li><a class="reference internal" href="#id5"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.frac_discharge</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.framework"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.framework</span></code></a></li>
<li><a class="reference internal" href="#id6"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.framework_formula</span></code></a></li>
<li><a class="reference internal" href="#id7"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.mAh</span></code></a></li>
<li><a class="reference internal" href="#id8"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.mass_charge</span></code></a></li>
<li><a class="reference internal" href="#id9"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.mass_discharge</span></code></a></li>
<li><a class="reference internal" href="#id10"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.vol_charge</span></code></a></li>
<li><a class="reference internal" href="#id11"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.vol_discharge</span></code></a></li>
<li><a class="reference internal" href="#id12"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.voltage</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.working_ion"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.working_ion</span></code></a></li>
<li><a class="reference internal" href="#id13"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.working_ion_entry</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.x_charge"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.x_charge</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.x_discharge"><code class="docutils literal notranslate"><span class="pre">AbstractVoltagePair.x_discharge</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#module-pymatgen.apps.battery.conversion_battery">pymatgen.apps.battery.conversion_battery module</a><ul>
<li><a class="reference internal" href="#pymatgen.apps.battery.conversion_battery.ConversionElectrode"><code class="docutils literal notranslate"><span class="pre">ConversionElectrode</span></code></a><ul>
<li><a class="reference internal" href="#pymatgen.apps.battery.conversion_battery.ConversionElectrode.from_composition_and_entries"><code class="docutils literal notranslate"><span class="pre">ConversionElectrode.from_composition_and_entries()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.conversion_battery.ConversionElectrode.from_composition_and_pd"><code class="docutils literal notranslate"><span class="pre">ConversionElectrode.from_composition_and_pd()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.conversion_battery.ConversionElectrode.get_sub_electrodes"><code class="docutils literal notranslate"><span class="pre">ConversionElectrode.get_sub_electrodes()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.conversion_battery.ConversionElectrode.get_summary_dict"><code class="docutils literal notranslate"><span class="pre">ConversionElectrode.get_summary_dict()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.conversion_battery.ConversionElectrode.initial_comp"><code class="docutils literal notranslate"><span class="pre">ConversionElectrode.initial_comp</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.conversion_battery.ConversionElectrode.initial_comp_formula"><code class="docutils literal notranslate"><span class="pre">ConversionElectrode.initial_comp_formula</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.conversion_battery.ConversionElectrode.is_super_electrode"><code class="docutils literal notranslate"><span class="pre">ConversionElectrode.is_super_electrode()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair"><code class="docutils literal notranslate"><span class="pre">ConversionVoltagePair</span></code></a><ul>
<li><a class="reference internal" href="#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.rxn"><code class="docutils literal notranslate"><span class="pre">ConversionVoltagePair.rxn</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.voltage"><code class="docutils literal notranslate"><span class="pre">ConversionVoltagePair.voltage</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.mAh"><code class="docutils literal notranslate"><span class="pre">ConversionVoltagePair.mAh</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.vol_charge"><code class="docutils literal notranslate"><span class="pre">ConversionVoltagePair.vol_charge</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.vol_discharge"><code class="docutils literal notranslate"><span class="pre">ConversionVoltagePair.vol_discharge</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.mass_charge"><code class="docutils literal notranslate"><span class="pre">ConversionVoltagePair.mass_charge</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.mass_discharge"><code class="docutils literal notranslate"><span class="pre">ConversionVoltagePair.mass_discharge</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.frac_charge"><code class="docutils literal notranslate"><span class="pre">ConversionVoltagePair.frac_charge</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.frac_discharge"><code class="docutils literal notranslate"><span class="pre">ConversionVoltagePair.frac_discharge</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.entries_charge"><code class="docutils literal notranslate"><span class="pre">ConversionVoltagePair.entries_charge</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.entries_discharge"><code class="docutils literal notranslate"><span class="pre">ConversionVoltagePair.entries_discharge</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.working_ion_entry"><code class="docutils literal notranslate"><span class="pre">ConversionVoltagePair.working_ion_entry</span></code></a></li>
<li><a class="reference internal" href="#id14"><code class="docutils literal notranslate"><span class="pre">ConversionVoltagePair.entries_charge</span></code></a></li>
<li><a class="reference internal" href="#id15"><code class="docutils literal notranslate"><span class="pre">ConversionVoltagePair.entries_discharge</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.from_steps"><code class="docutils literal notranslate"><span class="pre">ConversionVoltagePair.from_steps()</span></code></a></li>
<li><a class="reference internal" href="#id16"><code class="docutils literal notranslate"><span class="pre">ConversionVoltagePair.rxn</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#module-pymatgen.apps.battery.insertion_battery">pymatgen.apps.battery.insertion_battery module</a><ul>
<li><a class="reference internal" href="#pymatgen.apps.battery.insertion_battery.InsertionElectrode"><code class="docutils literal notranslate"><span class="pre">InsertionElectrode</span></code></a><ul>
<li><a class="reference internal" href="#pymatgen.apps.battery.insertion_battery.InsertionElectrode.as_dict_legacy"><code class="docutils literal notranslate"><span class="pre">InsertionElectrode.as_dict_legacy()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.insertion_battery.InsertionElectrode.from_dict_legacy"><code class="docutils literal notranslate"><span class="pre">InsertionElectrode.from_dict_legacy()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.insertion_battery.InsertionElectrode.from_entries"><code class="docutils literal notranslate"><span class="pre">InsertionElectrode.from_entries()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.insertion_battery.InsertionElectrode.fully_charged_entry"><code class="docutils literal notranslate"><span class="pre">InsertionElectrode.fully_charged_entry</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.insertion_battery.InsertionElectrode.fully_discharged_entry"><code class="docutils literal notranslate"><span class="pre">InsertionElectrode.fully_discharged_entry</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.insertion_battery.InsertionElectrode.get_all_entries"><code class="docutils literal notranslate"><span class="pre">InsertionElectrode.get_all_entries()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.insertion_battery.InsertionElectrode.get_max_instability"><code class="docutils literal notranslate"><span class="pre">InsertionElectrode.get_max_instability()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.insertion_battery.InsertionElectrode.get_max_muO2"><code class="docutils literal notranslate"><span class="pre">InsertionElectrode.get_max_muO2()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.insertion_battery.InsertionElectrode.get_min_instability"><code class="docutils literal notranslate"><span class="pre">InsertionElectrode.get_min_instability()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.insertion_battery.InsertionElectrode.get_min_muO2"><code class="docutils literal notranslate"><span class="pre">InsertionElectrode.get_min_muO2()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.insertion_battery.InsertionElectrode.get_stable_entries"><code class="docutils literal notranslate"><span class="pre">InsertionElectrode.get_stable_entries()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.insertion_battery.InsertionElectrode.get_sub_electrodes"><code class="docutils literal notranslate"><span class="pre">InsertionElectrode.get_sub_electrodes()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.insertion_battery.InsertionElectrode.get_summary_dict"><code class="docutils literal notranslate"><span class="pre">InsertionElectrode.get_summary_dict()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.insertion_battery.InsertionElectrode.get_unstable_entries"><code class="docutils literal notranslate"><span class="pre">InsertionElectrode.get_unstable_entries()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.insertion_battery.InsertionElectrode.stable_entries"><code class="docutils literal notranslate"><span class="pre">InsertionElectrode.stable_entries</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.insertion_battery.InsertionElectrode.unstable_entries"><code class="docutils literal notranslate"><span class="pre">InsertionElectrode.unstable_entries</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#pymatgen.apps.battery.insertion_battery.InsertionVoltagePair"><code class="docutils literal notranslate"><span class="pre">InsertionVoltagePair</span></code></a><ul>
<li><a class="reference internal" href="#pymatgen.apps.battery.insertion_battery.InsertionVoltagePair.entry_charge"><code class="docutils literal notranslate"><span class="pre">InsertionVoltagePair.entry_charge</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.insertion_battery.InsertionVoltagePair.entry_discharge"><code class="docutils literal notranslate"><span class="pre">InsertionVoltagePair.entry_discharge</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.insertion_battery.InsertionVoltagePair.from_entries"><code class="docutils literal notranslate"><span class="pre">InsertionVoltagePair.from_entries()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#module-pymatgen.apps.battery.plotter">pymatgen.apps.battery.plotter module</a><ul>
<li><a class="reference internal" href="#pymatgen.apps.battery.plotter.VoltageProfilePlotter"><code class="docutils literal notranslate"><span class="pre">VoltageProfilePlotter</span></code></a><ul>
<li><a class="reference internal" href="#pymatgen.apps.battery.plotter.VoltageProfilePlotter.add_electrode"><code class="docutils literal notranslate"><span class="pre">VoltageProfilePlotter.add_electrode()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.plotter.VoltageProfilePlotter.get_plot"><code class="docutils literal notranslate"><span class="pre">VoltageProfilePlotter.get_plot()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.plotter.VoltageProfilePlotter.get_plot_data"><code class="docutils literal notranslate"><span class="pre">VoltageProfilePlotter.get_plot_data()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.plotter.VoltageProfilePlotter.get_plotly_figure"><code class="docutils literal notranslate"><span class="pre">VoltageProfilePlotter.get_plotly_figure()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.plotter.VoltageProfilePlotter.save"><code class="docutils literal notranslate"><span class="pre">VoltageProfilePlotter.save()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.apps.battery.plotter.VoltageProfilePlotter.show"><code class="docutils literal notranslate"><span class="pre">VoltageProfilePlotter.show()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" style="background: linear-gradient(0deg, rgba(23,63,162,1) 0%, rgba(0,70,192,1) 100%)" >
<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="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">pymatgen.apps.battery package</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/materialsproject/pymatgen/blob/master/docs_rst/pymatgen.apps.battery.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">
<section id="module-pymatgen.apps.battery">
<span id="pymatgen-apps-battery-package"></span><h1>pymatgen.apps.battery package<a class="headerlink" href="#module-pymatgen.apps.battery" title="Link to this heading"></a></h1>
<p>This package contains all battery-related application classes, including
representations of InsertionElectrodes and ConversionElectrodes.</p>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading"></a></h2>
</section>
<section id="module-pymatgen.apps.battery.analyzer">
<span id="pymatgen-apps-battery-analyzer-module"></span><h2>pymatgen.apps.battery.analyzer module<a class="headerlink" href="#module-pymatgen.apps.battery.analyzer" title="Link to this heading"></a></h2>
<p>Analysis classes for batteries.</p>
<dl class="py class">
<dt class="sig sig-object py" id="pymatgen.apps.battery.analyzer.BatteryAnalyzer">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">BatteryAnalyzer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">struct_oxid</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">working_ion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'Li'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">oxi_override</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/analyzer.py#L24-L242"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.analyzer.BatteryAnalyzer" title="Link 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 suite of methods for starting with an oxidized structure and determining its potential as a battery.</p>
<p>Pass in a structure for analysis.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>struct_oxid</strong> – a Structure object; oxidation states <em>must</em> be assigned for this structure; disordered
structures should be OK</p></li>
<li><p><strong>working_ion</strong> – a String symbol or Element for the working ion.</p></li>
<li><p><strong>oxi_override</strong> – a dict of String element symbol, Integer oxidation state pairs.
by default, H, C, N, O, F, S, Cl, Se, Br, Te, I are considered anions.</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.apps.battery.analyzer.BatteryAnalyzer.get_max_capgrav">
<span class="sig-name descname"><span class="pre">get_max_capgrav</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">remove</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">insert</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/analyzer.py#L138-L153"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.analyzer.BatteryAnalyzer.get_max_capgrav" title="Link to this definition"></a></dt>
<dd><p>Give max capacity in mAh/g for inserting and removing a charged ion
Note that the weight is normalized to the most ion-packed state,
thus removal of 1 Li from LiFePO4 gives the same capacity as insertion of 1 Li into FePO4.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>remove</strong> – (bool) whether to allow ion removal</p></li>
<li><p><strong>insert</strong> – (bool) whether to allow ion insertion</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>max grav capacity in mAh/g</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.apps.battery.analyzer.BatteryAnalyzer.get_max_capvol">
<span class="sig-name descname"><span class="pre">get_max_capvol</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">remove</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">insert</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volume</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/analyzer.py#L155-L167"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.analyzer.BatteryAnalyzer.get_max_capvol" title="Link to this definition"></a></dt>
<dd><p>Give max capacity in mAh/cc for inserting and removing a charged ion into base structure.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>remove</strong> – (bool) whether to allow ion removal</p></li>
<li><p><strong>insert</strong> – (bool) whether to allow ion insertion</p></li>
<li><p><strong>volume</strong> – (float) volume to use for normalization (default=volume of initial structure)</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>max vol capacity in mAh/cc</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.apps.battery.analyzer.BatteryAnalyzer.get_removals_int_oxid">
<span class="sig-name descname"><span class="pre">get_removals_int_oxid</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/analyzer.py#L169-L191"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.analyzer.BatteryAnalyzer.get_removals_int_oxid" title="Link to this definition"></a></dt>
<dd><p>Get a set of ion removal steps, e.g. set([1 2 4]) etc. in order to
produce integer oxidation states of the redox metals.
If multiple redox metals are present, all combinations of reduction/oxidation are tested.
Note that having more than 3 redox metals will likely slow down the algorithm.</p>
<p class="rubric">Examples</p>
<p>LiFePO4 will return [1]
Li4Fe3Mn1(PO4)4 will return [1, 2, 3, 4])
Li6V4(PO4)6 will return [4, 6]) <em>note that this example is not normalized</em></p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>array of integer ion removals. If you double the unit cell, your answers will be twice as large!</p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.apps.battery.analyzer.BatteryAnalyzer.max_ion_insertion">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">max_ion_insertion</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/analyzer.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.analyzer.BatteryAnalyzer.max_ion_insertion" title="Link to this definition"></a></dt>
<dd><p>Maximum number of ion A that can be inserted while maintaining charge-balance.
No consideration is given to whether there (geometrically speaking) are ion sites to actually accommodate the
extra ions.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>integer amount of ion. Depends on cell size (this is an ‘extrinsic’ function!)</p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.apps.battery.analyzer.BatteryAnalyzer.max_ion_removal">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">max_ion_removal</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/analyzer.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.analyzer.BatteryAnalyzer.max_ion_removal" title="Link to this definition"></a></dt>
<dd><p>Maximum number of ion A that can be removed while maintaining charge-balance.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>integer amount of ion. Depends on cell size (this is an ‘extrinsic’ function!)</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="pymatgen.apps.battery.analyzer.is_redox_active_intercalation">
<span class="sig-name descname"><span class="pre">is_redox_active_intercalation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">element</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/analyzer.py#L245-L267"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.analyzer.is_redox_active_intercalation" title="Link to this definition"></a></dt>
<dd><p>True if element is redox active and interesting for intercalation materials.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>element</strong> – Element object</p>
</dd>
</dl>
</dd></dl>
</section>
<section id="module-pymatgen.apps.battery.battery_abc">
<span id="pymatgen-apps-battery-battery-abc-module"></span><h2>pymatgen.apps.battery.battery_abc module<a class="headerlink" href="#module-pymatgen.apps.battery.battery_abc" title="Link to this heading"></a></h2>
<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 class="sig sig-object py" id="pymatgen.apps.battery.battery_abc.AbstractElectrode">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AbstractElectrode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">voltage_pairs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair" title="pymatgen.apps.battery.battery_abc.AbstractVoltagePair"><span class="pre">AbstractVoltagePair</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">working_ion_entry</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="pymatgen.entries.html#pymatgen.entries.computed_entries.ComputedEntry" title="pymatgen.entries.computed_entries.ComputedEntry"><span class="pre">ComputedEntry</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">framework_formula</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/battery_abc.py#L85-L396"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">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.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pymatgen.apps.battery.battery_abc.AbstractElectrode.voltage_pairs">
<span class="sig-name descname"><span class="pre">voltage_pairs</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.voltage_pairs" title="Link to this definition"></a></dt>
<dd><p>Objects that represent each voltage step</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>tuple[<a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair" title="pymatgen.apps.battery.battery_abc.AbstractVoltagePair">AbstractVoltagePair</a>, …]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pymatgen.apps.battery.battery_abc.AbstractElectrode.working_ion">
<span class="sig-name descname"><span class="pre">working_ion</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.working_ion" title="Link 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 class="sig sig-object py" id="pymatgen.apps.battery.battery_abc.AbstractElectrode.working_ion_entry">
<span class="sig-name descname"><span class="pre">working_ion_entry</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.working_ion_entry" title="Link to this definition"></a></dt>
<dd><p>Representation of the working_ion that contains the energy</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="pymatgen.entries.html#pymatgen.entries.computed_entries.ComputedEntry" title="pymatgen.entries.computed_entries.ComputedEntry">ComputedEntry</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pymatgen.apps.battery.battery_abc.AbstractElectrode.framework_formula">
<span class="sig-name descname"><span class="pre">framework_formula</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.framework_formula" title="Link to this definition"></a></dt>
<dd><p>The compositions of one formula unit of the host material</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>str</p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.apps.battery.battery_abc.AbstractElectrode.framework">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">framework</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.framework" title="Link to this definition"></a></dt>
<dd><p>The composition object representing the framework.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="id0">
<span class="sig-name descname"><span class="pre">framework_formula</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#id0" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.apps.battery.battery_abc.AbstractElectrode.get_average_voltage">
<span class="sig-name descname"><span class="pre">get_average_voltage</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">min_voltage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_voltage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/battery_abc.py#L235-L253"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.get_average_voltage" title="Link 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<span class="colon">:</span></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<span class="colon">:</span></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 class="sig sig-object py" id="pymatgen.apps.battery.battery_abc.AbstractElectrode.get_capacity_grav">
<span class="sig-name descname"><span class="pre">get_capacity_grav</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">min_voltage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_voltage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_overall_normalization</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/battery_abc.py#L255-L278"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.get_capacity_grav" title="Link 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<span class="colon">:</span></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<span class="colon">:</span></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 class="sig sig-object py" id="pymatgen.apps.battery.battery_abc.AbstractElectrode.get_capacity_vol">
<span class="sig-name descname"><span class="pre">get_capacity_vol</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">min_voltage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_voltage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_overall_normalization</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/battery_abc.py#L280-L303"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.get_capacity_vol" title="Link 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<span class="colon">:</span></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<span class="colon">:</span></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 class="sig sig-object py" id="pymatgen.apps.battery.battery_abc.AbstractElectrode.get_energy_density">
<span class="sig-name descname"><span class="pre">get_energy_density</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">min_voltage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_voltage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_overall_normalization</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/battery_abc.py#L326-L344"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.get_energy_density" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></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<span class="colon">:</span></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 class="sig sig-object py" id="pymatgen.apps.battery.battery_abc.AbstractElectrode.get_specific_energy">
<span class="sig-name descname"><span class="pre">get_specific_energy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">min_voltage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_voltage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_overall_normalization</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/battery_abc.py#L305-L324"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.get_specific_energy" title="Link to this definition"></a></dt>
<dd><p>Get the specific energy of the battery in mAh/g.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></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<span class="colon">:</span></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 class="sig sig-object py" id="pymatgen.apps.battery.battery_abc.AbstractElectrode.get_sub_electrodes">
<span class="sig-name descname"><span class="pre">get_sub_electrodes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">adjacent_only</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/battery_abc.py#L217-L233"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.get_sub_electrodes" title="Link 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.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>adjacent_only</strong> – Only return electrodes from compounds that are
adjacent on the convex hull, i.e. no electrodes returned
will have multiple voltage steps if this is set true</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A list of Electrode objects</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.apps.battery.battery_abc.AbstractElectrode.get_summary_dict">
<span class="sig-name descname"><span class="pre">get_summary_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">print_subelectrodes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/battery_abc.py#L362-L396"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.get_summary_dict" title="Link to this definition"></a></dt>
<dd><p>Generate a summary dict.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></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<span class="colon">:</span></dt>
<dd class="field-even"><p>A summary of this electrode’s properties in dict format.</p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.apps.battery.battery_abc.AbstractElectrode.max_delta_volume">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">max_delta_volume</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.max_delta_volume" title="Link to this definition"></a></dt>
<dd><p>Maximum volume change along insertion.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.apps.battery.battery_abc.AbstractElectrode.max_voltage">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">max_voltage</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.max_voltage" title="Link to this definition"></a></dt>
<dd><p>Highest voltage along insertion.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.apps.battery.battery_abc.AbstractElectrode.max_voltage_step">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">max_voltage_step</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.max_voltage_step" title="Link to this definition"></a></dt>
<dd><p>Maximum absolute difference in adjacent voltage steps.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.apps.battery.battery_abc.AbstractElectrode.min_voltage">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">min_voltage</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.min_voltage" title="Link to this definition"></a></dt>
<dd><p>Lowest voltage along insertion.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.apps.battery.battery_abc.AbstractElectrode.normalization_mass">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">normalization_mass</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.normalization_mass" title="Link to this definition"></a></dt>
<dd><p>The mass used for normalization. This is the mass of the discharged
electrode of the last voltage pair.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.apps.battery.battery_abc.AbstractElectrode.normalization_volume">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">normalization_volume</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.normalization_volume" title="Link to this definition"></a></dt>
<dd><p>The mass used for normalization. This is the vol of the discharged
electrode of the last voltage pair.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.apps.battery.battery_abc.AbstractElectrode.num_steps">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">num_steps</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.num_steps" title="Link 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 class="sig sig-object py" id="id1">
<span class="sig-name descname"><span class="pre">voltage_pairs</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair" title="pymatgen.apps.battery.battery_abc.AbstractVoltagePair"><span class="pre">AbstractVoltagePair</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#id1" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="id2">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">working_ion</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#id2" title="Link to this definition"></a></dt>
<dd><p>Working ion as pymatgen Element object.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="id3">
<span class="sig-name descname"><span class="pre">working_ion_entry</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="pymatgen.entries.html#pymatgen.entries.computed_entries.ComputedEntry" title="pymatgen.entries.computed_entries.ComputedEntry"><span class="pre">ComputedEntry</span></a></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#id3" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.apps.battery.battery_abc.AbstractElectrode.x_charge">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">x_charge</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.x_charge" title="Link 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 property">
<dt class="sig sig-object py" id="pymatgen.apps.battery.battery_abc.AbstractElectrode.x_discharge">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">x_discharge</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode.x_discharge" title="Link 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 class="sig sig-object py" id="pymatgen.apps.battery.battery_abc.AbstractVoltagePair">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AbstractVoltagePair</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">voltage</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mAh</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mass_charge</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mass_discharge</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vol_charge</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vol_discharge</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">frac_charge</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">frac_discharge</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">working_ion_entry</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="pymatgen.entries.html#pymatgen.entries.computed_entries.ComputedEntry" title="pymatgen.entries.computed_entries.ComputedEntry"><span class="pre">ComputedEntry</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">framework_formula</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/battery_abc.py#L31-L82"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">MSONable</span></code></p>
<p>An Abstract Base Class for a Voltage Pair.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pymatgen.apps.battery.battery_abc.AbstractVoltagePair.voltage">
<span class="sig-name descname"><span class="pre">voltage</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.voltage" title="Link to this definition"></a></dt>
<dd><p>Voltage of voltage pair.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pymatgen.apps.battery.battery_abc.AbstractVoltagePair.mAh">
<span class="sig-name descname"><span class="pre">mAh</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.mAh" title="Link to this definition"></a></dt>
<dd><p>Energy in mAh.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pymatgen.apps.battery.battery_abc.AbstractVoltagePair.mass_charge">
<span class="sig-name descname"><span class="pre">mass_charge</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.mass_charge" title="Link to this definition"></a></dt>
<dd><p>Mass of charged pair.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pymatgen.apps.battery.battery_abc.AbstractVoltagePair.mass_discharge">
<span class="sig-name descname"><span class="pre">mass_discharge</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.mass_discharge" title="Link to this definition"></a></dt>
<dd><p>Mass of discharged pair.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pymatgen.apps.battery.battery_abc.AbstractVoltagePair.vol_charge">
<span class="sig-name descname"><span class="pre">vol_charge</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.vol_charge" title="Link to this definition"></a></dt>
<dd><p>Vol of charged pair.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pymatgen.apps.battery.battery_abc.AbstractVoltagePair.vol_discharge">
<span class="sig-name descname"><span class="pre">vol_discharge</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.vol_discharge" title="Link to this definition"></a></dt>
<dd><p>Vol of discharged pair.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pymatgen.apps.battery.battery_abc.AbstractVoltagePair.frac_charge">
<span class="sig-name descname"><span class="pre">frac_charge</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.frac_charge" title="Link to this definition"></a></dt>
<dd><p>Frac of working ion in charged pair.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pymatgen.apps.battery.battery_abc.AbstractVoltagePair.frac_discharge">
<span class="sig-name descname"><span class="pre">frac_discharge</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.frac_discharge" title="Link to this definition"></a></dt>
<dd><p>Frac of working ion in discharged pair.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pymatgen.apps.battery.battery_abc.AbstractVoltagePair.working_ion_entry">
<span class="sig-name descname"><span class="pre">working_ion_entry</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.working_ion_entry" title="Link to this definition"></a></dt>
<dd><p>Working ion as an entry.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="pymatgen.entries.html#pymatgen.entries.computed_entries.ComputedEntry" title="pymatgen.entries.computed_entries.ComputedEntry">ComputedEntry</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pymatgen.apps.battery.battery_abc.AbstractVoltagePair.framework_formula">
<span class="sig-name descname"><span class="pre">framework_formula</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.framework_formula" title="Link to this definition"></a></dt>
<dd><p>The compositions of one formula unit of the host material</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>str</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="id4">
<span class="sig-name descname"><span class="pre">frac_charge</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#id4" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="id5">
<span class="sig-name descname"><span class="pre">frac_discharge</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#id5" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.apps.battery.battery_abc.AbstractVoltagePair.framework">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">framework</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="pymatgen.core.html#pymatgen.core.composition.Composition" title="pymatgen.core.composition.Composition"><span class="pre">Composition</span></a></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.framework" title="Link to this definition"></a></dt>
<dd><p>The composition object representing the framework.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="id6">
<span class="sig-name descname"><span class="pre">framework_formula</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#id6" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="id7">
<span class="sig-name descname"><span class="pre">mAh</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#id7" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="id8">
<span class="sig-name descname"><span class="pre">mass_charge</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#id8" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="id9">
<span class="sig-name descname"><span class="pre">mass_discharge</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#id9" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="id10">
<span class="sig-name descname"><span class="pre">vol_charge</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#id10" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="id11">
<span class="sig-name descname"><span class="pre">vol_discharge</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#id11" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="id12">
<span class="sig-name descname"><span class="pre">voltage</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#id12" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.apps.battery.battery_abc.AbstractVoltagePair.working_ion">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">working_ion</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="pymatgen.core.html#pymatgen.core.periodic_table.Element" title="pymatgen.core.periodic_table.Element"><span class="pre">Element</span></a></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.working_ion" title="Link to this definition"></a></dt>
<dd><p>Working ion as pymatgen Element object.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="id13">
<span class="sig-name descname"><span class="pre">working_ion_entry</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="pymatgen.entries.html#pymatgen.entries.computed_entries.ComputedEntry" title="pymatgen.entries.computed_entries.ComputedEntry"><span class="pre">ComputedEntry</span></a></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#id13" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.apps.battery.battery_abc.AbstractVoltagePair.x_charge">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">x_charge</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.x_charge" title="Link 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 property">
<dt class="sig sig-object py" id="pymatgen.apps.battery.battery_abc.AbstractVoltagePair.x_discharge">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">x_discharge</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/battery_abc.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair.x_discharge" title="Link 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>
</section>
<section id="module-pymatgen.apps.battery.conversion_battery">
<span id="pymatgen-apps-battery-conversion-battery-module"></span><h2>pymatgen.apps.battery.conversion_battery module<a class="headerlink" href="#module-pymatgen.apps.battery.conversion_battery" title="Link to this heading"></a></h2>
<p>This module contains the classes to build a ConversionElectrode.</p>
<dl class="py class">
<dt class="sig sig-object py" id="pymatgen.apps.battery.conversion_battery.ConversionElectrode">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ConversionElectrode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">voltage_pairs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair" title="pymatgen.apps.battery.battery_abc.AbstractVoltagePair"><span class="pre">AbstractVoltagePair</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">working_ion_entry</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="pymatgen.entries.html#pymatgen.entries.computed_entries.ComputedEntry" title="pymatgen.entries.computed_entries.ComputedEntry"><span class="pre">ComputedEntry</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">framework_formula</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">initial_comp_formula</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/conversion_battery.py#L24-L268"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.conversion_battery.ConversionElectrode" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode" title="pymatgen.apps.battery.battery_abc.AbstractElectrode"><code class="xref py py-class docutils literal notranslate"><span class="pre">AbstractElectrode</span></code></a></p>
<p>A ConversionElectrode, since it is dataclass
this object can be constructed for the attributes.
However, it is usually easier to construct a ConversionElectrode using one of the classmethod
constructors provided.</p>
<dl>
<dt>Attribute:</dt><dd><p>voltage_pairs: The voltage pairs making up the Conversion Electrode.
working_ion_entry: A single ComputedEntry or PDEntry</p>
<blockquote>
<div><p>representing the element that carries charge across the
battery, e.g. Li.</p>
</div></blockquote>
<dl class="simple">
<dt>initial_comp_formula: Starting composition for ConversionElectrode represented</dt><dd><p>as a string/formula.</p>
</dd>
</dl>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.apps.battery.conversion_battery.ConversionElectrode.from_composition_and_entries">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_composition_and_entries</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">comp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">entries_in_chemsys</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">working_ion_symbol</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'Li'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allow_unstable</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Self</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/conversion_battery.py#L109-L127"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.conversion_battery.ConversionElectrode.from_composition_and_entries" title="Link to this definition"></a></dt>
<dd><p>Convenience constructor to make a ConversionElectrode from a
composition and all entries in a chemical system.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>comp</strong> – Starting composition for ConversionElectrode, e.g.
Composition(“FeF3”)</p></li>
<li><p><strong>entries_in_chemsys</strong> – Sequence containing all entries in a
chemical system. e.g. all Li-Fe-F containing entries.</p></li>
<li><p><strong>working_ion_symbol</strong> – Element symbol of working ion. Defaults to Li.</p></li>
<li><p><strong>allow_unstable</strong> – If True, allow any composition to be used as the
starting point of a conversion voltage curve, this is useful
for comparing with insertion electrodes</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.apps.battery.conversion_battery.ConversionElectrode.from_composition_and_pd">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_composition_and_pd</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">comp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pd</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="pymatgen.analysis.html#pymatgen.analysis.phase_diagram.PhaseDiagram" title="pymatgen.analysis.phase_diagram.PhaseDiagram"><span class="pre">PhaseDiagram</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">working_ion_symbol</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'Li'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allow_unstable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Self</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/conversion_battery.py#L47-L107"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.conversion_battery.ConversionElectrode.from_composition_and_pd" title="Link to this definition"></a></dt>
<dd><p>Convenience constructor to make a ConversionElectrode from a
composition and a phase diagram.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>comp</strong> – Starting composition for ConversionElectrode, e.g.
Composition(“FeF3”)</p></li>
<li><p><strong>pd</strong> – A PhaseDiagram of the relevant system (e.g., Li-Fe-F)</p></li>
<li><p><strong>working_ion_symbol</strong> – Element symbol of working ion. Defaults to Li.</p></li>
<li><p><strong>allow_unstable</strong> – Allow compositions that are unstable</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.apps.battery.conversion_battery.ConversionElectrode.get_sub_electrodes">
<span class="sig-name descname"><span class="pre">get_sub_electrodes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">adjacent_only</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/conversion_battery.py#L129-L168"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.conversion_battery.ConversionElectrode.get_sub_electrodes" title="Link 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.
For example, an LiTiO2 electrode might contain three subelectrodes:
[LiTiO2 –> TiO2, LiTiO2 –> Li0.5TiO2, Li0.5TiO2 –> TiO2]
This method can be used to return all the subelectrodes with some
options.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>adjacent_only</strong> – Only return electrodes from compounds that are
adjacent on the convex hull, i.e. no electrodes returned
will have multiple voltage steps if this is set true</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A list of ConversionElectrode objects</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.apps.battery.conversion_battery.ConversionElectrode.get_summary_dict">
<span class="sig-name descname"><span class="pre">get_summary_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">print_subelectrodes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/conversion_battery.py#L239-L268"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.conversion_battery.ConversionElectrode.get_summary_dict" title="Link to this definition"></a></dt>
<dd><p>Generate a summary dict.
Populates the summary dict with the basic information from the parent method then populates more information.
Since the parent method calls self.get_summary_dict(print_subelectrodes=True) for the subelectrodes.
The current method will be called from within super().get_summary_dict.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></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<span class="colon">:</span></dt>
<dd class="field-even"><p>A summary of this electrode’s properties in dict format.</p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.apps.battery.conversion_battery.ConversionElectrode.initial_comp">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">initial_comp</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="pymatgen.core.html#pymatgen.core.composition.Composition" title="pymatgen.core.composition.Composition"><span class="pre">Composition</span></a></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/conversion_battery.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.conversion_battery.ConversionElectrode.initial_comp" title="Link to this definition"></a></dt>
<dd><p>The pymatgen Composition representation of the initial composition.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pymatgen.apps.battery.conversion_battery.ConversionElectrode.initial_comp_formula">
<span class="sig-name descname"><span class="pre">initial_comp_formula</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/conversion_battery.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.conversion_battery.ConversionElectrode.initial_comp_formula" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.apps.battery.conversion_battery.ConversionElectrode.is_super_electrode">
<span class="sig-name descname"><span class="pre">is_super_electrode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">conversion_electrode</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/conversion_battery.py#L170-L192"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.conversion_battery.ConversionElectrode.is_super_electrode" title="Link to this definition"></a></dt>
<dd><p>Check if a particular conversion electrode is a sub electrode of the
current electrode. Starting from a more lithiated state may result in
a subelectrode that is essentially on the same path. For example, a
ConversionElectrode formed by starting from an FePO4 composition would
be a super_electrode of a ConversionElectrode formed from an LiFePO4
composition.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="pymatgen.apps.battery.conversion_battery.ConversionVoltagePair">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ConversionVoltagePair</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">voltage</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mAh</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mass_charge</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mass_discharge</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vol_charge</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vol_discharge</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">frac_charge</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">frac_discharge</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">working_ion_entry</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="pymatgen.entries.html#pymatgen.entries.computed_entries.ComputedEntry" title="pymatgen.entries.computed_entries.ComputedEntry"><span class="pre">ComputedEntry</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">framework_formula</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rxn</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="pymatgen.analysis.html#pymatgen.analysis.reaction_calculator.BalancedReaction" title="pymatgen.analysis.reaction_calculator.BalancedReaction"><span class="pre">BalancedReaction</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">entries_charge</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="pymatgen.entries.html#pymatgen.entries.computed_entries.ComputedEntry" title="pymatgen.entries.computed_entries.ComputedEntry"><span class="pre">ComputedEntry</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">entries_discharge</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="pymatgen.entries.html#pymatgen.entries.computed_entries.ComputedEntry" title="pymatgen.entries.computed_entries.ComputedEntry"><span class="pre">ComputedEntry</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/conversion_battery.py#L271-L399"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair" title="pymatgen.apps.battery.battery_abc.AbstractVoltagePair"><code class="xref py py-class docutils literal notranslate"><span class="pre">AbstractVoltagePair</span></code></a></p>
<p>A VoltagePair representing a Conversion Reaction with a defined voltage.
Typically not initialized directly but rather used by ConversionElectrode.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.rxn">
<span class="sig-name descname"><span class="pre">rxn</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/conversion_battery.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.rxn" title="Link to this definition"></a></dt>
<dd><p>BalancedReaction for the step</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="pymatgen.analysis.html#pymatgen.analysis.reaction_calculator.BalancedReaction" title="pymatgen.analysis.reaction_calculator.BalancedReaction">BalancedReaction</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.voltage">
<span class="sig-name descname"><span class="pre">voltage</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/conversion_battery.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.voltage" title="Link to this definition"></a></dt>
<dd><p>Voltage for the step</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.mAh">
<span class="sig-name descname"><span class="pre">mAh</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/conversion_battery.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.mAh" title="Link to this definition"></a></dt>
<dd><p>Capacity of the step</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.vol_charge">
<span class="sig-name descname"><span class="pre">vol_charge</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/conversion_battery.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.vol_charge" title="Link to this definition"></a></dt>
<dd><p>Volume of charged state</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.vol_discharge">
<span class="sig-name descname"><span class="pre">vol_discharge</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/conversion_battery.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.vol_discharge" title="Link to this definition"></a></dt>
<dd><p>Volume of discharged state</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.mass_charge">
<span class="sig-name descname"><span class="pre">mass_charge</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/conversion_battery.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.mass_charge" title="Link to this definition"></a></dt>
<dd><p>Mass of charged state</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.mass_discharge">
<span class="sig-name descname"><span class="pre">mass_discharge</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/conversion_battery.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.mass_discharge" title="Link to this definition"></a></dt>
<dd><p>Mass of discharged state</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.frac_charge">
<span class="sig-name descname"><span class="pre">frac_charge</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/conversion_battery.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.frac_charge" title="Link to this definition"></a></dt>
<dd><p>Fraction of working ion in the charged state</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.frac_discharge">
<span class="sig-name descname"><span class="pre">frac_discharge</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/conversion_battery.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.frac_discharge" title="Link to this definition"></a></dt>
<dd><p>Fraction of working ion in the discharged state</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.entries_charge">
<span class="sig-name descname"><span class="pre">entries_charge</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/conversion_battery.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.entries_charge" title="Link to this definition"></a></dt>
<dd><p>Entries representing decompositions products
in the charged state. Enumerates the decompositions products at the tieline,
so the number of entries will be one fewer than the dimensions of the phase
diagram</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>[<a class="reference internal" href="pymatgen.entries.html#pymatgen.entries.computed_entries.ComputedEntry" title="pymatgen.entries.computed_entries.ComputedEntry">ComputedEntry</a>]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.entries_discharge">
<span class="sig-name descname"><span class="pre">entries_discharge</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/conversion_battery.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.entries_discharge" title="Link to this definition"></a></dt>
<dd><p>Entries representing decompositions products
in the discharged state. Enumerates the decompositions products at the tieline,
so the number of entries will be one fewer than the dimensions of the phase
diagram</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>[<a class="reference internal" href="pymatgen.entries.html#pymatgen.entries.computed_entries.ComputedEntry" title="pymatgen.entries.computed_entries.ComputedEntry">ComputedEntry</a>]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.working_ion_entry">
<span class="sig-name descname"><span class="pre">working_ion_entry</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/conversion_battery.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.working_ion_entry" title="Link to this definition"></a></dt>
<dd><p>Entry of the working ion.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="pymatgen.entries.html#pymatgen.entries.computed_entries.ComputedEntry" title="pymatgen.entries.computed_entries.ComputedEntry">ComputedEntry</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="id14">
<span class="sig-name descname"><span class="pre">entries_charge</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="pymatgen.entries.html#pymatgen.entries.computed_entries.ComputedEntry" title="pymatgen.entries.computed_entries.ComputedEntry"><span class="pre">ComputedEntry</span></a><span class="p"><span class="pre">]</span></span></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/conversion_battery.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#id14" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="id15">
<span class="sig-name descname"><span class="pre">entries_discharge</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="pymatgen.entries.html#pymatgen.entries.computed_entries.ComputedEntry" title="pymatgen.entries.computed_entries.ComputedEntry"><span class="pre">ComputedEntry</span></a><span class="p"><span class="pre">]</span></span></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/conversion_battery.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#id15" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.from_steps">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_steps</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">step1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">step2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">normalization_els</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">framework_formula</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Self</span></span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/conversion_battery.py#L301-L388"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.conversion_battery.ConversionVoltagePair.from_steps" title="Link to this definition"></a></dt>
<dd><p>Create a ConversionVoltagePair from two steps in the element profile
from a PD analysis.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>step1</strong> – Starting step</p></li>
<li><p><strong>step2</strong> – Ending step</p></li>
<li><p><strong>normalization_els</strong> – Elements to normalize the reaction by. To
ensure correct capacities.</p></li>
<li><p><strong>framework_formula</strong> – Formula of the framework.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="id16">
<span class="sig-name descname"><span class="pre">rxn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="pymatgen.analysis.html#pymatgen.analysis.reaction_calculator.BalancedReaction" title="pymatgen.analysis.reaction_calculator.BalancedReaction"><span class="pre">BalancedReaction</span></a></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/conversion_battery.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#id16" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
<section id="module-pymatgen.apps.battery.insertion_battery">
<span id="pymatgen-apps-battery-insertion-battery-module"></span><h2>pymatgen.apps.battery.insertion_battery module<a class="headerlink" href="#module-pymatgen.apps.battery.insertion_battery" title="Link to this heading"></a></h2>
<p>This module is used for analysis of materials with potential application as
intercalation batteries.</p>
<dl class="py class">
<dt class="sig sig-object py" id="pymatgen.apps.battery.insertion_battery.InsertionElectrode">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">InsertionElectrode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">voltage_pairs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair" title="pymatgen.apps.battery.battery_abc.AbstractVoltagePair"><span class="pre">AbstractVoltagePair</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">working_ion_entry</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="pymatgen.entries.html#pymatgen.entries.computed_entries.ComputedEntry" title="pymatgen.entries.computed_entries.ComputedEntry"><span class="pre">ComputedEntry</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">framework_formula</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stable_entries</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="pymatgen.entries.html#pymatgen.entries.computed_entries.ComputedEntry" title="pymatgen.entries.computed_entries.ComputedEntry"><span class="pre">ComputedEntry</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">unstable_entries</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="pymatgen.entries.html#pymatgen.entries.computed_entries.ComputedEntry" title="pymatgen.entries.computed_entries.ComputedEntry"><span class="pre">ComputedEntry</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/insertion_battery.py#L29-L379"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.insertion_battery.InsertionElectrode" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode" title="pymatgen.apps.battery.battery_abc.AbstractElectrode"><code class="xref py py-class docutils literal notranslate"><span class="pre">AbstractElectrode</span></code></a></p>
<p>A set of topotactically related compounds, with different amounts of a
single element, e.g. TiO2 and LiTiO2, that can be used to define an
insertion battery electrode.</p>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.apps.battery.insertion_battery.InsertionElectrode.as_dict_legacy">
<span class="sig-name descname"><span class="pre">as_dict_legacy</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/insertion_battery.py#L372-L379"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.insertion_battery.InsertionElectrode.as_dict_legacy" title="Link to this definition"></a></dt>
<dd><p>Get MSONable dict.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.apps.battery.insertion_battery.InsertionElectrode.from_dict_legacy">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_dict_legacy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dct</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Self</span></span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/insertion_battery.py#L358-L370"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.insertion_battery.InsertionElectrode.from_dict_legacy" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>dct</strong> (<em>dict</em>) – Dict representation.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>InsertionElectrode</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.apps.battery.insertion_battery.InsertionElectrode.from_entries">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_entries</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entries</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="pymatgen.entries.html#pymatgen.entries.computed_entries.ComputedEntry" title="pymatgen.entries.computed_entries.ComputedEntry"><span class="pre">ComputedEntry</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="pymatgen.entries.html#pymatgen.entries.computed_entries.ComputedStructureEntry" title="pymatgen.entries.computed_entries.ComputedStructureEntry"><span class="pre">ComputedStructureEntry</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">working_ion_entry</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="pymatgen.entries.html#pymatgen.entries.computed_entries.ComputedEntry" title="pymatgen.entries.computed_entries.ComputedEntry"><span class="pre">ComputedEntry</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="pymatgen.entries.html#pymatgen.entries.computed_entries.ComputedStructureEntry" title="pymatgen.entries.computed_entries.ComputedStructureEntry"><span class="pre">ComputedStructureEntry</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="pymatgen.analysis.html#pymatgen.analysis.phase_diagram.PDEntry" title="pymatgen.analysis.phase_diagram.PDEntry"><span class="pre">PDEntry</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">strip_structures</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Self</span></span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/insertion_battery.py#L39-L118"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.insertion_battery.InsertionElectrode.from_entries" title="Link to this definition"></a></dt>
<dd><p>Create a new InsertionElectrode.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>entries</strong> – A list of ComputedEntries, ComputedStructureEntries, or
subclasses representing the different topotactic states
of the battery, e.g. TiO2 and LiTiO2.</p></li>
<li><p><strong>working_ion_entry</strong> – A single ComputedEntry or PDEntry
representing the element that carries charge across the
battery, e.g. Li.</p></li>
<li><p><strong>strip_structures</strong> – Since the electrode document only uses volume we can make the
electrode object significantly leaner by dropping the structure data.
If this parameter is set to True, the ComputedStructureEntry will be
replaced with a ComputedEntry and the volume will be stored in
ComputedEntry.data[‘volume’]. If entries provided are ComputedEntries,
must set strip_structures=False.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.apps.battery.insertion_battery.InsertionElectrode.fully_charged_entry">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fully_charged_entry</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/insertion_battery.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.insertion_battery.InsertionElectrode.fully_charged_entry" title="Link to this definition"></a></dt>
<dd><p>The most charged entry along the topotactic path.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.apps.battery.insertion_battery.InsertionElectrode.fully_discharged_entry">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fully_discharged_entry</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/insertion_battery.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.insertion_battery.InsertionElectrode.fully_discharged_entry" title="Link to this definition"></a></dt>
<dd><p>The most discharged entry along the topotactic path.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.apps.battery.insertion_battery.InsertionElectrode.get_all_entries">
<span class="sig-name descname"><span class="pre">get_all_entries</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">charge_to_discharge</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/insertion_battery.py#L148-L167"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.insertion_battery.InsertionElectrode.get_all_entries" title="Link to this definition"></a></dt>
<dd><p>Return all entries input for the electrode.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>charge_to_discharge</strong> – order from most charge to most discharged state? Defaults to
True.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A list of all entries in the electrode (both stable and unstable),
ordered by amount of the working ion.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.apps.battery.insertion_battery.InsertionElectrode.get_max_instability">
<span class="sig-name descname"><span class="pre">get_max_instability</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">min_voltage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_voltage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/insertion_battery.py#L179-L196"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.insertion_battery.InsertionElectrode.get_max_instability" title="Link to this definition"></a></dt>
<dd><p>The maximum instability along a path for a specific voltage range.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>min_voltage</strong> – The minimum allowable voltage.</p></li>
<li><p><strong>max_voltage</strong> – The maximum allowable voltage.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Maximum decomposition energy of all compounds along 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 class="sig sig-object py" id="pymatgen.apps.battery.insertion_battery.InsertionElectrode.get_max_muO2">
<span class="sig-name descname"><span class="pre">get_max_muO2</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">min_voltage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_voltage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/insertion_battery.py#L217-L235"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.insertion_battery.InsertionElectrode.get_max_muO2" title="Link to this definition"></a></dt>
<dd><p>Maximum critical oxygen chemical potential along path.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>min_voltage</strong> – The minimum allowable voltage.</p></li>
<li><p><strong>max_voltage</strong> – The maximum allowable voltage.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Maximum critical oxygen chemical of all compounds along 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 class="sig sig-object py" id="pymatgen.apps.battery.insertion_battery.InsertionElectrode.get_min_instability">
<span class="sig-name descname"><span class="pre">get_min_instability</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">min_voltage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_voltage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/insertion_battery.py#L198-L215"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.insertion_battery.InsertionElectrode.get_min_instability" title="Link to this definition"></a></dt>
<dd><p>The minimum instability along a path for a specific voltage range.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>min_voltage</strong> – The minimum allowable voltage.</p></li>
<li><p><strong>max_voltage</strong> – The maximum allowable voltage.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Minimum decomposition energy of all compounds along 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 class="sig sig-object py" id="pymatgen.apps.battery.insertion_battery.InsertionElectrode.get_min_muO2">
<span class="sig-name descname"><span class="pre">get_min_muO2</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">min_voltage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_voltage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/insertion_battery.py#L237-L256"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.insertion_battery.InsertionElectrode.get_min_muO2" title="Link to this definition"></a></dt>
<dd><p>Minimum critical oxygen chemical potential along path.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>min_voltage</strong> – The minimum allowable voltage for a given step</p></li>
<li><p><strong>max_voltage</strong> – The maximum allowable voltage allowable for a given
step</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Minimum critical oxygen chemical of all compounds along 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 class="sig sig-object py" id="pymatgen.apps.battery.insertion_battery.InsertionElectrode.get_stable_entries">
<span class="sig-name descname"><span class="pre">get_stable_entries</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">charge_to_discharge</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/insertion_battery.py#L120-L132"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.insertion_battery.InsertionElectrode.get_stable_entries" title="Link to this definition"></a></dt>
<dd><p>Get the stable entries.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>charge_to_discharge</strong> – order from most charge to most discharged
state? Default to True.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A list of stable entries in the electrode, ordered by amount of the
working ion.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.apps.battery.insertion_battery.InsertionElectrode.get_sub_electrodes">
<span class="sig-name descname"><span class="pre">get_sub_electrodes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">adjacent_only</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include_myself</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/insertion_battery.py#L258-L303"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.insertion_battery.InsertionElectrode.get_sub_electrodes" title="Link 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.
For example, an LiTiO2 electrode might contain three subelectrodes:
[LiTiO2 –> TiO2, LiTiO2 –> Li0.5TiO2, Li0.5TiO2 –> TiO2]
This method can be used to return all the subelectrodes with some
options.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>adjacent_only</strong> – Only return electrodes from compounds that are
adjacent on the convex hull, i.e. no electrodes returned
will have multiple voltage steps if this is set True.</p></li>
<li><p><strong>include_myself</strong> – Include this identical electrode in the list of
results.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A list of InsertionElectrode objects</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.apps.battery.insertion_battery.InsertionElectrode.get_summary_dict">
<span class="sig-name descname"><span class="pre">get_summary_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">print_subelectrodes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/insertion_battery.py#L305-L346"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.insertion_battery.InsertionElectrode.get_summary_dict" title="Link to this definition"></a></dt>
<dd><p>Generate a summary dict.
Populates the summary dict with the basic information from the parent method then populates more information.
Since the parent method calls self.get_summary_dict(print_subelectrodes=True) for the subelectrodes.
The current method will be called from within super().get_summary_dict.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></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<span class="colon">:</span></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 class="sig sig-object py" id="pymatgen.apps.battery.insertion_battery.InsertionElectrode.get_unstable_entries">
<span class="sig-name descname"><span class="pre">get_unstable_entries</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">charge_to_discharge</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/insertion_battery.py#L134-L146"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.insertion_battery.InsertionElectrode.get_unstable_entries" title="Link to this definition"></a></dt>
<dd><p>Get the unstable entries for the electrode.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>charge_to_discharge</strong> – Order from most charge to most discharged
state? Defaults to True.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A list of unstable entries in the electrode, ordered by amount of
the working ion.</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pymatgen.apps.battery.insertion_battery.InsertionElectrode.stable_entries">
<span class="sig-name descname"><span class="pre">stable_entries</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="pymatgen.entries.html#pymatgen.entries.computed_entries.ComputedEntry" title="pymatgen.entries.computed_entries.ComputedEntry"><span class="pre">ComputedEntry</span></a><span class="p"><span class="pre">]</span></span></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/insertion_battery.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.insertion_battery.InsertionElectrode.stable_entries" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pymatgen.apps.battery.insertion_battery.InsertionElectrode.unstable_entries">
<span class="sig-name descname"><span class="pre">unstable_entries</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="pymatgen.entries.html#pymatgen.entries.computed_entries.ComputedEntry" title="pymatgen.entries.computed_entries.ComputedEntry"><span class="pre">ComputedEntry</span></a><span class="p"><span class="pre">]</span></span></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/insertion_battery.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.insertion_battery.InsertionElectrode.unstable_entries" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="pymatgen.apps.battery.insertion_battery.InsertionVoltagePair">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">InsertionVoltagePair</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">voltage</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mAh</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mass_charge</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mass_discharge</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vol_charge</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vol_discharge</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">frac_charge</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">frac_discharge</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">working_ion_entry</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="pymatgen.entries.html#pymatgen.entries.computed_entries.ComputedEntry" title="pymatgen.entries.computed_entries.ComputedEntry"><span class="pre">ComputedEntry</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">framework_formula</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">entry_charge</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="pymatgen.entries.html#pymatgen.entries.computed_entries.ComputedEntry" title="pymatgen.entries.computed_entries.ComputedEntry"><span class="pre">ComputedEntry</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">entry_discharge</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="pymatgen.entries.html#pymatgen.entries.computed_entries.ComputedEntry" title="pymatgen.entries.computed_entries.ComputedEntry"><span class="pre">ComputedEntry</span></a></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/insertion_battery.py#L382-L507"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.insertion_battery.InsertionVoltagePair" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractVoltagePair" title="pymatgen.apps.battery.battery_abc.AbstractVoltagePair"><code class="xref py py-class docutils literal notranslate"><span class="pre">AbstractVoltagePair</span></code></a></p>
<p>A voltage pair for an insertion battery, e.g. LiFePO4 -> FePO4.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pymatgen.apps.battery.insertion_battery.InsertionVoltagePair.entry_charge">
<span class="sig-name descname"><span class="pre">entry_charge</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="pymatgen.entries.html#pymatgen.entries.computed_entries.ComputedEntry" title="pymatgen.entries.computed_entries.ComputedEntry"><span class="pre">ComputedEntry</span></a></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/insertion_battery.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.insertion_battery.InsertionVoltagePair.entry_charge" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pymatgen.apps.battery.insertion_battery.InsertionVoltagePair.entry_discharge">
<span class="sig-name descname"><span class="pre">entry_discharge</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="pymatgen.entries.html#pymatgen.entries.computed_entries.ComputedEntry" title="pymatgen.entries.computed_entries.ComputedEntry"><span class="pre">ComputedEntry</span></a></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/apps/battery/insertion_battery.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.insertion_battery.InsertionVoltagePair.entry_discharge" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.apps.battery.insertion_battery.InsertionVoltagePair.from_entries">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_entries</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entry1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">entry2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">working_ion_entry</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Self</span></span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/insertion_battery.py#L389-L497"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.insertion_battery.InsertionVoltagePair.from_entries" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>entry1</strong> – Entry corresponding to one of the entries in the voltage step.</p></li>
<li><p><strong>entry2</strong> – Entry corresponding to the other entry in the voltage step.</p></li>
<li><p><strong>working_ion_entry</strong> – A single ComputedEntry or PDEntry representing
the element that carries charge across the battery, e.g. Li.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
</section>
<section id="module-pymatgen.apps.battery.plotter">
<span id="pymatgen-apps-battery-plotter-module"></span><h2>pymatgen.apps.battery.plotter module<a class="headerlink" href="#module-pymatgen.apps.battery.plotter" title="Link to this heading"></a></h2>
<p>This module provides plotting capabilities for battery related applications.</p>
<dl class="py class">
<dt class="sig sig-object py" id="pymatgen.apps.battery.plotter.VoltageProfilePlotter">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">VoltageProfilePlotter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">xaxis</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'capacity'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hide_negative</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/plotter.py#L23-L220"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.plotter.VoltageProfilePlotter" title="Link 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<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>xaxis</strong> – The quantity to use as the xaxis. Can be either</p></li>
<li><p><strong>capacity_grav</strong> (<em>-</em>) – the gravimetric capacity</p></li>
<li><p><strong>capacity_vol</strong> (<em>-</em>) – the volumetric capacity</p></li>
<li><p><strong>x_form</strong> (<em>-</em>) – the number of working ions per formula unit of the host</p></li>
<li><p><strong>frac_x</strong> (<em>-</em>) – the atomic fraction of the working ion</p></li>
<li><p><strong>hide_negative</strong> – If True only plot the voltage steps above zero.</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.apps.battery.plotter.VoltageProfilePlotter.add_electrode">
<span class="sig-name descname"><span class="pre">add_electrode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">electrode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode" title="pymatgen.apps.battery.battery_abc.AbstractElectrode"><span class="pre">AbstractElectrode</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">label</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/plotter.py#L40-L51"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.plotter.VoltageProfilePlotter.add_electrode" title="Link to this definition"></a></dt>
<dd><p>Add an electrode to the plot.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></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="py method">
<dt class="sig sig-object py" id="pymatgen.apps.battery.plotter.VoltageProfilePlotter.get_plot">
<span class="sig-name descname"><span class="pre">get_plot</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">width</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">8</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">height</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">8</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">term_zero</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ax</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Axes</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Axes</span></span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/plotter.py#L95-L127"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.plotter.VoltageProfilePlotter.get_plot" title="Link to this definition"></a></dt>
<dd><p>Get a plot object.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></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>
<li><p><strong>term_zero</strong> – If True append zero voltage point at the end</p></li>
<li><p><strong>ax</strong> (<em>plt.Axes</em>) – matplotlib axes object. Defaults to None.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>matplotlib axes object.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>plt.Axes</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.apps.battery.plotter.VoltageProfilePlotter.get_plot_data">
<span class="sig-name descname"><span class="pre">get_plot_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">electrode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pymatgen.apps.battery.battery_abc.AbstractElectrode" title="pymatgen.apps.battery.battery_abc.AbstractElectrode"><span class="pre">AbstractElectrode</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">term_zero</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/plotter.py#L53-L93"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.plotter.VoltageProfilePlotter.get_plot_data" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>electrode</strong> – Electrode object</p></li>
<li><p><strong>term_zero</strong> – If True append zero voltage point at the end.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Plot data in x, y.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.apps.battery.plotter.VoltageProfilePlotter.get_plotly_figure">
<span class="sig-name descname"><span class="pre">get_plotly_figure</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">width</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">800</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">height</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">600</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">font_dict</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">term_zero</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Figure</span></span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/plotter.py#L129-L180"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.plotter.VoltageProfilePlotter.get_plotly_figure" title="Link to this definition"></a></dt>
<dd><p>Return plotly Figure object.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>width</strong> – Width of the plot. Defaults to 800 px.</p></li>
<li><p><strong>height</strong> – Height of the plot. Defaults to 600 px.</p></li>
<li><p><strong>font_dict</strong> – define the font. Defaults to {“family”: “Arial”, “size”: 24, “color”: “#000000”}</p></li>
<li><p><strong>term_zero</strong> – If True append zero voltage point at the end</p></li>
<li><p><strong>**kwargs</strong> – passed to plotly.graph_objects.Layout</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.apps.battery.plotter.VoltageProfilePlotter.save">
<span class="sig-name descname"><span class="pre">save</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">width</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">8</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">height</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">6</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/plotter.py#L212-L220"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.plotter.VoltageProfilePlotter.save" title="Link 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<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>filename</strong> (<em>str</em>) – Filename to save to. Must include extension to specify image format.</p></li>
<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>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.apps.battery.plotter.VoltageProfilePlotter.show">
<span class="sig-name descname"><span class="pre">show</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">width</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">8</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">height</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">6</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2025.1.24/src/pymatgen/core/../apps/battery/plotter.py#L203-L210"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.apps.battery.plotter.VoltageProfilePlotter.show" title="Link to this definition"></a></dt>
<dd><p>Show the voltage profile plot.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></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>
</section>
</section>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>© Copyright 2011, Pymatgen Development Team.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
|
