-
Notifications
You must be signed in to change notification settings - Fork 835
/
pymatgen.util.html
355 lines (332 loc) · 39.2 KB
/
pymatgen.util.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
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>pymatgen.util package — pymatgen 2023.5.10 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
<link rel="canonical" href="https://pymatgen.orgpymatgen.util.html"/>
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="pymatgen.util.convergence module" href="pymatgen.util.convergence.html" />
<link rel="prev" title="pymatgen.transformations.transformation_abc module" href="pymatgen.transformations.transformation_abc.html" />
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.1/jquery.min.js"></script>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-33990148-1']);
_gaq.push(['_trackPageview']);
</script>
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" style="background: linear-gradient(0deg, rgba(23,63,162,1) 0%, rgba(0,70,192,1) 100%)" >
<a href="index.html">
</a>
<div class="version">
2023.5.10
</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">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="change_log.html">Change log</a></li>
<li class="toctree-l1"><a class="reference internal" href="compatibility.html">Compatibility</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="team.html">Development Team</a></li>
<li class="toctree-l1"><a class="reference internal" href="references.html">References</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">API Docs</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="pymatgen.html">pymatgen namespace</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="pymatgen.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l4"><a class="reference internal" href="pymatgen.alchemy.html">pymatgen.alchemy package</a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.analysis.html">pymatgen.analysis namespace</a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.apps.html">pymatgen.apps package</a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.cli.html">pymatgen.cli package</a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.command_line.html">pymatgen.command_line package</a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.core.html">pymatgen.core package</a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.electronic_structure.html">pymatgen.electronic_structure package</a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.entries.html">pymatgen.entries package</a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.ext.html">pymatgen.ext namespace</a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.io.html">pymatgen.io namespace</a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.optimization.html">pymatgen.optimization package</a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.phonon.html">pymatgen.phonon package</a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.symmetry.html">pymatgen.symmetry package</a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.transformations.html">pymatgen.transformations package</a></li>
<li class="toctree-l4 current"><a class="current reference internal" href="#">pymatgen.util package</a></li>
<li class="toctree-l4"><a class="reference internal" href="pymatgen.vis.html">pymatgen.vis package</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.html#submodules">Submodules</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="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"><a href="modules.html">pymatgen</a></li>
<li class="breadcrumb-item"><a href="pymatgen.html">pymatgen namespace</a></li>
<li class="breadcrumb-item active">pymatgen.util package</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/materialsproject/pymatgen/blob/master/docs_rst/pymatgen.util.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="pymatgen-util-package">
<h1>pymatgen.util package<a class="headerlink" href="#pymatgen-util-package" title="Permalink to this heading"></a></h1>
<section id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this heading"></a></h2>
<div class="toctree-wrapper compound">
</div>
</section>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="pymatgen.util.convergence.html">pymatgen.util.convergence module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.convergence.html#pymatgen.util.convergence.SplineInputError"><code class="docutils literal notranslate"><span class="pre">SplineInputError</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.convergence.html#pymatgen.util.convergence.determine_convergence"><code class="docutils literal notranslate"><span class="pre">determine_convergence()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.convergence.html#pymatgen.util.convergence.exponential"><code class="docutils literal notranslate"><span class="pre">exponential()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.convergence.html#pymatgen.util.convergence.extrapolate_reciprocal"><code class="docutils literal notranslate"><span class="pre">extrapolate_reciprocal()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.convergence.html#pymatgen.util.convergence.extrapolate_simple_reciprocal"><code class="docutils literal notranslate"><span class="pre">extrapolate_simple_reciprocal()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.convergence.html#pymatgen.util.convergence.get_derivatives"><code class="docutils literal notranslate"><span class="pre">get_derivatives()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.convergence.html#pymatgen.util.convergence.get_weights"><code class="docutils literal notranslate"><span class="pre">get_weights()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.convergence.html#pymatgen.util.convergence.id_generator"><code class="docutils literal notranslate"><span class="pre">id_generator()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.convergence.html#pymatgen.util.convergence.measure"><code class="docutils literal notranslate"><span class="pre">measure()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.convergence.html#pymatgen.util.convergence.multi_curve_fit"><code class="docutils literal notranslate"><span class="pre">multi_curve_fit()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.convergence.html#pymatgen.util.convergence.multi_reciprocal_extra"><code class="docutils literal notranslate"><span class="pre">multi_reciprocal_extra()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.convergence.html#pymatgen.util.convergence.p0_exponential"><code class="docutils literal notranslate"><span class="pre">p0_exponential()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.convergence.html#pymatgen.util.convergence.p0_reciprocal"><code class="docutils literal notranslate"><span class="pre">p0_reciprocal()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.convergence.html#pymatgen.util.convergence.p0_simple_2reciprocal"><code class="docutils literal notranslate"><span class="pre">p0_simple_2reciprocal()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.convergence.html#pymatgen.util.convergence.p0_simple_4reciprocal"><code class="docutils literal notranslate"><span class="pre">p0_simple_4reciprocal()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.convergence.html#pymatgen.util.convergence.p0_simple_5reciprocal"><code class="docutils literal notranslate"><span class="pre">p0_simple_5reciprocal()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.convergence.html#pymatgen.util.convergence.p0_simple_reciprocal"><code class="docutils literal notranslate"><span class="pre">p0_simple_reciprocal()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.convergence.html#pymatgen.util.convergence.p0_single_reciprocal"><code class="docutils literal notranslate"><span class="pre">p0_single_reciprocal()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.convergence.html#pymatgen.util.convergence.print_and_raise_error"><code class="docutils literal notranslate"><span class="pre">print_and_raise_error()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.convergence.html#pymatgen.util.convergence.print_plot_line"><code class="docutils literal notranslate"><span class="pre">print_plot_line()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.convergence.html#pymatgen.util.convergence.reciprocal"><code class="docutils literal notranslate"><span class="pre">reciprocal()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.convergence.html#pymatgen.util.convergence.simple_2reciprocal"><code class="docutils literal notranslate"><span class="pre">simple_2reciprocal()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.convergence.html#pymatgen.util.convergence.simple_4reciprocal"><code class="docutils literal notranslate"><span class="pre">simple_4reciprocal()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.convergence.html#pymatgen.util.convergence.simple_5reciprocal"><code class="docutils literal notranslate"><span class="pre">simple_5reciprocal()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.convergence.html#pymatgen.util.convergence.simple_reciprocal"><code class="docutils literal notranslate"><span class="pre">simple_reciprocal()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.convergence.html#pymatgen.util.convergence.single_reciprocal"><code class="docutils literal notranslate"><span class="pre">single_reciprocal()</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pymatgen.util.coord.html">pymatgen.util.coord module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.coord.html#pymatgen.util.coord.Simplex"><code class="docutils literal notranslate"><span class="pre">Simplex</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.util.coord.html#pymatgen.util.coord.Simplex.bary_coords"><code class="docutils literal notranslate"><span class="pre">Simplex.bary_coords()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.util.coord.html#pymatgen.util.coord.Simplex.coords"><code class="docutils literal notranslate"><span class="pre">Simplex.coords</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.util.coord.html#pymatgen.util.coord.Simplex.in_simplex"><code class="docutils literal notranslate"><span class="pre">Simplex.in_simplex()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.util.coord.html#pymatgen.util.coord.Simplex.line_intersection"><code class="docutils literal notranslate"><span class="pre">Simplex.line_intersection()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.util.coord.html#pymatgen.util.coord.Simplex.point_from_bary_coords"><code class="docutils literal notranslate"><span class="pre">Simplex.point_from_bary_coords()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.util.coord.html#pymatgen.util.coord.Simplex.volume"><code class="docutils literal notranslate"><span class="pre">Simplex.volume</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.coord.html#pymatgen.util.coord.all_distances"><code class="docutils literal notranslate"><span class="pre">all_distances()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.coord.html#pymatgen.util.coord.barycentric_coords"><code class="docutils literal notranslate"><span class="pre">barycentric_coords()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.coord.html#pymatgen.util.coord.coord_list_mapping"><code class="docutils literal notranslate"><span class="pre">coord_list_mapping()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.coord.html#pymatgen.util.coord.coord_list_mapping_pbc"><code class="docutils literal notranslate"><span class="pre">coord_list_mapping_pbc()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.coord.html#pymatgen.util.coord.find_in_coord_list"><code class="docutils literal notranslate"><span class="pre">find_in_coord_list()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.coord.html#pymatgen.util.coord.find_in_coord_list_pbc"><code class="docutils literal notranslate"><span class="pre">find_in_coord_list_pbc()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.coord.html#pymatgen.util.coord.get_angle"><code class="docutils literal notranslate"><span class="pre">get_angle()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.coord.html#pymatgen.util.coord.get_linear_interpolated_value"><code class="docutils literal notranslate"><span class="pre">get_linear_interpolated_value()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.coord.html#pymatgen.util.coord.in_coord_list"><code class="docutils literal notranslate"><span class="pre">in_coord_list()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.coord.html#pymatgen.util.coord.in_coord_list_pbc"><code class="docutils literal notranslate"><span class="pre">in_coord_list_pbc()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.coord.html#pymatgen.util.coord.is_coord_subset"><code class="docutils literal notranslate"><span class="pre">is_coord_subset()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.coord.html#pymatgen.util.coord.is_coord_subset_pbc"><code class="docutils literal notranslate"><span class="pre">is_coord_subset_pbc()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.coord.html#pymatgen.util.coord.lattice_points_in_supercell"><code class="docutils literal notranslate"><span class="pre">lattice_points_in_supercell()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.coord.html#pymatgen.util.coord.pbc_diff"><code class="docutils literal notranslate"><span class="pre">pbc_diff()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.coord.html#pymatgen.util.coord.pbc_shortest_vectors"><code class="docutils literal notranslate"><span class="pre">pbc_shortest_vectors()</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pymatgen.util.coord_cython.html">pymatgen.util.coord_cython module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.coord_cython.html#pymatgen.util.coord_cython.coord_list_mapping_pbc"><code class="docutils literal notranslate"><span class="pre">coord_list_mapping_pbc()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.coord_cython.html#pymatgen.util.coord_cython.is_coord_subset_pbc"><code class="docutils literal notranslate"><span class="pre">is_coord_subset_pbc()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.coord_cython.html#pymatgen.util.coord_cython.pbc_shortest_vectors"><code class="docutils literal notranslate"><span class="pre">pbc_shortest_vectors()</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pymatgen.util.graph_hashing.html">pymatgen.util.graph_hashing module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.graph_hashing.html#pymatgen.util.graph_hashing.weisfeiler_lehman_graph_hash"><code class="docutils literal notranslate"><span class="pre">weisfeiler_lehman_graph_hash()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.graph_hashing.html#pymatgen.util.graph_hashing.weisfeiler_lehman_subgraph_hashes"><code class="docutils literal notranslate"><span class="pre">weisfeiler_lehman_subgraph_hashes()</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pymatgen.util.io_utils.html">pymatgen.util.io_utils module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.io_utils.html#pymatgen.util.io_utils.clean_lines"><code class="docutils literal notranslate"><span class="pre">clean_lines()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.io_utils.html#pymatgen.util.io_utils.micro_pyawk"><code class="docutils literal notranslate"><span class="pre">micro_pyawk()</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pymatgen.util.num.html">pymatgen.util.num module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.num.html#pymatgen.util.num.abs_cap"><code class="docutils literal notranslate"><span class="pre">abs_cap()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.num.html#pymatgen.util.num.make_symmetric_matrix_from_upper_tri"><code class="docutils literal notranslate"><span class="pre">make_symmetric_matrix_from_upper_tri()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.num.html#pymatgen.util.num.maxloc"><code class="docutils literal notranslate"><span class="pre">maxloc()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.num.html#pymatgen.util.num.min_max_indexes"><code class="docutils literal notranslate"><span class="pre">min_max_indexes()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.num.html#pymatgen.util.num.minloc"><code class="docutils literal notranslate"><span class="pre">minloc()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.num.html#pymatgen.util.num.monotonic"><code class="docutils literal notranslate"><span class="pre">monotonic()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.num.html#pymatgen.util.num.non_decreasing"><code class="docutils literal notranslate"><span class="pre">non_decreasing()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.num.html#pymatgen.util.num.non_increasing"><code class="docutils literal notranslate"><span class="pre">non_increasing()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.num.html#pymatgen.util.num.round_to_sigfigs"><code class="docutils literal notranslate"><span class="pre">round_to_sigfigs()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.num.html#pymatgen.util.num.strictly_decreasing"><code class="docutils literal notranslate"><span class="pre">strictly_decreasing()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.num.html#pymatgen.util.num.strictly_increasing"><code class="docutils literal notranslate"><span class="pre">strictly_increasing()</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pymatgen.util.numba.html">pymatgen.util.numba module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.numba.html#pymatgen.util.numba.jit"><code class="docutils literal notranslate"><span class="pre">jit()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.numba.html#pymatgen.util.numba.njit"><code class="docutils literal notranslate"><span class="pre">njit()</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pymatgen.util.plotting.html">pymatgen.util.plotting module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.plotting.html#pymatgen.util.plotting.add_fig_kwargs"><code class="docutils literal notranslate"><span class="pre">add_fig_kwargs()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.plotting.html#pymatgen.util.plotting.format_formula"><code class="docutils literal notranslate"><span class="pre">format_formula()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.plotting.html#pymatgen.util.plotting.get_ax3d_fig_plt"><code class="docutils literal notranslate"><span class="pre">get_ax3d_fig_plt()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.plotting.html#pymatgen.util.plotting.get_ax_fig_plt"><code class="docutils literal notranslate"><span class="pre">get_ax_fig_plt()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.plotting.html#pymatgen.util.plotting.get_axarray_fig_plt"><code class="docutils literal notranslate"><span class="pre">get_axarray_fig_plt()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.plotting.html#pymatgen.util.plotting.periodic_table_heatmap"><code class="docutils literal notranslate"><span class="pre">periodic_table_heatmap()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.plotting.html#pymatgen.util.plotting.pretty_plot"><code class="docutils literal notranslate"><span class="pre">pretty_plot()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.plotting.html#pymatgen.util.plotting.pretty_plot_two_axis"><code class="docutils literal notranslate"><span class="pre">pretty_plot_two_axis()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.plotting.html#pymatgen.util.plotting.pretty_polyfit_plot"><code class="docutils literal notranslate"><span class="pre">pretty_polyfit_plot()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.plotting.html#pymatgen.util.plotting.van_arkel_triangle"><code class="docutils literal notranslate"><span class="pre">van_arkel_triangle()</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pymatgen.util.provenance.html">pymatgen.util.provenance module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.provenance.html#pymatgen.util.provenance.Author"><code class="docutils literal notranslate"><span class="pre">Author</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.util.provenance.html#pymatgen.util.provenance.Author.name"><code class="docutils literal notranslate"><span class="pre">Author.name</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.util.provenance.html#pymatgen.util.provenance.Author.email"><code class="docutils literal notranslate"><span class="pre">Author.email</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.util.provenance.html#pymatgen.util.provenance.Author.as_dict"><code class="docutils literal notranslate"><span class="pre">Author.as_dict()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.util.provenance.html#pymatgen.util.provenance.Author.from_dict"><code class="docutils literal notranslate"><span class="pre">Author.from_dict()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.util.provenance.html#pymatgen.util.provenance.Author.parse_author"><code class="docutils literal notranslate"><span class="pre">Author.parse_author()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.provenance.html#pymatgen.util.provenance.HistoryNode"><code class="docutils literal notranslate"><span class="pre">HistoryNode</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.util.provenance.html#pymatgen.util.provenance.HistoryNode.name"><code class="docutils literal notranslate"><span class="pre">HistoryNode.name</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.util.provenance.html#pymatgen.util.provenance.HistoryNode.url"><code class="docutils literal notranslate"><span class="pre">HistoryNode.url</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.util.provenance.html#pymatgen.util.provenance.HistoryNode.description"><code class="docutils literal notranslate"><span class="pre">HistoryNode.description</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.util.provenance.html#pymatgen.util.provenance.HistoryNode.as_dict"><code class="docutils literal notranslate"><span class="pre">HistoryNode.as_dict()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.util.provenance.html#pymatgen.util.provenance.HistoryNode.from_dict"><code class="docutils literal notranslate"><span class="pre">HistoryNode.from_dict()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.util.provenance.html#pymatgen.util.provenance.HistoryNode.parse_history_node"><code class="docutils literal notranslate"><span class="pre">HistoryNode.parse_history_node()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.provenance.html#pymatgen.util.provenance.StructureNL"><code class="docutils literal notranslate"><span class="pre">StructureNL</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.util.provenance.html#pymatgen.util.provenance.StructureNL.as_dict"><code class="docutils literal notranslate"><span class="pre">StructureNL.as_dict()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.util.provenance.html#pymatgen.util.provenance.StructureNL.from_dict"><code class="docutils literal notranslate"><span class="pre">StructureNL.from_dict()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.util.provenance.html#pymatgen.util.provenance.StructureNL.from_structures"><code class="docutils literal notranslate"><span class="pre">StructureNL.from_structures()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.provenance.html#pymatgen.util.provenance.is_valid_bibtex"><code class="docutils literal notranslate"><span class="pre">is_valid_bibtex()</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pymatgen.util.string.html">pymatgen.util.string module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.string.html#pymatgen.util.string.Stringify"><code class="docutils literal notranslate"><span class="pre">Stringify</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.util.string.html#pymatgen.util.string.Stringify.STRING_MODE"><code class="docutils literal notranslate"><span class="pre">Stringify.STRING_MODE</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.util.string.html#pymatgen.util.string.Stringify.to_html_string"><code class="docutils literal notranslate"><span class="pre">Stringify.to_html_string()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.util.string.html#pymatgen.util.string.Stringify.to_latex_string"><code class="docutils literal notranslate"><span class="pre">Stringify.to_latex_string()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.util.string.html#pymatgen.util.string.Stringify.to_pretty_string"><code class="docutils literal notranslate"><span class="pre">Stringify.to_pretty_string()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.util.string.html#pymatgen.util.string.Stringify.to_unicode_string"><code class="docutils literal notranslate"><span class="pre">Stringify.to_unicode_string()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.string.html#pymatgen.util.string.charge_string"><code class="docutils literal notranslate"><span class="pre">charge_string()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.string.html#pymatgen.util.string.disordered_formula"><code class="docutils literal notranslate"><span class="pre">disordered_formula()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.string.html#pymatgen.util.string.formula_double_format"><code class="docutils literal notranslate"><span class="pre">formula_double_format()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.string.html#pymatgen.util.string.htmlify"><code class="docutils literal notranslate"><span class="pre">htmlify()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.string.html#pymatgen.util.string.latexify"><code class="docutils literal notranslate"><span class="pre">latexify()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.string.html#pymatgen.util.string.latexify_spacegroup"><code class="docutils literal notranslate"><span class="pre">latexify_spacegroup()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.string.html#pymatgen.util.string.str_delimited"><code class="docutils literal notranslate"><span class="pre">str_delimited()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.string.html#pymatgen.util.string.stream_has_colours"><code class="docutils literal notranslate"><span class="pre">stream_has_colours()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.string.html#pymatgen.util.string.transformation_to_string"><code class="docutils literal notranslate"><span class="pre">transformation_to_string()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.string.html#pymatgen.util.string.unicodeify"><code class="docutils literal notranslate"><span class="pre">unicodeify()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.string.html#pymatgen.util.string.unicodeify_spacegroup"><code class="docutils literal notranslate"><span class="pre">unicodeify_spacegroup()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.string.html#pymatgen.util.string.unicodeify_species"><code class="docutils literal notranslate"><span class="pre">unicodeify_species()</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pymatgen.util.testing.html">pymatgen.util.testing module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pymatgen.util.testing.html#pymatgen.util.testing.PymatgenTest"><code class="docutils literal notranslate"><span class="pre">PymatgenTest</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.util.testing.html#pymatgen.util.testing.PymatgenTest.MODULE_DIR"><code class="docutils literal notranslate"><span class="pre">PymatgenTest.MODULE_DIR</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.util.testing.html#pymatgen.util.testing.PymatgenTest.STRUCTURES_DIR"><code class="docutils literal notranslate"><span class="pre">PymatgenTest.STRUCTURES_DIR</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.util.testing.html#pymatgen.util.testing.PymatgenTest.TEST_FILES_DIR"><code class="docutils literal notranslate"><span class="pre">PymatgenTest.TEST_FILES_DIR</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.util.testing.html#pymatgen.util.testing.PymatgenTest.TEST_STRUCTURES"><code class="docutils literal notranslate"><span class="pre">PymatgenTest.TEST_STRUCTURES</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.util.testing.html#pymatgen.util.testing.PymatgenTest.assert_all_close"><code class="docutils literal notranslate"><span class="pre">PymatgenTest.assert_all_close()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.util.testing.html#pymatgen.util.testing.PymatgenTest.assert_msonable"><code class="docutils literal notranslate"><span class="pre">PymatgenTest.assert_msonable()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.util.testing.html#pymatgen.util.testing.PymatgenTest.assert_str_content_equal"><code class="docutils literal notranslate"><span class="pre">PymatgenTest.assert_str_content_equal()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.util.testing.html#pymatgen.util.testing.PymatgenTest.fn"><code class="docutils literal notranslate"><span class="pre">PymatgenTest.fn</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.util.testing.html#pymatgen.util.testing.PymatgenTest.get_structure"><code class="docutils literal notranslate"><span class="pre">PymatgenTest.get_structure()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.util.testing.html#pymatgen.util.testing.PymatgenTest.serialize_with_pickle"><code class="docutils literal notranslate"><span class="pre">PymatgenTest.serialize_with_pickle()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pymatgen.util.testing.html#pymatgen.util.testing.PymatgenTest.warnings"><code class="docutils literal notranslate"><span class="pre">PymatgenTest.warnings</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pymatgen.util.typing.html">pymatgen.util.typing module</a></li>
</ul>
</div>
</section>
<section id="module-pymatgen.util">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pymatgen.util" title="Permalink to this heading"></a></h2>
<p>The util package implements various utilities that are commonly used by various
packages.</p>
</section>
</section>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>© Copyright 2011, Pymatgen Development Team.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
<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>