-
Notifications
You must be signed in to change notification settings - Fork 835
/
pymatgen.io.aims.html
1624 lines (1457 loc) · 218 KB
/
pymatgen.io.aims.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
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
<!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.io.aims package — pymatgen 2024.3.1 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=19f00094" />
<link rel="stylesheet" type="text/css" href="assets/css/custom.css" />
<link rel="canonical" href="https://pymatgen.orgpymatgen.io.aims.html"/>
<!--[if lt IE 9]>
<script src="assets/js/html5shiv.min.js"></script>
<![endif]-->
<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=df55f829"></script>
<script src="assets/doctools.js?v=888ff710"></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 class="version">
2024.3.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" 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.io.aims package</a><ul>
<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#module-pymatgen.io.aims.inputs">pymatgen.io.aims.inputs module</a><ul>
<li><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsControlIn"><code class="docutils literal notranslate"><span class="pre">AimsControlIn</span></code></a><ul>
<li><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsControlIn._parameters"><code class="docutils literal notranslate"><span class="pre">AimsControlIn._parameters</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsControlIn.as_dict"><code class="docutils literal notranslate"><span class="pre">AimsControlIn.as_dict()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsControlIn.from_dict"><code class="docutils literal notranslate"><span class="pre">AimsControlIn.from_dict()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsControlIn.get_aims_control_parameter_str"><code class="docutils literal notranslate"><span class="pre">AimsControlIn.get_aims_control_parameter_str()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsControlIn.get_content"><code class="docutils literal notranslate"><span class="pre">AimsControlIn.get_content()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsControlIn.get_species_block"><code class="docutils literal notranslate"><span class="pre">AimsControlIn.get_species_block()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsControlIn.parameters"><code class="docutils literal notranslate"><span class="pre">AimsControlIn.parameters</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsControlIn.write_file"><code class="docutils literal notranslate"><span class="pre">AimsControlIn.write_file()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsCube"><code class="docutils literal notranslate"><span class="pre">AimsCube</span></code></a><ul>
<li><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsCube.type"><code class="docutils literal notranslate"><span class="pre">AimsCube.type</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsCube.origin"><code class="docutils literal notranslate"><span class="pre">AimsCube.origin</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsCube.edges"><code class="docutils literal notranslate"><span class="pre">AimsCube.edges</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsCube.points"><code class="docutils literal notranslate"><span class="pre">AimsCube.points</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsCube.spin_state"><code class="docutils literal notranslate"><span class="pre">AimsCube.spin_state</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsCube.kpoint"><code class="docutils literal notranslate"><span class="pre">AimsCube.kpoint</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsCube.filename"><code class="docutils literal notranslate"><span class="pre">AimsCube.filename</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsCube.format"><code class="docutils literal notranslate"><span class="pre">AimsCube.format</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsCube.elf_type"><code class="docutils literal notranslate"><span class="pre">AimsCube.elf_type</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsCube.as_dict"><code class="docutils literal notranslate"><span class="pre">AimsCube.as_dict()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsCube.control_block"><code class="docutils literal notranslate"><span class="pre">AimsCube.control_block</span></code></a></li>
<li><a class="reference internal" href="#id0"><code class="docutils literal notranslate"><span class="pre">AimsCube.edges</span></code></a></li>
<li><a class="reference internal" href="#id1"><code class="docutils literal notranslate"><span class="pre">AimsCube.elf_type</span></code></a></li>
<li><a class="reference internal" href="#id2"><code class="docutils literal notranslate"><span class="pre">AimsCube.filename</span></code></a></li>
<li><a class="reference internal" href="#id3"><code class="docutils literal notranslate"><span class="pre">AimsCube.format</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsCube.from_dict"><code class="docutils literal notranslate"><span class="pre">AimsCube.from_dict()</span></code></a></li>
<li><a class="reference internal" href="#id4"><code class="docutils literal notranslate"><span class="pre">AimsCube.kpoint</span></code></a></li>
<li><a class="reference internal" href="#id5"><code class="docutils literal notranslate"><span class="pre">AimsCube.origin</span></code></a></li>
<li><a class="reference internal" href="#id6"><code class="docutils literal notranslate"><span class="pre">AimsCube.points</span></code></a></li>
<li><a class="reference internal" href="#id7"><code class="docutils literal notranslate"><span class="pre">AimsCube.spin_state</span></code></a></li>
<li><a class="reference internal" href="#id8"><code class="docutils literal notranslate"><span class="pre">AimsCube.type</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsGeometryIn"><code class="docutils literal notranslate"><span class="pre">AimsGeometryIn</span></code></a><ul>
<li><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsGeometryIn._content"><code class="docutils literal notranslate"><span class="pre">AimsGeometryIn._content</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsGeometryIn._structure"><code class="docutils literal notranslate"><span class="pre">AimsGeometryIn._structure</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsGeometryIn.as_dict"><code class="docutils literal notranslate"><span class="pre">AimsGeometryIn.as_dict()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsGeometryIn.content"><code class="docutils literal notranslate"><span class="pre">AimsGeometryIn.content</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsGeometryIn.from_dict"><code class="docutils literal notranslate"><span class="pre">AimsGeometryIn.from_dict()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsGeometryIn.from_file"><code class="docutils literal notranslate"><span class="pre">AimsGeometryIn.from_file()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsGeometryIn.from_str"><code class="docutils literal notranslate"><span class="pre">AimsGeometryIn.from_str()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsGeometryIn.from_structure"><code class="docutils literal notranslate"><span class="pre">AimsGeometryIn.from_structure()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsGeometryIn.structure"><code class="docutils literal notranslate"><span class="pre">AimsGeometryIn.structure</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsGeometryIn.write_file"><code class="docutils literal notranslate"><span class="pre">AimsGeometryIn.write_file()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#module-pymatgen.io.aims.outputs">pymatgen.io.aims.outputs module</a><ul>
<li><a class="reference internal" href="#pymatgen.io.aims.outputs.AimsOutput"><code class="docutils literal notranslate"><span class="pre">AimsOutput</span></code></a><ul>
<li><a class="reference internal" href="#pymatgen.io.aims.outputs.AimsOutput.aims_version"><code class="docutils literal notranslate"><span class="pre">AimsOutput.aims_version</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.outputs.AimsOutput.all_forces"><code class="docutils literal notranslate"><span class="pre">AimsOutput.all_forces</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.outputs.AimsOutput.as_dict"><code class="docutils literal notranslate"><span class="pre">AimsOutput.as_dict()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.outputs.AimsOutput.band_gap"><code class="docutils literal notranslate"><span class="pre">AimsOutput.band_gap</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.outputs.AimsOutput.cbm"><code class="docutils literal notranslate"><span class="pre">AimsOutput.cbm</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.outputs.AimsOutput.completed"><code class="docutils literal notranslate"><span class="pre">AimsOutput.completed</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.outputs.AimsOutput.direct_band_gap"><code class="docutils literal notranslate"><span class="pre">AimsOutput.direct_band_gap</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.outputs.AimsOutput.fermi_energy"><code class="docutils literal notranslate"><span class="pre">AimsOutput.fermi_energy</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.outputs.AimsOutput.final_energy"><code class="docutils literal notranslate"><span class="pre">AimsOutput.final_energy</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.outputs.AimsOutput.final_structure"><code class="docutils literal notranslate"><span class="pre">AimsOutput.final_structure</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.outputs.AimsOutput.forces"><code class="docutils literal notranslate"><span class="pre">AimsOutput.forces</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.outputs.AimsOutput.from_dict"><code class="docutils literal notranslate"><span class="pre">AimsOutput.from_dict()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.outputs.AimsOutput.from_outfile"><code class="docutils literal notranslate"><span class="pre">AimsOutput.from_outfile()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.outputs.AimsOutput.from_str"><code class="docutils literal notranslate"><span class="pre">AimsOutput.from_str()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.outputs.AimsOutput.get_results_for_image"><code class="docutils literal notranslate"><span class="pre">AimsOutput.get_results_for_image()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.outputs.AimsOutput.initial_structure"><code class="docutils literal notranslate"><span class="pre">AimsOutput.initial_structure</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.outputs.AimsOutput.metadata"><code class="docutils literal notranslate"><span class="pre">AimsOutput.metadata</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.outputs.AimsOutput.n_images"><code class="docutils literal notranslate"><span class="pre">AimsOutput.n_images</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.outputs.AimsOutput.stress"><code class="docutils literal notranslate"><span class="pre">AimsOutput.stress</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.outputs.AimsOutput.stresses"><code class="docutils literal notranslate"><span class="pre">AimsOutput.stresses</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.outputs.AimsOutput.structure_summary"><code class="docutils literal notranslate"><span class="pre">AimsOutput.structure_summary</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.outputs.AimsOutput.structures"><code class="docutils literal notranslate"><span class="pre">AimsOutput.structures</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.outputs.AimsOutput.vbm"><code class="docutils literal notranslate"><span class="pre">AimsOutput.vbm</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#module-pymatgen.io.aims.parsers">pymatgen.io.aims.parsers module</a><ul>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk"><code class="docutils literal notranslate"><span class="pre">AimsOutCalcChunk</span></code></a><ul>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk.E_f"><code class="docutils literal notranslate"><span class="pre">AimsOutCalcChunk.E_f</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk.cbm"><code class="docutils literal notranslate"><span class="pre">AimsOutCalcChunk.cbm</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk.converged"><code class="docutils literal notranslate"><span class="pre">AimsOutCalcChunk.converged</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk.coords"><code class="docutils literal notranslate"><span class="pre">AimsOutCalcChunk.coords</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk.dielectric_tensor"><code class="docutils literal notranslate"><span class="pre">AimsOutCalcChunk.dielectric_tensor</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk.dipole"><code class="docutils literal notranslate"><span class="pre">AimsOutCalcChunk.dipole</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk.direct_gap"><code class="docutils literal notranslate"><span class="pre">AimsOutCalcChunk.direct_gap</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk.electronic_temperature"><code class="docutils literal notranslate"><span class="pre">AimsOutCalcChunk.electronic_temperature</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk.energy"><code class="docutils literal notranslate"><span class="pre">AimsOutCalcChunk.energy</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk.forces"><code class="docutils literal notranslate"><span class="pre">AimsOutCalcChunk.forces</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk.free_energy"><code class="docutils literal notranslate"><span class="pre">AimsOutCalcChunk.free_energy</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk.gap"><code class="docutils literal notranslate"><span class="pre">AimsOutCalcChunk.gap</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk.hirshfeld_atomic_dipoles"><code class="docutils literal notranslate"><span class="pre">AimsOutCalcChunk.hirshfeld_atomic_dipoles</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk.hirshfeld_charges"><code class="docutils literal notranslate"><span class="pre">AimsOutCalcChunk.hirshfeld_charges</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk.hirshfeld_dipole"><code class="docutils literal notranslate"><span class="pre">AimsOutCalcChunk.hirshfeld_dipole</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk.hirshfeld_volumes"><code class="docutils literal notranslate"><span class="pre">AimsOutCalcChunk.hirshfeld_volumes</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk.initial_lattice"><code class="docutils literal notranslate"><span class="pre">AimsOutCalcChunk.initial_lattice</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk.initial_structure"><code class="docutils literal notranslate"><span class="pre">AimsOutCalcChunk.initial_structure</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk.is_metallic"><code class="docutils literal notranslate"><span class="pre">AimsOutCalcChunk.is_metallic</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk.k_point_weights"><code class="docutils literal notranslate"><span class="pre">AimsOutCalcChunk.k_point_weights</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk.k_points"><code class="docutils literal notranslate"><span class="pre">AimsOutCalcChunk.k_points</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk.lattice"><code class="docutils literal notranslate"><span class="pre">AimsOutCalcChunk.lattice</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk.magmom"><code class="docutils literal notranslate"><span class="pre">AimsOutCalcChunk.magmom</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk.n_atoms"><code class="docutils literal notranslate"><span class="pre">AimsOutCalcChunk.n_atoms</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk.n_bands"><code class="docutils literal notranslate"><span class="pre">AimsOutCalcChunk.n_bands</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk.n_electrons"><code class="docutils literal notranslate"><span class="pre">AimsOutCalcChunk.n_electrons</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk.n_iter"><code class="docutils literal notranslate"><span class="pre">AimsOutCalcChunk.n_iter</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk.n_k_points"><code class="docutils literal notranslate"><span class="pre">AimsOutCalcChunk.n_k_points</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk.n_spins"><code class="docutils literal notranslate"><span class="pre">AimsOutCalcChunk.n_spins</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk.polarization"><code class="docutils literal notranslate"><span class="pre">AimsOutCalcChunk.polarization</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk.results"><code class="docutils literal notranslate"><span class="pre">AimsOutCalcChunk.results</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk.species"><code class="docutils literal notranslate"><span class="pre">AimsOutCalcChunk.species</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk.stress"><code class="docutils literal notranslate"><span class="pre">AimsOutCalcChunk.stress</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk.stresses"><code class="docutils literal notranslate"><span class="pre">AimsOutCalcChunk.stresses</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk.structure"><code class="docutils literal notranslate"><span class="pre">AimsOutCalcChunk.structure</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk.vbm"><code class="docutils literal notranslate"><span class="pre">AimsOutCalcChunk.vbm</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk.velocities"><code class="docutils literal notranslate"><span class="pre">AimsOutCalcChunk.velocities</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutChunk"><code class="docutils literal notranslate"><span class="pre">AimsOutChunk</span></code></a><ul>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutChunk.lines"><code class="docutils literal notranslate"><span class="pre">AimsOutChunk.lines</span></code></a></li>
<li><a class="reference internal" href="#id9"><code class="docutils literal notranslate"><span class="pre">AimsOutChunk.lines</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutChunk.parse_scalar"><code class="docutils literal notranslate"><span class="pre">AimsOutChunk.parse_scalar()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutChunk.reverse_search_for"><code class="docutils literal notranslate"><span class="pre">AimsOutChunk.reverse_search_for()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutChunk.search_for_all"><code class="docutils literal notranslate"><span class="pre">AimsOutChunk.search_for_all()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutHeaderChunk"><code class="docutils literal notranslate"><span class="pre">AimsOutHeaderChunk</span></code></a><ul>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutHeaderChunk.aims_uuid"><code class="docutils literal notranslate"><span class="pre">AimsOutHeaderChunk.aims_uuid</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutHeaderChunk.build_type"><code class="docutils literal notranslate"><span class="pre">AimsOutHeaderChunk.build_type</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutHeaderChunk.c_compiler"><code class="docutils literal notranslate"><span class="pre">AimsOutHeaderChunk.c_compiler</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutHeaderChunk.c_compiler_flags"><code class="docutils literal notranslate"><span class="pre">AimsOutHeaderChunk.c_compiler_flags</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutHeaderChunk.commit_hash"><code class="docutils literal notranslate"><span class="pre">AimsOutHeaderChunk.commit_hash</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutHeaderChunk.electronic_temperature"><code class="docutils literal notranslate"><span class="pre">AimsOutHeaderChunk.electronic_temperature</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutHeaderChunk.fortran_compiler"><code class="docutils literal notranslate"><span class="pre">AimsOutHeaderChunk.fortran_compiler</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutHeaderChunk.fortran_compiler_flags"><code class="docutils literal notranslate"><span class="pre">AimsOutHeaderChunk.fortran_compiler_flags</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutHeaderChunk.header_summary"><code class="docutils literal notranslate"><span class="pre">AimsOutHeaderChunk.header_summary</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutHeaderChunk.initial_charges"><code class="docutils literal notranslate"><span class="pre">AimsOutHeaderChunk.initial_charges</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutHeaderChunk.initial_lattice"><code class="docutils literal notranslate"><span class="pre">AimsOutHeaderChunk.initial_lattice</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutHeaderChunk.initial_magnetic_moments"><code class="docutils literal notranslate"><span class="pre">AimsOutHeaderChunk.initial_magnetic_moments</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutHeaderChunk.initial_structure"><code class="docutils literal notranslate"><span class="pre">AimsOutHeaderChunk.initial_structure</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutHeaderChunk.is_md"><code class="docutils literal notranslate"><span class="pre">AimsOutHeaderChunk.is_md</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutHeaderChunk.is_relaxation"><code class="docutils literal notranslate"><span class="pre">AimsOutHeaderChunk.is_relaxation</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutHeaderChunk.k_point_weights"><code class="docutils literal notranslate"><span class="pre">AimsOutHeaderChunk.k_point_weights</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutHeaderChunk.k_points"><code class="docutils literal notranslate"><span class="pre">AimsOutHeaderChunk.k_points</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutHeaderChunk.lines"><code class="docutils literal notranslate"><span class="pre">AimsOutHeaderChunk.lines</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutHeaderChunk.linked_against"><code class="docutils literal notranslate"><span class="pre">AimsOutHeaderChunk.linked_against</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutHeaderChunk.metadata_summary"><code class="docutils literal notranslate"><span class="pre">AimsOutHeaderChunk.metadata_summary</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutHeaderChunk.n_atoms"><code class="docutils literal notranslate"><span class="pre">AimsOutHeaderChunk.n_atoms</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutHeaderChunk.n_bands"><code class="docutils literal notranslate"><span class="pre">AimsOutHeaderChunk.n_bands</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutHeaderChunk.n_electrons"><code class="docutils literal notranslate"><span class="pre">AimsOutHeaderChunk.n_electrons</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutHeaderChunk.n_k_points"><code class="docutils literal notranslate"><span class="pre">AimsOutHeaderChunk.n_k_points</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutHeaderChunk.n_spins"><code class="docutils literal notranslate"><span class="pre">AimsOutHeaderChunk.n_spins</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutHeaderChunk.version_number"><code class="docutils literal notranslate"><span class="pre">AimsOutHeaderChunk.version_number</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsParseError"><code class="docutils literal notranslate"><span class="pre">AimsParseError</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.ParseError"><code class="docutils literal notranslate"><span class="pre">ParseError</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.check_convergence"><code class="docutils literal notranslate"><span class="pre">check_convergence()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.get_aims_out_chunks"><code class="docutils literal notranslate"><span class="pre">get_aims_out_chunks()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.get_header_chunk"><code class="docutils literal notranslate"><span class="pre">get_header_chunk()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.get_lines"><code class="docutils literal notranslate"><span class="pre">get_lines()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.read_aims_header_info"><code class="docutils literal notranslate"><span class="pre">read_aims_header_info()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.read_aims_header_info_from_content"><code class="docutils literal notranslate"><span class="pre">read_aims_header_info_from_content()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.read_aims_output"><code class="docutils literal notranslate"><span class="pre">read_aims_output()</span></code></a></li>
<li><a class="reference internal" href="#pymatgen.io.aims.parsers.read_aims_output_from_content"><code class="docutils literal notranslate"><span class="pre">read_aims_output_from_content()</span></code></a></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.io.aims package</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/materialsproject/pymatgen/blob/master/docs_rst/pymatgen.io.aims.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.io.aims">
<span id="pymatgen-io-aims-package"></span><h1>pymatgen.io.aims package<a class="headerlink" href="#module-pymatgen.io.aims" title="Link to this heading"></a></h1>
<p>IO interface for FHI-aims.</p>
<section id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this heading"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="pymatgen.io.aims.sets.html">pymatgen.io.aims.sets package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.io.aims.sets.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.io.aims.sets.html#module-pymatgen.io.aims.sets.base">pymatgen.io.aims.sets.base module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.io.aims.sets.html#pymatgen.io.aims.sets.base.AimsInputGenerator"><code class="docutils literal notranslate"><span class="pre">AimsInputGenerator</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.io.aims.sets.html#pymatgen.io.aims.sets.base.AimsInputGenerator.d2k"><code class="docutils literal notranslate"><span class="pre">AimsInputGenerator.d2k()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.io.aims.sets.html#pymatgen.io.aims.sets.base.AimsInputGenerator.d2k_recipcell"><code class="docutils literal notranslate"><span class="pre">AimsInputGenerator.d2k_recipcell()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.io.aims.sets.html#pymatgen.io.aims.sets.base.AimsInputGenerator.get_input_set"><code class="docutils literal notranslate"><span class="pre">AimsInputGenerator.get_input_set()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.io.aims.sets.html#pymatgen.io.aims.sets.base.AimsInputGenerator.get_parameter_updates"><code class="docutils literal notranslate"><span class="pre">AimsInputGenerator.get_parameter_updates()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.io.aims.sets.html#pymatgen.io.aims.sets.base.AimsInputGenerator.k2d"><code class="docutils literal notranslate"><span class="pre">AimsInputGenerator.k2d()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.io.aims.sets.html#pymatgen.io.aims.sets.base.AimsInputGenerator.user_kpoints_settings"><code class="docutils literal notranslate"><span class="pre">AimsInputGenerator.user_kpoints_settings</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.io.aims.sets.html#pymatgen.io.aims.sets.base.AimsInputGenerator.user_params"><code class="docutils literal notranslate"><span class="pre">AimsInputGenerator.user_params</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.io.aims.sets.html#pymatgen.io.aims.sets.base.AimsInputSet"><code class="docutils literal notranslate"><span class="pre">AimsInputSet</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.io.aims.sets.html#pymatgen.io.aims.sets.base.AimsInputSet.control_in"><code class="docutils literal notranslate"><span class="pre">AimsInputSet.control_in</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.io.aims.sets.html#pymatgen.io.aims.sets.base.AimsInputSet.geometry_in"><code class="docutils literal notranslate"><span class="pre">AimsInputSet.geometry_in</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.io.aims.sets.html#pymatgen.io.aims.sets.base.AimsInputSet.get_input_files"><code class="docutils literal notranslate"><span class="pre">AimsInputSet.get_input_files()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.io.aims.sets.html#pymatgen.io.aims.sets.base.AimsInputSet.params_json"><code class="docutils literal notranslate"><span class="pre">AimsInputSet.params_json</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.io.aims.sets.html#pymatgen.io.aims.sets.base.AimsInputSet.remove_parameters"><code class="docutils literal notranslate"><span class="pre">AimsInputSet.remove_parameters()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.io.aims.sets.html#pymatgen.io.aims.sets.base.AimsInputSet.set_parameters"><code class="docutils literal notranslate"><span class="pre">AimsInputSet.set_parameters()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.io.aims.sets.html#pymatgen.io.aims.sets.base.AimsInputSet.set_structure"><code class="docutils literal notranslate"><span class="pre">AimsInputSet.set_structure()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.io.aims.sets.html#pymatgen.io.aims.sets.base.recursive_update"><code class="docutils literal notranslate"><span class="pre">recursive_update()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.io.aims.sets.html#module-pymatgen.io.aims.sets.bs">pymatgen.io.aims.sets.bs module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.io.aims.sets.html#pymatgen.io.aims.sets.bs.BandStructureSetGenerator"><code class="docutils literal notranslate"><span class="pre">BandStructureSetGenerator</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.io.aims.sets.html#pymatgen.io.aims.sets.bs.BandStructureSetGenerator.calc_type"><code class="docutils literal notranslate"><span class="pre">BandStructureSetGenerator.calc_type</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.io.aims.sets.html#pymatgen.io.aims.sets.bs.BandStructureSetGenerator.get_parameter_updates"><code class="docutils literal notranslate"><span class="pre">BandStructureSetGenerator.get_parameter_updates()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.io.aims.sets.html#pymatgen.io.aims.sets.bs.BandStructureSetGenerator.k_point_density"><code class="docutils literal notranslate"><span class="pre">BandStructureSetGenerator.k_point_density</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.io.aims.sets.html#pymatgen.io.aims.sets.bs.GWSetGenerator"><code class="docutils literal notranslate"><span class="pre">GWSetGenerator</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.io.aims.sets.html#pymatgen.io.aims.sets.bs.GWSetGenerator.calc_type"><code class="docutils literal notranslate"><span class="pre">GWSetGenerator.calc_type</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.io.aims.sets.html#pymatgen.io.aims.sets.bs.GWSetGenerator.get_parameter_updates"><code class="docutils literal notranslate"><span class="pre">GWSetGenerator.get_parameter_updates()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.io.aims.sets.html#pymatgen.io.aims.sets.bs.GWSetGenerator.k_point_density"><code class="docutils literal notranslate"><span class="pre">GWSetGenerator.k_point_density</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.io.aims.sets.html#pymatgen.io.aims.sets.bs.prepare_band_input"><code class="docutils literal notranslate"><span class="pre">prepare_band_input()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.io.aims.sets.html#module-pymatgen.io.aims.sets.core">pymatgen.io.aims.sets.core module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.io.aims.sets.html#pymatgen.io.aims.sets.core.RelaxSetGenerator"><code class="docutils literal notranslate"><span class="pre">RelaxSetGenerator</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.io.aims.sets.html#pymatgen.io.aims.sets.core.RelaxSetGenerator.calc_type"><code class="docutils literal notranslate"><span class="pre">RelaxSetGenerator.calc_type</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.io.aims.sets.html#pymatgen.io.aims.sets.core.RelaxSetGenerator.get_parameter_updates"><code class="docutils literal notranslate"><span class="pre">RelaxSetGenerator.get_parameter_updates()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.io.aims.sets.html#pymatgen.io.aims.sets.core.RelaxSetGenerator.max_force"><code class="docutils literal notranslate"><span class="pre">RelaxSetGenerator.max_force</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.io.aims.sets.html#pymatgen.io.aims.sets.core.RelaxSetGenerator.method"><code class="docutils literal notranslate"><span class="pre">RelaxSetGenerator.method</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.io.aims.sets.html#pymatgen.io.aims.sets.core.RelaxSetGenerator.relax_cell"><code class="docutils literal notranslate"><span class="pre">RelaxSetGenerator.relax_cell</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.io.aims.sets.html#pymatgen.io.aims.sets.core.SocketIOSetGenerator"><code class="docutils literal notranslate"><span class="pre">SocketIOSetGenerator</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.io.aims.sets.html#pymatgen.io.aims.sets.core.SocketIOSetGenerator.calc_type"><code class="docutils literal notranslate"><span class="pre">SocketIOSetGenerator.calc_type</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.io.aims.sets.html#pymatgen.io.aims.sets.core.SocketIOSetGenerator.get_parameter_updates"><code class="docutils literal notranslate"><span class="pre">SocketIOSetGenerator.get_parameter_updates()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.io.aims.sets.html#pymatgen.io.aims.sets.core.SocketIOSetGenerator.host"><code class="docutils literal notranslate"><span class="pre">SocketIOSetGenerator.host</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.io.aims.sets.html#pymatgen.io.aims.sets.core.SocketIOSetGenerator.port"><code class="docutils literal notranslate"><span class="pre">SocketIOSetGenerator.port</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.io.aims.sets.html#pymatgen.io.aims.sets.core.StaticSetGenerator"><code class="docutils literal notranslate"><span class="pre">StaticSetGenerator</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.io.aims.sets.html#pymatgen.io.aims.sets.core.StaticSetGenerator.calc_type"><code class="docutils literal notranslate"><span class="pre">StaticSetGenerator.calc_type</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.io.aims.sets.html#pymatgen.io.aims.sets.core.StaticSetGenerator.get_parameter_updates"><code class="docutils literal notranslate"><span class="pre">StaticSetGenerator.get_parameter_updates()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading"></a></h2>
</section>
<section id="module-pymatgen.io.aims.inputs">
<span id="pymatgen-io-aims-inputs-module"></span><h2>pymatgen.io.aims.inputs module<a class="headerlink" href="#module-pymatgen.io.aims.inputs" title="Link to this heading"></a></h2>
<p>Classes for reading/manipulating/writing FHI-aims input files.</p>
<p>Works for aims cube objects, geometry.in and control.in</p>
<dl class="py class">
<dt class="sig sig-object py" id="pymatgen.io.aims.inputs.AimsControlIn">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AimsControlIn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_parameters:</span> <span class="pre">dict[str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">~typing.Any]</span> <span class="pre">=</span> <span class="pre"><factory></span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/core/../io/aims/inputs.py#L396-L648"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.inputs.AimsControlIn" 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>Class representing and FHI-aims control.in file</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pymatgen.io.aims.inputs.AimsControlIn._parameters">
<span class="sig-name descname"><span class="pre">_parameters</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/io/aims/inputs.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.inputs.AimsControlIn._parameters" title="Link to this definition"></a></dt>
<dd><p>The parameters dictionary containing all input
flags (key) and values for the control.in file</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>dict[str, Any]</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.io.aims.inputs.AimsControlIn.as_dict">
<span class="sig-name descname"><span class="pre">as_dict</span></span><span class="sig-paren">(</span><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 class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/core/../io/aims/inputs.py#L628-L634"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.inputs.AimsControlIn.as_dict" title="Link to this definition"></a></dt>
<dd><p>Get a dictionary representation of the geometry.in file.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.io.aims.inputs.AimsControlIn.from_dict">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dct</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsControlIn" title="pymatgen.io.aims.inputs.AimsControlIn"><span class="pre">AimsControlIn</span></a></span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/core/../io/aims/inputs.py#L636-L648"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.inputs.AimsControlIn.from_dict" title="Link to this definition"></a></dt>
<dd><p>Initialize from dictionary.</p>
<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><em>[</em><em>str</em><em>, </em><em>Any</em><em>]</em>) – The MontyEncoded dictionary</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The AimsControlIn for dct</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.io.aims.inputs.AimsControlIn.get_aims_control_parameter_str">
<span class="sig-name descname"><span class="pre">get_aims_control_parameter_str</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</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">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fmt</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> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/core/../io/aims/inputs.py#L470-L481"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.inputs.AimsControlIn.get_aims_control_parameter_str" title="Link to this definition"></a></dt>
<dd><p>Get the string needed to add a parameter to the control.in 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>key</strong> (<em>str</em>) – The name of the input flag</p></li>
<li><p><strong>value</strong> (<em>Any</em>) – The value to be set for the flag</p></li>
<li><p><strong>fmt</strong> (<em>str</em>) – The format string to apply to the value</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The line to add to the control.in file</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>str</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.io.aims.inputs.AimsControlIn.get_content">
<span class="sig-name descname"><span class="pre">get_content</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structure</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="pymatgen.core.html#pymatgen.core.structure.Structure" title="pymatgen.core.structure.Structure"><span class="pre">Structure</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="pymatgen.core.html#pymatgen.core.structure.Molecule" title="pymatgen.core.structure.Molecule"><span class="pre">Molecule</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">verbose_header</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>, <em class="sig-param"><span class="n"><span class="pre">directory</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">Path</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">str</span></span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/core/../io/aims/inputs.py#L483-L556"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.inputs.AimsControlIn.get_content" title="Link to this definition"></a></dt>
<dd><p>Get the content of the 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>structure</strong> (<a class="reference internal" href="pymatgen.core.html#pymatgen.core.structure.Structure" title="pymatgen.core.structure.Structure"><em>Structure</em></a><em> or </em><a class="reference internal" href="pymatgen.core.html#pymatgen.core.structure.Molecule" title="pymatgen.core.structure.Molecule"><em>Molecule</em></a>) – The structure to write the input
file for</p></li>
<li><p><strong>verbose_header</strong> (<em>bool</em>) – If True print the input option dictionary</p></li>
<li><p><strong>directory</strong> – str | Path | None = The directory for the calculation,</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The content of the file for a given structure</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>str</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.io.aims.inputs.AimsControlIn.get_species_block">
<span class="sig-name descname"><span class="pre">get_species_block</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structure</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="pymatgen.core.html#pymatgen.core.structure.Structure" title="pymatgen.core.structure.Structure"><span class="pre">Structure</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="pymatgen.core.html#pymatgen.core.structure.Molecule" title="pymatgen.core.structure.Molecule"><span class="pre">Molecule</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">species_dir</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">Path</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">str</span></span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/core/../io/aims/inputs.py#L600-L626"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.inputs.AimsControlIn.get_species_block" title="Link to this definition"></a></dt>
<dd><p>Get the basis set information for a 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>structure</strong> (<a class="reference internal" href="pymatgen.core.html#pymatgen.core.structure.Molecule" title="pymatgen.core.structure.Molecule"><em>Molecule</em></a><em> or </em><a class="reference internal" href="pymatgen.core.html#pymatgen.core.structure.Structure" title="pymatgen.core.structure.Structure"><em>Structure</em></a>) – The structure to get the basis set information for</p></li>
<li><p><strong>Pat</strong> (<em>species_dir</em><em> (</em><em>str or</em>) – ): The directory to find the species files in</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The block to add to the control.in file for the species</p>
</dd>
<dt class="field-odd">Raises<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>ValueError</strong> – If a file for the species is not found</p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.io.aims.inputs.AimsControlIn.parameters">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/io/aims/inputs.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.inputs.AimsControlIn.parameters" title="Link to this definition"></a></dt>
<dd><p>The dictionary of input parameters for control.in</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.io.aims.inputs.AimsControlIn.write_file">
<span class="sig-name descname"><span class="pre">write_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structure</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="pymatgen.core.html#pymatgen.core.structure.Structure" title="pymatgen.core.structure.Structure"><span class="pre">Structure</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="pymatgen.core.html#pymatgen.core.structure.Molecule" title="pymatgen.core.structure.Molecule"><span class="pre">Molecule</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">directory</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">Path</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">verbose_header</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>, <em class="sig-param"><span class="n"><span class="pre">overwrite</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">None</span></span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/core/../io/aims/inputs.py#L558-L598"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.inputs.AimsControlIn.write_file" title="Link to this definition"></a></dt>
<dd><p>Writes the control.in 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>structure</strong> (<a class="reference internal" href="pymatgen.core.html#pymatgen.core.structure.Structure" title="pymatgen.core.structure.Structure"><em>Structure</em></a><em> or </em><a class="reference internal" href="pymatgen.core.html#pymatgen.core.structure.Molecule" title="pymatgen.core.structure.Molecule"><em>Molecule</em></a>) – The structure to write the input
file for</p></li>
<li><p><strong>directory</strong> (<em>str</em><em> or </em><em>Path</em>) – The directory to write the control.in file.
If None use cwd</p></li>
<li><p><strong>verbose_header</strong> (<em>bool</em>) – If True print the input option dictionary</p></li>
<li><p><strong>overwrite</strong> (<em>bool</em>) – If True allow to overwrite existing files</p></li>
</ul>
</dd>
<dt class="field-even">Raises<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>ValueError</strong> – If a file must be overwritten and overwrite is False</p></li>
<li><p><strong>ValueError</strong> – If k-grid is not provided for the periodic structures</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="pymatgen.io.aims.inputs.AimsCube">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AimsCube</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre"><factory></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">origin:</span> <span class="pre">Sequence[float]</span> <span class="pre">|</span> <span class="pre">tuple[float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">float]</span> <span class="pre">=</span> <span class="pre"><factory></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">edges:</span> <span class="pre">Sequence[Sequence[float]]</span> <span class="pre">=</span> <span class="pre"><factory></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">points:</span> <span class="pre">Sequence[int]</span> <span class="pre">|</span> <span class="pre">tuple[int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">int]</span> <span class="pre">=</span> <span class="pre"><factory></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">format:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'cube'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spin_state:</span> <span class="pre">int</span> <span class="pre">|</span> <span class="pre">None</span> <span class="pre">=</span> <span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">kpoint:</span> <span class="pre">int</span> <span class="pre">|</span> <span class="pre">None</span> <span class="pre">=</span> <span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename:</span> <span class="pre">str</span> <span class="pre">|</span> <span class="pre">None</span> <span class="pre">=</span> <span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">elf_type:</span> <span class="pre">int</span> <span class="pre">|</span> <span class="pre">None</span> <span class="pre">=</span> <span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/core/../io/aims/inputs.py#L236-L393"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.inputs.AimsCube" 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>Class representing the FHI-aims cubes</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pymatgen.io.aims.inputs.AimsCube.type">
<span class="sig-name descname"><span class="pre">type</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/io/aims/inputs.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.inputs.AimsCube.type" title="Link to this definition"></a></dt>
<dd><p>The value to be outputted as a cube file</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="pymatgen.io.aims.inputs.AimsCube.origin">
<span class="sig-name descname"><span class="pre">origin</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/io/aims/inputs.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.inputs.AimsCube.origin" title="Link to this definition"></a></dt>
<dd><p>The origin of the cube</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Sequence[float] or tuple[float, float, float]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pymatgen.io.aims.inputs.AimsCube.edges">
<span class="sig-name descname"><span class="pre">edges</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/io/aims/inputs.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.inputs.AimsCube.edges" title="Link to this definition"></a></dt>
<dd><p>Specifies the edges of a cube: dx, dy, dz
dx (float): The length of the step in the x direction
dy (float): The length of the step in the y direction
dx (float): The length of the step in the x direction</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Sequence[Sequence[float]]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pymatgen.io.aims.inputs.AimsCube.points">
<span class="sig-name descname"><span class="pre">points</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/io/aims/inputs.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.inputs.AimsCube.points" title="Link to this definition"></a></dt>
<dd><p>The number of points
along each edge</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Sequence[int] or tuple[int, int, int]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pymatgen.io.aims.inputs.AimsCube.spin_state">
<span class="sig-name descname"><span class="pre">spin_state</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/io/aims/inputs.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.inputs.AimsCube.spin_state" title="Link to this definition"></a></dt>
<dd><p>The spin-channel to use either 1 or 2</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pymatgen.io.aims.inputs.AimsCube.kpoint">
<span class="sig-name descname"><span class="pre">kpoint</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/io/aims/inputs.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.inputs.AimsCube.kpoint" title="Link to this definition"></a></dt>
<dd><p>The k-point to use (the index of the list printed from
<cite>output k_point_list</cite>)</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pymatgen.io.aims.inputs.AimsCube.filename">
<span class="sig-name descname"><span class="pre">filename</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/io/aims/inputs.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.inputs.AimsCube.filename" title="Link to this definition"></a></dt>
<dd><p>The filename to use</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="pymatgen.io.aims.inputs.AimsCube.format">
<span class="sig-name descname"><span class="pre">format</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/io/aims/inputs.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.inputs.AimsCube.format" title="Link to this definition"></a></dt>
<dd><p>The format to output the cube file in: cube, gOpenMol, or xsf</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="pymatgen.io.aims.inputs.AimsCube.elf_type">
<span class="sig-name descname"><span class="pre">elf_type</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/io/aims/inputs.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.inputs.AimsCube.elf_type" title="Link to this definition"></a></dt>
<dd><p>The type of electron localization function to use (
see FHI-aims manual)</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.io.aims.inputs.AimsCube.as_dict">
<span class="sig-name descname"><span class="pre">as_dict</span></span><span class="sig-paren">(</span><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 class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/core/../io/aims/inputs.py#L364-L378"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.inputs.AimsCube.as_dict" title="Link to this definition"></a></dt>
<dd><p>Get a dictionary representation of the geometry.in file.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.io.aims.inputs.AimsCube.control_block">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">control_block</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/v2024.3.1/pymatgen/io/aims/inputs.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.inputs.AimsCube.control_block" title="Link to this definition"></a></dt>
<dd><p>Get the block of text for the control.in file of the Cube</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="id0">
<span class="sig-name descname"><span class="pre">edges</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">float</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/v2024.3.1/pymatgen/io/aims/inputs.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 attribute">
<dt class="sig sig-object py" id="id1">
<span class="sig-name descname"><span class="pre">elf_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/io/aims/inputs.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 attribute">
<dt class="sig sig-object py" id="id2">
<span class="sig-name descname"><span class="pre">filename</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><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></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/io/aims/inputs.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></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="id3">
<span class="sig-name descname"><span class="pre">format</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'cube'</span></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/io/aims/inputs.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 method">
<dt class="sig sig-object py" id="pymatgen.io.aims.inputs.AimsCube.from_dict">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dct</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsCube" title="pymatgen.io.aims.inputs.AimsCube"><span class="pre">AimsCube</span></a></span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/core/../io/aims/inputs.py#L380-L393"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.inputs.AimsCube.from_dict" title="Link to this definition"></a></dt>
<dd><p>Initialize from dictionary.</p>
<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><em>[</em><em>str</em><em>, </em><em>Any</em><em>]</em>) – The MontyEncoded dictionary</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>AimsCube</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">kpoint</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/io/aims/inputs.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">origin</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><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><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/io/aims/inputs.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 attribute">
<dt class="sig sig-object py" id="id6">
<span class="sig-name descname"><span class="pre">points</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><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><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/io/aims/inputs.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">spin_state</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/io/aims/inputs.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">type</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/v2024.3.1/pymatgen/io/aims/inputs.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>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="pymatgen.io.aims.inputs.AimsGeometryIn">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AimsGeometryIn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_content</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">_structure</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="pymatgen.core.html#pymatgen.core.structure.Structure" title="pymatgen.core.structure.Structure"><span class="pre">Structure</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="pymatgen.core.html#pymatgen.core.structure.Molecule" title="pymatgen.core.structure.Molecule"><span class="pre">Molecule</span></a></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/core/../io/aims/inputs.py#L30-L204"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.inputs.AimsGeometryIn" 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>Representation of an aims geometry.in file</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pymatgen.io.aims.inputs.AimsGeometryIn._content">
<span class="sig-name descname"><span class="pre">_content</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/io/aims/inputs.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.inputs.AimsGeometryIn._content" title="Link to this definition"></a></dt>
<dd><p>The content of the input file</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="pymatgen.io.aims.inputs.AimsGeometryIn._structure">
<span class="sig-name descname"><span class="pre">_structure</span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/io/aims/inputs.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.inputs.AimsGeometryIn._structure" title="Link to this definition"></a></dt>
<dd><p>The structure or molecule
representation of the file</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.core.html#pymatgen.core.structure.Structure" title="pymatgen.core.structure.Structure">Structure</a> or <a class="reference internal" href="pymatgen.core.html#pymatgen.core.structure.Molecule" title="pymatgen.core.structure.Molecule">Molecule</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.io.aims.inputs.AimsGeometryIn.as_dict">
<span class="sig-name descname"><span class="pre">as_dict</span></span><span class="sig-paren">(</span><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 class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/core/../io/aims/inputs.py#L183-L190"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.inputs.AimsGeometryIn.as_dict" title="Link to this definition"></a></dt>
<dd><p>Get a dictionary representation of the geometry.in file.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.io.aims.inputs.AimsGeometryIn.content">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">content</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/v2024.3.1/pymatgen/io/aims/inputs.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.inputs.AimsGeometryIn.content" title="Link to this definition"></a></dt>
<dd><p>Access the contents of the file</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.io.aims.inputs.AimsGeometryIn.from_dict">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dct</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsGeometryIn" title="pymatgen.io.aims.inputs.AimsGeometryIn"><span class="pre">AimsGeometryIn</span></a></span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/core/../io/aims/inputs.py#L192-L204"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.inputs.AimsGeometryIn.from_dict" title="Link to this definition"></a></dt>
<dd><p>Initialize from dictionary.</p>
<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><em>[</em><em>str</em><em>, </em><em>Any</em><em>]</em>) – The MontyEncoded dictionary of the AimsGeometryIn object</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The input object represented by the dict</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.io.aims.inputs.AimsGeometryIn.from_file">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filepath</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">Path</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsGeometryIn" title="pymatgen.io.aims.inputs.AimsGeometryIn"><span class="pre">AimsGeometryIn</span></a></span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/core/../io/aims/inputs.py#L107-L123"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.inputs.AimsGeometryIn.from_file" title="Link to this definition"></a></dt>
<dd><p>Create an AimsGeometryIn from an input file.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>filepath</strong> (<em>str</em><em> | </em><em>Path</em>) – The path to the input file (either plain text of gzipped)</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The input object represented in the file</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsGeometryIn" title="pymatgen.io.aims.inputs.AimsGeometryIn">AimsGeometryIn</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.io.aims.inputs.AimsGeometryIn.from_str">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_str</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">contents</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> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsGeometryIn" title="pymatgen.io.aims.inputs.AimsGeometryIn"><span class="pre">AimsGeometryIn</span></a></span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/core/../io/aims/inputs.py#L43-L105"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.inputs.AimsGeometryIn.from_str" title="Link to this definition"></a></dt>
<dd><p>Create an input from the content of an input file</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>contents</strong> (<em>str</em>) – The content of the file</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The AimsGeometryIn file for the string contents</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.io.aims.inputs.AimsGeometryIn.from_structure">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_structure</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">structure</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="pymatgen.core.html#pymatgen.core.structure.Structure" title="pymatgen.core.structure.Structure"><span class="pre">Structure</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="pymatgen.core.html#pymatgen.core.structure.Molecule" title="pymatgen.core.structure.Molecule"><span class="pre">Molecule</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsGeometryIn" title="pymatgen.io.aims.inputs.AimsGeometryIn"><span class="pre">AimsGeometryIn</span></a></span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/core/../io/aims/inputs.py#L125-L150"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.inputs.AimsGeometryIn.from_structure" title="Link to this definition"></a></dt>
<dd><p>Construct an input file from an input structure.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>structure</strong> (<a class="reference internal" href="pymatgen.core.html#pymatgen.core.structure.Structure" title="pymatgen.core.structure.Structure"><em>Structure</em></a><em> or </em><a class="reference internal" href="pymatgen.core.html#pymatgen.core.structure.Molecule" title="pymatgen.core.structure.Molecule"><em>Molecule</em></a>) – The structure for the file</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The input object for the structure</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#pymatgen.io.aims.inputs.AimsGeometryIn" title="pymatgen.io.aims.inputs.AimsGeometryIn">AimsGeometryIn</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.io.aims.inputs.AimsGeometryIn.structure">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">structure</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.structure.Structure" title="pymatgen.core.structure.Structure"><span class="pre">Structure</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="pymatgen.core.html#pymatgen.core.structure.Molecule" title="pymatgen.core.structure.Molecule"><span class="pre">Molecule</span></a></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/io/aims/inputs.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.inputs.AimsGeometryIn.structure" title="Link to this definition"></a></dt>
<dd><p>Access structure for the file</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.io.aims.inputs.AimsGeometryIn.write_file">
<span class="sig-name descname"><span class="pre">write_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">directory</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">Path</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">overwrite</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">None</span></span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/core/../io/aims/inputs.py#L162-L181"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.inputs.AimsGeometryIn.write_file" title="Link to this definition"></a></dt>
<dd><p>Write the geometry.in 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>directory</strong> (<em>str</em><em> | </em><em>Path</em><em> | </em><em>None</em>) – The directory to write the geometry.in file</p></li>
<li><p><strong>overwrite</strong> (<em>bool</em>) – If True allow to overwrite existing files</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
</section>
<section id="module-pymatgen.io.aims.outputs">
<span id="pymatgen-io-aims-outputs-module"></span><h2>pymatgen.io.aims.outputs module<a class="headerlink" href="#module-pymatgen.io.aims.outputs" title="Link to this heading"></a></h2>
<p>A representation of FHI-aims output (based on ASE output parser).</p>
<dl class="py class">
<dt class="sig sig-object py" id="pymatgen.io.aims.outputs.AimsOutput">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AimsOutput</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">results</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="pymatgen.core.html#pymatgen.core.structure.Molecule" title="pymatgen.core.structure.Molecule"><span class="pre">Molecule</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="pymatgen.core.html#pymatgen.core.structure.Structure" title="pymatgen.core.structure.Structure"><span class="pre">Structure</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="pymatgen.core.html#pymatgen.core.structure.Molecule" title="pymatgen.core.structure.Molecule"><span class="pre">Molecule</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="pymatgen.core.html#pymatgen.core.structure.Structure" title="pymatgen.core.structure.Structure"><span class="pre">Structure</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">structure_summary</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><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/v2024.3.1/pymatgen/core/../io/aims/outputs.py#L31-L220"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.outputs.AimsOutput" 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>The main output file for FHI-aims.</p>
<p>AimsOutput object constructor.</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>results</strong> (<a class="reference internal" href="pymatgen.core.html#pymatgen.core.structure.Molecule" title="pymatgen.core.structure.Molecule"><em>Molecule</em></a><em> or </em><a class="reference internal" href="pymatgen.core.html#pymatgen.core.structure.Structure" title="pymatgen.core.structure.Structure"><em>Structure</em></a><em> or </em><em>Sequence</em><em>[</em><a class="reference internal" href="pymatgen.core.html#pymatgen.core.structure.Molecule" title="pymatgen.core.structure.Molecule"><em>Molecule</em></a><em> or </em><a class="reference internal" href="pymatgen.core.html#pymatgen.core.structure.Structure" title="pymatgen.core.structure.Structure"><em>Structure</em></a><em>]</em>) – A list
of all images in an output file</p></li>
<li><p><strong>metadata</strong> (<em>Dict</em><em>[</em><em>str</em><em>, </em><em>Any</em><em>]</em>) – The metadata of the executable used to perform
the calculation</p></li>
<li><p><strong>structure_summary</strong> (<em>Dict</em><em>[</em><em>str</em><em>, </em><em>Any</em><em>]</em>) – The summary of the starting
atomic structure</p></li>
</ul>
</dd>
</dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.io.aims.outputs.AimsOutput.aims_version">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">aims_version</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/v2024.3.1/pymatgen/io/aims/outputs.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.outputs.AimsOutput.aims_version" title="Link to this definition"></a></dt>
<dd><p>The version of FHI-aims used for the calculation.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.io.aims.outputs.AimsOutput.all_forces">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">all_forces</span></span><em class="property"><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 class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">Vector3D</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/v2024.3.1/pymatgen/io/aims/outputs.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.outputs.AimsOutput.all_forces" title="Link to this definition"></a></dt>
<dd><p>The forces for all images in the calculation.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.io.aims.outputs.AimsOutput.as_dict">
<span class="sig-name descname"><span class="pre">as_dict</span></span><span class="sig-paren">(</span><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 class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/core/../io/aims/outputs.py#L54-L61"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.outputs.AimsOutput.as_dict" title="Link to this definition"></a></dt>
<dd><p>Create a dict representation of the outputs for MSONable.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.io.aims.outputs.AimsOutput.band_gap">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">band_gap</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/v2024.3.1/pymatgen/io/aims/outputs.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.outputs.AimsOutput.band_gap" title="Link to this definition"></a></dt>
<dd><p>The band gap for the final structure in the calculation.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.io.aims.outputs.AimsOutput.cbm">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cbm</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/v2024.3.1/pymatgen/io/aims/outputs.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.outputs.AimsOutput.cbm" title="Link to this definition"></a></dt>
<dd><p>The LUMO level for the final structure in the calculation.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.io.aims.outputs.AimsOutput.completed">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">completed</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/io/aims/outputs.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.outputs.AimsOutput.completed" title="Link to this definition"></a></dt>
<dd><p>Did the calculation complete.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.io.aims.outputs.AimsOutput.direct_band_gap">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">direct_band_gap</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/v2024.3.1/pymatgen/io/aims/outputs.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.outputs.AimsOutput.direct_band_gap" title="Link to this definition"></a></dt>
<dd><p>The direct band gap for the final structure in the calculation.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.io.aims.outputs.AimsOutput.fermi_energy">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fermi_energy</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/v2024.3.1/pymatgen/io/aims/outputs.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.outputs.AimsOutput.fermi_energy" title="Link to this definition"></a></dt>
<dd><p>The Fermi energy for the final structure in the calculation.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.io.aims.outputs.AimsOutput.final_energy">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">final_energy</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/v2024.3.1/pymatgen/io/aims/outputs.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.outputs.AimsOutput.final_energy" title="Link to this definition"></a></dt>
<dd><p>The total energy for the final structure in the calculation.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.io.aims.outputs.AimsOutput.final_structure">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">final_structure</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.structure.Structure" title="pymatgen.core.structure.Structure"><span class="pre">Structure</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="pymatgen.core.html#pymatgen.core.structure.Molecule" title="pymatgen.core.structure.Molecule"><span class="pre">Molecule</span></a></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/io/aims/outputs.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.outputs.AimsOutput.final_structure" title="Link to this definition"></a></dt>
<dd><p>The final structure for the calculation.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.io.aims.outputs.AimsOutput.forces">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">forces</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">Vector3D</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/io/aims/outputs.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.outputs.AimsOutput.forces" title="Link to this definition"></a></dt>
<dd><p>The forces for the final image of the calculation.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.io.aims.outputs.AimsOutput.from_dict">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dct</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#pymatgen.io.aims.outputs.AimsOutput" title="pymatgen.io.aims.outputs.AimsOutput"><span class="pre">AimsOutput</span></a></span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/core/../io/aims/outputs.py#L93-L111"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.outputs.AimsOutput.from_dict" title="Link to this definition"></a></dt>
<dd><p>Construct an AimsOutput from a dictionary.</p>
<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><em>[</em><em>str</em><em>, </em><em>Any</em><em>]</em>) – The dictionary used to create AimsOutput</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>AimsOutput</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.io.aims.outputs.AimsOutput.from_outfile">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_outfile</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">outfile</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">Path</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#pymatgen.io.aims.outputs.AimsOutput" title="pymatgen.io.aims.outputs.AimsOutput"><span class="pre">AimsOutput</span></a></span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/core/../io/aims/outputs.py#L63-L76"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.outputs.AimsOutput.from_outfile" title="Link to this definition"></a></dt>
<dd><p>Construct an AimsOutput from an output file.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>outfile</strong> – str | Path: The aims.out file to parse</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The AimsOutput object for the output file</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.io.aims.outputs.AimsOutput.from_str">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_str</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">content</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> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#pymatgen.io.aims.outputs.AimsOutput" title="pymatgen.io.aims.outputs.AimsOutput"><span class="pre">AimsOutput</span></a></span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/core/../io/aims/outputs.py#L78-L91"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.outputs.AimsOutput.from_str" title="Link to this definition"></a></dt>
<dd><p>Construct an AimsOutput from an output file.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>content</strong> (<em>str</em>) – The content of the aims.out file</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The AimsOutput for the output file content</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pymatgen.io.aims.outputs.AimsOutput.get_results_for_image">
<span class="sig-name descname"><span class="pre">get_results_for_image</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">image_ind</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="pymatgen.core.html#pymatgen.core.structure.Structure" title="pymatgen.core.structure.Structure"><span class="pre">Structure</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="pymatgen.core.html#pymatgen.core.structure.Molecule" title="pymatgen.core.structure.Molecule"><span class="pre">Molecule</span></a></span></span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/core/../io/aims/outputs.py#L113-L122"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.outputs.AimsOutput.get_results_for_image" title="Link to this definition"></a></dt>
<dd><p>Get the results dictionary for a particular image or slice of images.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>image_ind</strong> (<em>int</em>) – The index of the image to get the results for</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The results of the image with index images_ind</p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.io.aims.outputs.AimsOutput.initial_structure">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">initial_structure</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.structure.Structure" title="pymatgen.core.structure.Structure"><span class="pre">Structure</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="pymatgen.core.html#pymatgen.core.structure.Molecule" title="pymatgen.core.structure.Molecule"><span class="pre">Molecule</span></a></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/io/aims/outputs.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.outputs.AimsOutput.initial_structure" title="Link to this definition"></a></dt>
<dd><p>The initial structure for the calculations.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.io.aims.outputs.AimsOutput.metadata">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">metadata</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/io/aims/outputs.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.outputs.AimsOutput.metadata" title="Link to this definition"></a></dt>
<dd><p>The system metadata.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.io.aims.outputs.AimsOutput.n_images">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">n_images</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/io/aims/outputs.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.outputs.AimsOutput.n_images" title="Link to this definition"></a></dt>
<dd><p>The number of images in results.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.io.aims.outputs.AimsOutput.stress">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">stress</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Matrix3D</span></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/io/aims/outputs.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.outputs.AimsOutput.stress" title="Link to this definition"></a></dt>
<dd><p>The stress for the final image of the calculation.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.io.aims.outputs.AimsOutput.stresses">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">stresses</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">Matrix3D</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/io/aims/outputs.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.outputs.AimsOutput.stresses" title="Link to this definition"></a></dt>
<dd><p>The atomic virial stresses for the final image of the calculation.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.io.aims.outputs.AimsOutput.structure_summary">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">structure_summary</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/io/aims/outputs.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.outputs.AimsOutput.structure_summary" title="Link to this definition"></a></dt>
<dd><p>The summary of the material/molecule that the calculations represent.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.io.aims.outputs.AimsOutput.structures">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">structures</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="pymatgen.core.html#pymatgen.core.structure.Structure" title="pymatgen.core.structure.Structure"><span class="pre">Structure</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="pymatgen.core.html#pymatgen.core.structure.Molecule" title="pymatgen.core.structure.Molecule"><span class="pre">Molecule</span></a><span class="p"><span class="pre">]</span></span></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/io/aims/outputs.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.outputs.AimsOutput.structures" title="Link to this definition"></a></dt>
<dd><p>All images in the output file.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.io.aims.outputs.AimsOutput.vbm">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">vbm</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/v2024.3.1/pymatgen/io/aims/outputs.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.outputs.AimsOutput.vbm" title="Link to this definition"></a></dt>
<dd><p>The HOMO level for the final structure in the calculation.</p>
</dd></dl>
</dd></dl>
</section>
<section id="module-pymatgen.io.aims.parsers">
<span id="pymatgen-io-aims-parsers-module"></span><h2>pymatgen.io.aims.parsers module<a class="headerlink" href="#module-pymatgen.io.aims.parsers" title="Link to this heading"></a></h2>
<p>AIMS output parser, taken from ASE with modifications.</p>
<dl class="py class">
<dt class="sig sig-object py" id="pymatgen.io.aims.parsers.AimsOutCalcChunk">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AimsOutCalcChunk</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">lines</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">header</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutHeaderChunk" title="pymatgen.io.aims.parsers.AimsOutHeaderChunk"><span class="pre">AimsOutHeaderChunk</span></a></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/core/../io/aims/parsers.py#L465-L938"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pymatgen.io.aims.parsers.AimsOutChunk" title="pymatgen.io.aims.parsers.AimsOutChunk"><code class="xref py py-class docutils literal notranslate"><span class="pre">AimsOutChunk</span></code></a></p>
<p>A part of the aims.out file corresponding to a single structure.</p>
<p>Construct the AimsOutCalcChunk.</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>lines</strong> (<em>list</em><em>[</em><em>str</em><em>]</em>) – The lines used for the structure</p></li>
<li><p><strong>header</strong> (<em>.AimsOutHeaderChunk</em>) – A summary of the relevant information from
the aims.out header</p></li>
</ul>
</dd>
</dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.io.aims.parsers.AimsOutCalcChunk.E_f">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">E_f</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="reference external" href="https://github.com/materialsproject/pymatgen/blob/v2024.3.1/pymatgen/io/aims/parsers.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk.E_f" title="Link to this definition"></a></dt>
<dd><p>The Fermi energy</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pymatgen.io.aims.parsers.AimsOutCalcChunk.cbm">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cbm</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/v2024.3.1/pymatgen/io/aims/parsers.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pymatgen.io.aims.parsers.AimsOutCalcChunk.cbm" title="Link to this definition"></a></dt>
<dd><p>The conduction band minimnum</p>
</dd></dl>