forked from materialsproject/pymatgen
-
Notifications
You must be signed in to change notification settings - Fork 0
/
pymatgen.io.abinit.db.html
180 lines (163 loc) · 13.9 KB
/
pymatgen.io.abinit.db.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
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>pymatgen.io.abinit.db module — pymatgen 2019.5.1 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="shortcut icon" href="_static/favicon.ico"/>
<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.5.1 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-pymatgen.io.abinit.db">
<span id="pymatgen-io-abinit-db-module"></span><h1>pymatgen.io.abinit.db module<a class="headerlink" href="#module-pymatgen.io.abinit.db" title="Permalink to this headline">¶</a></h1>
<p>Objects and helper function used to store the results in a MongoDb database</p>
<dl class="class">
<dt id="pymatgen.io.abinit.db.DBConnector">
<em class="property">class </em><code class="descname">DBConnector</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/io/abinit/db.html#DBConnector"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.io.abinit.db.DBConnector" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<dl class="classmethod">
<dt id="pymatgen.io.abinit.db.DBConnector.autodoc">
<em class="property">classmethod </em><code class="descname">autodoc</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/io/abinit/db.html#DBConnector.autodoc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.io.abinit.db.DBConnector.autodoc" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pymatgen.io.abinit.db.DBConnector.deepcopy">
<code class="descname">deepcopy</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/io/abinit/db.html#DBConnector.deepcopy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.io.abinit.db.DBConnector.deepcopy" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pymatgen.io.abinit.db.DBConnector.get_collection">
<code class="descname">get_collection</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/io/abinit/db.html#DBConnector.get_collection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.io.abinit.db.DBConnector.get_collection" title="Permalink to this definition">¶</a></dt>
<dd><p>Establish a connection with the database.</p>
<p>Returns MongoDb collection</p>
</dd></dl>
<dl class="method">
<dt id="pymatgen.io.abinit.db.DBConnector.set_collection_name">
<code class="descname">set_collection_name</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/io/abinit/db.html#DBConnector.set_collection_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.io.abinit.db.DBConnector.set_collection_name" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the name of the collection, return old value</p>
</dd></dl>
</dd></dl>
<dl class="function">
<dt id="pymatgen.io.abinit.db.mongo_getattr">
<code class="descname">mongo_getattr</code><span class="sig-paren">(</span><em>rec</em>, <em>key</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/io/abinit/db.html#mongo_getattr"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.io.abinit.db.mongo_getattr" title="Permalink to this definition">¶</a></dt>
<dd><p>Get value from dict using MongoDB dot-separated path semantics.
For example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">assert</span> <span class="n">mongo_getattr</span><span class="p">({</span><span class="s1">'a'</span><span class="p">:</span> <span class="p">{</span><span class="s1">'b'</span><span class="p">:</span> <span class="mi">1</span><span class="p">},</span> <span class="s1">'x'</span><span class="p">:</span> <span class="mi">2</span><span class="p">},</span> <span class="s1">'a.b'</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span>
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">mongo_getattr</span><span class="p">({</span><span class="s1">'a'</span><span class="p">:</span> <span class="p">{</span><span class="s1">'b'</span><span class="p">:</span> <span class="mi">1</span><span class="p">},</span> <span class="s1">'x'</span><span class="p">:</span> <span class="mi">2</span><span class="p">},</span> <span class="s1">'x'</span><span class="p">)</span> <span class="o">==</span> <span class="mi">2</span>
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">mongo_getattr</span><span class="p">({</span><span class="s1">'a'</span><span class="p">:</span> <span class="p">{</span><span class="s1">'b'</span><span class="p">:</span> <span class="mi">1</span><span class="p">},</span> <span class="s1">'x'</span><span class="p">:</span> <span class="mi">2</span><span class="p">},</span> <span class="s1">'a.b.c'</span><span class="p">)</span> <span class="ow">is</span> <span class="kc">None</span>
</pre></div>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>rec</strong> – mongodb document</p></li>
<li><p><strong>key</strong> – path to mongo value</p></li>
<li><p><strong>default</strong> – default to return if not found</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>value, potentially nested, or default if not found</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p>AttributeError, if record is not a dict or key is not found.</p>
</dd>
</dl>
</dd></dl>
<dl class="function">
<dt id="pymatgen.io.abinit.db.scan_nestdict">
<code class="descname">scan_nestdict</code><span class="sig-paren">(</span><em>d</em>, <em>key</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/io/abinit/db.html#scan_nestdict"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.io.abinit.db.scan_nestdict" title="Permalink to this definition">¶</a></dt>
<dd><p>Scan a nested dict d, and return the first value associated to the given key.
Returns None if key is not found.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">d</span> <span class="o">=</span> <span class="p">{</span><span class="mi">0</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">:</span> <span class="p">{</span><span class="s2">"hello"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"world"</span><span class="p">:</span> <span class="p">{</span><span class="kc">None</span><span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">]}}},</span> <span class="s2">"foo"</span><span class="p">:</span> <span class="p">[{</span><span class="s2">"bar"</span><span class="p">:</span> <span class="mi">1</span><span class="p">},</span> <span class="p">{</span><span class="s2">"color"</span><span class="p">:</span> <span class="s2">"red"</span><span class="p">}]}</span>
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">scan_nestdict</span><span class="p">(</span><span class="n">d</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span> <span class="o">==</span> <span class="p">{</span><span class="s2">"hello"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"world"</span><span class="p">:</span> <span class="p">{</span><span class="kc">None</span><span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">]}}}</span>
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">scan_nestdict</span><span class="p">(</span><span class="n">d</span><span class="p">,</span> <span class="s2">"hello"</span><span class="p">)</span> <span class="o">==</span> <span class="p">{</span><span class="s2">"world"</span><span class="p">:</span> <span class="p">{</span><span class="kc">None</span><span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">]}}</span>
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">scan_nestdict</span><span class="p">(</span><span class="n">d</span><span class="p">,</span> <span class="s2">"world"</span><span class="p">)</span> <span class="o">==</span> <span class="p">{</span><span class="kc">None</span><span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">]}</span>
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">scan_nestdict</span><span class="p">(</span><span class="n">d</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> <span class="o">==</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">]</span>
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">scan_nestdict</span><span class="p">(</span><span class="n">d</span><span class="p">,</span> <span class="s2">"color"</span><span class="p">)</span> <span class="o">==</span> <span class="s2">"red"</span>
</pre></div>
</div>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/pymatgen.io.abinit.db.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<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.5.1 documentation</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.0.1.
</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>