-
Notifications
You must be signed in to change notification settings - Fork 838
/
materials.html
485 lines (426 loc) · 56.3 KB
/
materials.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
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>pymatgen.alchemy.materials — pymatgen 2019.9.16 documentation</title>
<link rel="stylesheet" href="../../../_static/proBlue.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../_static/language_data.js"></script>
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-33990148-1']);
_gaq.push(['_trackPageview']);
</script>
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">pymatgen 2019.9.16 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> »</li>
<li class="nav-item nav-item-2"><a href="../../pymatgen.html" accesskey="U">pymatgen</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for pymatgen.alchemy.materials</h1><div class="highlight"><pre>
<span></span><span class="c1"># coding: utf-8</span>
<span class="c1"># Copyright (c) Pymatgen Development Team.</span>
<span class="c1"># Distributed under the terms of the MIT License.</span>
<span class="sd">"""</span>
<span class="sd">This module provides various representations of transformed structures. A</span>
<span class="sd">TransformedStructure is a structure that has been modified by undergoing a</span>
<span class="sd">series of transformations.</span>
<span class="sd">"""</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">re</span>
<span class="kn">import</span> <span class="nn">json</span>
<span class="kn">import</span> <span class="nn">datetime</span>
<span class="kn">from</span> <span class="nn">monty.json</span> <span class="k">import</span> <span class="n">MontyDecoder</span><span class="p">,</span> <span class="n">jsanitize</span>
<span class="kn">from</span> <span class="nn">pymatgen.core.structure</span> <span class="k">import</span> <span class="n">Structure</span>
<span class="kn">from</span> <span class="nn">pymatgen.io.cif</span> <span class="k">import</span> <span class="n">CifParser</span>
<span class="kn">from</span> <span class="nn">pymatgen.io.vasp.inputs</span> <span class="k">import</span> <span class="n">Poscar</span>
<span class="kn">from</span> <span class="nn">monty.json</span> <span class="k">import</span> <span class="n">MSONable</span>
<span class="kn">from</span> <span class="nn">pymatgen.io.vasp.sets</span> <span class="k">import</span> <span class="n">MPRelaxSet</span>
<span class="kn">from</span> <span class="nn">warnings</span> <span class="k">import</span> <span class="n">warn</span>
<span class="n">__author__</span> <span class="o">=</span> <span class="s2">"Shyue Ping Ong, Will Richards"</span>
<span class="n">__copyright__</span> <span class="o">=</span> <span class="s2">"Copyright 2012, The Materials Project"</span>
<span class="n">__version__</span> <span class="o">=</span> <span class="s2">"1.0"</span>
<span class="n">__maintainer__</span> <span class="o">=</span> <span class="s2">"Shyue Ping Ong"</span>
<span class="n">__email__</span> <span class="o">=</span> <span class="s2">"shyuep@gmail.com"</span>
<span class="n">__date__</span> <span class="o">=</span> <span class="s2">"Mar 2, 2012"</span>
<span class="n">dec</span> <span class="o">=</span> <span class="n">MontyDecoder</span><span class="p">()</span>
<div class="viewcode-block" id="TransformedStructure"><a class="viewcode-back" href="../../../pymatgen.alchemy.materials.html#pymatgen.alchemy.materials.TransformedStructure">[docs]</a><span class="k">class</span> <span class="nc">TransformedStructure</span><span class="p">(</span><span class="n">MSONable</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Container object for new structures that include history of</span>
<span class="sd"> transformations.</span>
<span class="sd"> Each transformed structure is made up of a sequence of structures with</span>
<span class="sd"> associated transformation history.</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">structure</span><span class="p">,</span> <span class="n">transformations</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">history</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">other_parameters</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Initializes a transformed structure from a structure.</span>
<span class="sd"> Args:</span>
<span class="sd"> structure (Structure): Input structure</span>
<span class="sd"> transformations ([Transformations]): List of transformations to</span>
<span class="sd"> apply.</span>
<span class="sd"> history (list): Previous history.</span>
<span class="sd"> other_parameters (dict): Additional parameters to be added.</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">final_structure</span> <span class="o">=</span> <span class="n">structure</span>
<span class="bp">self</span><span class="o">.</span><span class="n">history</span> <span class="o">=</span> <span class="n">history</span> <span class="ow">or</span> <span class="p">[]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">other_parameters</span> <span class="o">=</span> <span class="n">other_parameters</span> <span class="ow">or</span> <span class="p">{}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_undone</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">transformations</span> <span class="o">=</span> <span class="n">transformations</span> <span class="ow">or</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">t</span> <span class="ow">in</span> <span class="n">transformations</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">append_transformation</span><span class="p">(</span><span class="n">t</span><span class="p">)</span>
<div class="viewcode-block" id="TransformedStructure.undo_last_change"><a class="viewcode-back" href="../../../pymatgen.alchemy.materials.html#pymatgen.alchemy.materials.TransformedStructure.undo_last_change">[docs]</a> <span class="k">def</span> <span class="nf">undo_last_change</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Undo the last change in the TransformedStructure.</span>
<span class="sd"> Raises:</span>
<span class="sd"> IndexError: If already at the oldest change.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">history</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">IndexError</span><span class="p">(</span><span class="s2">"Can't undo. Already at oldest change."</span><span class="p">)</span>
<span class="k">if</span> <span class="s1">'input_structure'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">history</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]:</span>
<span class="k">raise</span> <span class="ne">IndexError</span><span class="p">(</span><span class="s2">"Can't undo. Latest history has no "</span>
<span class="s2">"input_structure"</span><span class="p">)</span>
<span class="n">h</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">history</span><span class="o">.</span><span class="n">pop</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_undone</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">h</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">final_structure</span><span class="p">))</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">h</span><span class="p">[</span><span class="s2">"input_structure"</span><span class="p">]</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">Structure</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">final_structure</span> <span class="o">=</span> <span class="n">s</span></div>
<div class="viewcode-block" id="TransformedStructure.redo_next_change"><a class="viewcode-back" href="../../../pymatgen.alchemy.materials.html#pymatgen.alchemy.materials.TransformedStructure.redo_next_change">[docs]</a> <span class="k">def</span> <span class="nf">redo_next_change</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Redo the last undone change in the TransformedStructure.</span>
<span class="sd"> Raises:</span>
<span class="sd"> IndexError: If already at the latest change.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_undone</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">IndexError</span><span class="p">(</span><span class="s2">"Can't redo. Already at latest change."</span><span class="p">)</span>
<span class="n">h</span><span class="p">,</span> <span class="n">s</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_undone</span><span class="o">.</span><span class="n">pop</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">h</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">final_structure</span> <span class="o">=</span> <span class="n">s</span></div>
<span class="k">def</span> <span class="nf">__getattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
<span class="n">s</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="fm">__getattribute__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s1">'final_structure'</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__len__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">history</span><span class="p">)</span>
<div class="viewcode-block" id="TransformedStructure.append_transformation"><a class="viewcode-back" href="../../../pymatgen.alchemy.materials.html#pymatgen.alchemy.materials.TransformedStructure.append_transformation">[docs]</a> <span class="k">def</span> <span class="nf">append_transformation</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">transformation</span><span class="p">,</span> <span class="n">return_alternatives</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
<span class="n">clear_redo</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Appends a transformation to the TransformedStructure.</span>
<span class="sd"> Args:</span>
<span class="sd"> transformation: Transformation to append</span>
<span class="sd"> return_alternatives: Whether to return alternative</span>
<span class="sd"> TransformedStructures for one-to-many transformations.</span>
<span class="sd"> return_alternatives can be a number, which stipulates the</span>
<span class="sd"> total number of structures to return.</span>
<span class="sd"> clear_redo: Boolean indicating whether to clear the redo list.</span>
<span class="sd"> By default, this is True, meaning any appends clears the</span>
<span class="sd"> history of undoing. However, when using append_transformation</span>
<span class="sd"> to do a redo, the redo list should not be cleared to allow</span>
<span class="sd"> multiple redos.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">clear_redo</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_undone</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">if</span> <span class="n">return_alternatives</span> <span class="ow">and</span> <span class="n">transformation</span><span class="o">.</span><span class="n">is_one_to_many</span><span class="p">:</span>
<span class="n">ranked_list</span> <span class="o">=</span> <span class="n">transformation</span><span class="o">.</span><span class="n">apply_transformation</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">final_structure</span><span class="p">,</span> <span class="n">return_ranked_list</span><span class="o">=</span><span class="n">return_alternatives</span><span class="p">)</span>
<span class="n">input_structure</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">final_structure</span><span class="o">.</span><span class="n">as_dict</span><span class="p">()</span>
<span class="n">alts</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">ranked_list</span><span class="p">[</span><span class="mi">1</span><span class="p">:]:</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">x</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">"structure"</span><span class="p">)</span>
<span class="n">actual_transformation</span> <span class="o">=</span> <span class="n">x</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">"transformation"</span><span class="p">,</span> <span class="n">transformation</span><span class="p">)</span>
<span class="n">hdict</span> <span class="o">=</span> <span class="n">actual_transformation</span><span class="o">.</span><span class="n">as_dict</span><span class="p">()</span>
<span class="n">hdict</span><span class="p">[</span><span class="s2">"input_structure"</span><span class="p">]</span> <span class="o">=</span> <span class="n">input_structure</span>
<span class="n">hdict</span><span class="p">[</span><span class="s2">"output_parameters"</span><span class="p">]</span> <span class="o">=</span> <span class="n">x</span>
<span class="bp">self</span><span class="o">.</span><span class="n">final_structure</span> <span class="o">=</span> <span class="n">s</span>
<span class="n">d</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">as_dict</span><span class="p">()</span>
<span class="n">d</span><span class="p">[</span><span class="s1">'history'</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">hdict</span><span class="p">)</span>
<span class="n">d</span><span class="p">[</span><span class="s1">'final_structure'</span><span class="p">]</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">as_dict</span><span class="p">()</span>
<span class="n">alts</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">TransformedStructure</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">d</span><span class="p">))</span>
<span class="n">x</span> <span class="o">=</span> <span class="n">ranked_list</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">x</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">"structure"</span><span class="p">)</span>
<span class="n">actual_transformation</span> <span class="o">=</span> <span class="n">x</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">"transformation"</span><span class="p">,</span> <span class="n">transformation</span><span class="p">)</span>
<span class="n">hdict</span> <span class="o">=</span> <span class="n">actual_transformation</span><span class="o">.</span><span class="n">as_dict</span><span class="p">()</span>
<span class="n">hdict</span><span class="p">[</span><span class="s2">"input_structure"</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">final_structure</span><span class="o">.</span><span class="n">as_dict</span><span class="p">()</span>
<span class="n">hdict</span><span class="p">[</span><span class="s2">"output_parameters"</span><span class="p">]</span> <span class="o">=</span> <span class="n">x</span>
<span class="bp">self</span><span class="o">.</span><span class="n">history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">hdict</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">final_structure</span> <span class="o">=</span> <span class="n">s</span>
<span class="k">return</span> <span class="n">alts</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">transformation</span><span class="o">.</span><span class="n">apply_transformation</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">final_structure</span><span class="p">)</span>
<span class="n">hdict</span> <span class="o">=</span> <span class="n">transformation</span><span class="o">.</span><span class="n">as_dict</span><span class="p">()</span>
<span class="n">hdict</span><span class="p">[</span><span class="s2">"input_structure"</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">final_structure</span><span class="o">.</span><span class="n">as_dict</span><span class="p">()</span>
<span class="n">hdict</span><span class="p">[</span><span class="s2">"output_parameters"</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">hdict</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">final_structure</span> <span class="o">=</span> <span class="n">s</span></div>
<div class="viewcode-block" id="TransformedStructure.append_filter"><a class="viewcode-back" href="../../../pymatgen.alchemy.materials.html#pymatgen.alchemy.materials.TransformedStructure.append_filter">[docs]</a> <span class="k">def</span> <span class="nf">append_filter</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">structure_filter</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Adds a filter.</span>
<span class="sd"> Args:</span>
<span class="sd"> structure_filter (StructureFilter): A filter implementating the</span>
<span class="sd"> AbstractStructureFilter API. Tells transmuter waht structures</span>
<span class="sd"> to retain.</span>
<span class="sd"> """</span>
<span class="n">hdict</span> <span class="o">=</span> <span class="n">structure_filter</span><span class="o">.</span><span class="n">as_dict</span><span class="p">()</span>
<span class="n">hdict</span><span class="p">[</span><span class="s2">"input_structure"</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">final_structure</span><span class="o">.</span><span class="n">as_dict</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">history</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">hdict</span><span class="p">)</span></div>
<div class="viewcode-block" id="TransformedStructure.extend_transformations"><a class="viewcode-back" href="../../../pymatgen.alchemy.materials.html#pymatgen.alchemy.materials.TransformedStructure.extend_transformations">[docs]</a> <span class="k">def</span> <span class="nf">extend_transformations</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">transformations</span><span class="p">,</span>
<span class="n">return_alternatives</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Extends a sequence of transformations to the TransformedStructure.</span>
<span class="sd"> Args:</span>
<span class="sd"> transformations: Sequence of Transformations</span>
<span class="sd"> return_alternatives: Whether to return alternative</span>
<span class="sd"> TransformedStructures for one-to-many transformations.</span>
<span class="sd"> return_alternatives can be a number, which stipulates the</span>
<span class="sd"> total number of structures to return.</span>
<span class="sd"> """</span>
<span class="k">for</span> <span class="n">t</span> <span class="ow">in</span> <span class="n">transformations</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">append_transformation</span><span class="p">(</span><span class="n">t</span><span class="p">,</span>
<span class="n">return_alternatives</span><span class="o">=</span><span class="n">return_alternatives</span><span class="p">)</span></div>
<div class="viewcode-block" id="TransformedStructure.get_vasp_input"><a class="viewcode-back" href="../../../pymatgen.alchemy.materials.html#pymatgen.alchemy.materials.TransformedStructure.get_vasp_input">[docs]</a> <span class="k">def</span> <span class="nf">get_vasp_input</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">vasp_input_set</span><span class="o">=</span><span class="n">MPRelaxSet</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Returns VASP input as a dict of vasp objects.</span>
<span class="sd"> Args:</span>
<span class="sd"> vasp_input_set (pymatgen.io.vaspio_set.VaspInputSet): input set</span>
<span class="sd"> to create vasp input files from structures</span>
<span class="sd"> """</span>
<span class="n">d</span> <span class="o">=</span> <span class="n">vasp_input_set</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">final_structure</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span><span class="o">.</span><span class="n">get_vasp_input</span><span class="p">()</span>
<span class="n">d</span><span class="p">[</span><span class="s2">"transformations.json"</span><span class="p">]</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">as_dict</span><span class="p">())</span>
<span class="k">return</span> <span class="n">d</span></div>
<div class="viewcode-block" id="TransformedStructure.write_vasp_input"><a class="viewcode-back" href="../../../pymatgen.alchemy.materials.html#pymatgen.alchemy.materials.TransformedStructure.write_vasp_input">[docs]</a> <span class="k">def</span> <span class="nf">write_vasp_input</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">vasp_input_set</span><span class="o">=</span><span class="n">MPRelaxSet</span><span class="p">,</span> <span class="n">output_dir</span><span class="o">=</span><span class="s2">"."</span><span class="p">,</span>
<span class="n">create_directory</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sa">r</span><span class="sd">"""</span>
<span class="sd"> Writes VASP input to an output_dir.</span>
<span class="sd"> Args:</span>
<span class="sd"> vasp_input_set:</span>
<span class="sd"> pymatgen.io.vaspio_set.VaspInputSet like object that creates</span>
<span class="sd"> vasp input files from structures</span>
<span class="sd"> output_dir: Directory to output files</span>
<span class="sd"> create_directory: Create the directory if not present. Defaults to</span>
<span class="sd"> True.</span>
<span class="sd"> **kwargs: All keyword args supported by the VASP input set.</span>
<span class="sd"> """</span>
<span class="n">vasp_input_set</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">final_structure</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span><span class="o">.</span><span class="n">write_input</span><span class="p">(</span>
<span class="n">output_dir</span><span class="p">,</span> <span class="n">make_dir_if_not_present</span><span class="o">=</span><span class="n">create_directory</span><span class="p">)</span>
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">output_dir</span><span class="p">,</span> <span class="s2">"transformations.json"</span><span class="p">),</span> <span class="s2">"w"</span><span class="p">)</span> <span class="k">as</span> <span class="n">fp</span><span class="p">:</span>
<span class="n">json</span><span class="o">.</span><span class="n">dump</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">as_dict</span><span class="p">(),</span> <span class="n">fp</span><span class="p">)</span></div>
<span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">output</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"Current structure"</span><span class="p">,</span> <span class="s2">"------------"</span><span class="p">,</span>
<span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">final_structure</span><span class="p">),</span>
<span class="s2">"</span><span class="se">\n</span><span class="s2">History"</span><span class="p">,</span>
<span class="s2">"------------"</span><span class="p">]</span>
<span class="k">for</span> <span class="n">h</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">history</span><span class="p">:</span>
<span class="n">h</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s1">'input_structure'</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<span class="n">output</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">h</span><span class="p">))</span>
<span class="n">output</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">Other parameters"</span><span class="p">)</span>
<span class="n">output</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">"------------"</span><span class="p">)</span>
<span class="n">output</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">other_parameters</span><span class="p">))</span>
<span class="k">return</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">output</span><span class="p">)</span>
<div class="viewcode-block" id="TransformedStructure.set_parameter"><a class="viewcode-back" href="../../../pymatgen.alchemy.materials.html#pymatgen.alchemy.materials.TransformedStructure.set_parameter">[docs]</a> <span class="k">def</span> <span class="nf">set_parameter</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Set a parameter</span>
<span class="sd"> :param key: The string key</span>
<span class="sd"> :param value: The value.</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">other_parameters</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span></div>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">was_modified</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Boolean describing whether the last transformation on the structure</span>
<span class="sd"> made any alterations to it one example of when this would return false</span>
<span class="sd"> is in the case of performing a substitution transformation on the</span>
<span class="sd"> structure when the specie to replace isn't in the structure.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">final_structure</span> <span class="o">==</span> <span class="bp">self</span><span class="o">.</span><span class="n">structures</span><span class="p">[</span><span class="o">-</span><span class="mi">2</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">structures</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Copy of all structures in the TransformedStructure. A</span>
<span class="sd"> structure is stored after every single transformation.</span>
<span class="sd"> """</span>
<span class="n">hstructs</span> <span class="o">=</span> <span class="p">[</span><span class="n">Structure</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">s</span><span class="p">[</span><span class="s1">'input_structure'</span><span class="p">])</span>
<span class="k">for</span> <span class="n">s</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">history</span> <span class="k">if</span> <span class="s1">'input_structure'</span> <span class="ow">in</span> <span class="n">s</span><span class="p">]</span>
<span class="k">return</span> <span class="n">hstructs</span> <span class="o">+</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">final_structure</span><span class="p">]</span>
<div class="viewcode-block" id="TransformedStructure.from_cif_string"><a class="viewcode-back" href="../../../pymatgen.alchemy.materials.html#pymatgen.alchemy.materials.TransformedStructure.from_cif_string">[docs]</a> <span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">from_cif_string</span><span class="p">(</span><span class="n">cif_string</span><span class="p">,</span> <span class="n">transformations</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">primitive</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="n">occupancy_tolerance</span><span class="o">=</span><span class="mf">1.</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Generates TransformedStructure from a cif string.</span>
<span class="sd"> Args:</span>
<span class="sd"> cif_string (str): Input cif string. Should contain only one</span>
<span class="sd"> structure. For cifs containing multiple structures, please use</span>
<span class="sd"> CifTransmuter.</span>
<span class="sd"> transformations ([Transformations]): Sequence of transformations</span>
<span class="sd"> to be applied to the input structure.</span>
<span class="sd"> primitive (bool): Option to set if the primitive cell should be</span>
<span class="sd"> extracted. Defaults to True. However, there are certain</span>
<span class="sd"> instances where you might want to use a non-primitive cell,</span>
<span class="sd"> e.g., if you are trying to generate all possible orderings of</span>
<span class="sd"> partial removals or order a disordered structure.</span>
<span class="sd"> occupancy_tolerance (float): If total occupancy of a site is</span>
<span class="sd"> between 1 and occupancy_tolerance, the occupancies will be</span>
<span class="sd"> scaled down to 1.</span>
<span class="sd"> Returns:</span>
<span class="sd"> TransformedStructure</span>
<span class="sd"> """</span>
<span class="n">parser</span> <span class="o">=</span> <span class="n">CifParser</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">cif_string</span><span class="p">,</span> <span class="n">occupancy_tolerance</span><span class="p">)</span>
<span class="n">raw_string</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="sa">r</span><span class="s2">"'"</span><span class="p">,</span> <span class="s2">"</span><span class="se">\"</span><span class="s2">"</span><span class="p">,</span> <span class="n">cif_string</span><span class="p">)</span>
<span class="n">cif_dict</span> <span class="o">=</span> <span class="n">parser</span><span class="o">.</span><span class="n">as_dict</span><span class="p">()</span>
<span class="n">cif_keys</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">cif_dict</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">parser</span><span class="o">.</span><span class="n">get_structures</span><span class="p">(</span><span class="n">primitive</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">partial_cif</span> <span class="o">=</span> <span class="n">cif_dict</span><span class="p">[</span><span class="n">cif_keys</span><span class="p">[</span><span class="mi">0</span><span class="p">]]</span>
<span class="k">if</span> <span class="s2">"_database_code_ICSD"</span> <span class="ow">in</span> <span class="n">partial_cif</span><span class="p">:</span>
<span class="n">source</span> <span class="o">=</span> <span class="n">partial_cif</span><span class="p">[</span><span class="s2">"_database_code_ICSD"</span><span class="p">]</span> <span class="o">+</span> <span class="s2">"-ICSD"</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">source</span> <span class="o">=</span> <span class="s2">"uploaded cif"</span>
<span class="n">source_info</span> <span class="o">=</span> <span class="p">{</span><span class="s2">"source"</span><span class="p">:</span> <span class="n">source</span><span class="p">,</span>
<span class="s2">"datetime"</span><span class="p">:</span> <span class="nb">str</span><span class="p">(</span><span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()),</span>
<span class="s2">"original_file"</span><span class="p">:</span> <span class="n">raw_string</span><span class="p">,</span>
<span class="s2">"cif_data"</span><span class="p">:</span> <span class="n">cif_dict</span><span class="p">[</span><span class="n">cif_keys</span><span class="p">[</span><span class="mi">0</span><span class="p">]]}</span>
<span class="k">return</span> <span class="n">TransformedStructure</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">transformations</span><span class="p">,</span> <span class="n">history</span><span class="o">=</span><span class="p">[</span><span class="n">source_info</span><span class="p">])</span></div>
<div class="viewcode-block" id="TransformedStructure.from_poscar_string"><a class="viewcode-back" href="../../../pymatgen.alchemy.materials.html#pymatgen.alchemy.materials.TransformedStructure.from_poscar_string">[docs]</a> <span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">from_poscar_string</span><span class="p">(</span><span class="n">poscar_string</span><span class="p">,</span> <span class="n">transformations</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Generates TransformedStructure from a poscar string.</span>
<span class="sd"> Args:</span>
<span class="sd"> poscar_string (str): Input POSCAR string.</span>
<span class="sd"> transformations ([Transformations]): Sequence of transformations</span>
<span class="sd"> to be applied to the input structure.</span>
<span class="sd"> """</span>
<span class="n">p</span> <span class="o">=</span> <span class="n">Poscar</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">poscar_string</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">p</span><span class="o">.</span><span class="n">true_names</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Transformation can be craeted only from POSCAR "</span>
<span class="s2">"strings with proper VASP5 element symbols."</span><span class="p">)</span>
<span class="n">raw_string</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="sa">r</span><span class="s2">"'"</span><span class="p">,</span> <span class="s2">"</span><span class="se">\"</span><span class="s2">"</span><span class="p">,</span> <span class="n">poscar_string</span><span class="p">)</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">p</span><span class="o">.</span><span class="n">structure</span>
<span class="n">source_info</span> <span class="o">=</span> <span class="p">{</span><span class="s2">"source"</span><span class="p">:</span> <span class="s2">"POSCAR"</span><span class="p">,</span>
<span class="s2">"datetime"</span><span class="p">:</span> <span class="nb">str</span><span class="p">(</span><span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()),</span>
<span class="s2">"original_file"</span><span class="p">:</span> <span class="n">raw_string</span><span class="p">}</span>
<span class="k">return</span> <span class="n">TransformedStructure</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">transformations</span><span class="p">,</span> <span class="n">history</span><span class="o">=</span><span class="p">[</span><span class="n">source_info</span><span class="p">])</span></div>
<div class="viewcode-block" id="TransformedStructure.as_dict"><a class="viewcode-back" href="../../../pymatgen.alchemy.materials.html#pymatgen.alchemy.materials.TransformedStructure.as_dict">[docs]</a> <span class="k">def</span> <span class="nf">as_dict</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Dict representation of the TransformedStructure.</span>
<span class="sd"> """</span>
<span class="n">d</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">final_structure</span><span class="o">.</span><span class="n">as_dict</span><span class="p">()</span>
<span class="n">d</span><span class="p">[</span><span class="s2">"@module"</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__module__</span>
<span class="n">d</span><span class="p">[</span><span class="s2">"@class"</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span>
<span class="n">d</span><span class="p">[</span><span class="s2">"history"</span><span class="p">]</span> <span class="o">=</span> <span class="n">jsanitize</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">history</span><span class="p">)</span>
<span class="n">d</span><span class="p">[</span><span class="s2">"version"</span><span class="p">]</span> <span class="o">=</span> <span class="n">__version__</span>
<span class="n">d</span><span class="p">[</span><span class="s2">"last_modified"</span><span class="p">]</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">utcnow</span><span class="p">())</span>
<span class="n">d</span><span class="p">[</span><span class="s2">"other_parameters"</span><span class="p">]</span> <span class="o">=</span> <span class="n">jsanitize</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">other_parameters</span><span class="p">)</span>
<span class="k">return</span> <span class="n">d</span></div>
<div class="viewcode-block" id="TransformedStructure.from_dict"><a class="viewcode-back" href="../../../pymatgen.alchemy.materials.html#pymatgen.alchemy.materials.TransformedStructure.from_dict">[docs]</a> <span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">from_dict</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">d</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Creates a TransformedStructure from a dict.</span>
<span class="sd"> """</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">Structure</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">d</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">cls</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">history</span><span class="o">=</span><span class="n">d</span><span class="p">[</span><span class="s2">"history"</span><span class="p">],</span>
<span class="n">other_parameters</span><span class="o">=</span><span class="n">d</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"other_parameters"</span><span class="p">,</span> <span class="kc">None</span><span class="p">))</span></div>
<div class="viewcode-block" id="TransformedStructure.to_snl"><a class="viewcode-back" href="../../../pymatgen.alchemy.materials.html#pymatgen.alchemy.materials.TransformedStructure.to_snl">[docs]</a> <span class="k">def</span> <span class="nf">to_snl</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">authors</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Generate SNL from TransformedStructure.</span>
<span class="sd"> :param authors: List of authors</span>
<span class="sd"> :param **kwargs: All kwargs supported by StructureNL.</span>
<span class="sd"> :return: StructureNL</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">other_parameters</span><span class="p">:</span>
<span class="n">warn</span><span class="p">(</span><span class="s1">'Data in TransformedStructure.other_parameters discarded '</span>
<span class="s1">'during type conversion to SNL'</span><span class="p">)</span>
<span class="n">hist</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">h</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">history</span><span class="p">:</span>
<span class="n">snl_metadata</span> <span class="o">=</span> <span class="n">h</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s1">'_snl'</span><span class="p">,</span> <span class="p">{})</span>
<span class="n">hist</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">'name'</span><span class="p">:</span> <span class="n">snl_metadata</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s1">'name'</span><span class="p">,</span> <span class="s1">'pymatgen'</span><span class="p">),</span>
<span class="s1">'url'</span><span class="p">:</span> <span class="n">snl_metadata</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span>
<span class="s1">'url'</span><span class="p">,</span> <span class="s1">'http://pypi.python.org/pypi/pymatgen'</span><span class="p">),</span>
<span class="s1">'description'</span><span class="p">:</span> <span class="n">h</span><span class="p">})</span>
<span class="kn">from</span> <span class="nn">pymatgen.util.provenance</span> <span class="k">import</span> <span class="n">StructureNL</span>
<span class="k">return</span> <span class="n">StructureNL</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">final_structure</span><span class="p">,</span> <span class="n">authors</span><span class="p">,</span> <span class="n">history</span><span class="o">=</span><span class="n">hist</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></div>
<div class="viewcode-block" id="TransformedStructure.from_snl"><a class="viewcode-back" href="../../../pymatgen.alchemy.materials.html#pymatgen.alchemy.materials.TransformedStructure.from_snl">[docs]</a> <span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">from_snl</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">snl</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Create TransformedStructure from SNL.</span>
<span class="sd"> Args:</span>
<span class="sd"> snl (StructureNL): Starting snl</span>
<span class="sd"> Returns:</span>
<span class="sd"> TransformedStructure</span>
<span class="sd"> """</span>
<span class="n">hist</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">h</span> <span class="ow">in</span> <span class="n">snl</span><span class="o">.</span><span class="n">history</span><span class="p">:</span>
<span class="n">d</span> <span class="o">=</span> <span class="n">h</span><span class="o">.</span><span class="n">description</span>
<span class="n">d</span><span class="p">[</span><span class="s1">'_snl'</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'url'</span><span class="p">:</span> <span class="n">h</span><span class="o">.</span><span class="n">url</span><span class="p">,</span> <span class="s1">'name'</span><span class="p">:</span> <span class="n">h</span><span class="o">.</span><span class="n">name</span><span class="p">}</span>
<span class="n">hist</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">d</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">cls</span><span class="p">(</span><span class="n">snl</span><span class="o">.</span><span class="n">structure</span><span class="p">,</span> <span class="n">history</span><span class="o">=</span><span class="n">hist</span><span class="p">)</span></div></div>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">pymatgen 2019.9.16 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> »</li>
<li class="nav-item nav-item-2"><a href="../../pymatgen.html" >pymatgen</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2011, Pymatgen Development Team.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.2.0.
</div>
<div class="footer">This page uses <a href="http://analytics.google.com/">
Google Analytics</a> to collect statistics. You can disable it by blocking
the JavaScript coming from www.google-analytics.com.
<script type="text/javascript">
(function() {
var ga = document.createElement('script');
ga.src = ('https:' == document.location.protocol ?
'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
ga.setAttribute('async', 'true');
document.documentElement.firstChild.appendChild(ga);
})();
</script>
</div>
</body>
</html>