Skip to content

Commit 92df1b3

Browse files
sbillingesbillinge
committed
deploy: 5239628 
1 parent a0af928 commit 92df1b3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+3485
-965
lines changed

‎.buildinfo‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 0f1f7f8b6b259d340fe2583c86da5b30
3+
config: 15a7ba906eadc0ff97e6d50d89c42bf0
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎_images/zscan-plot.png‎

79.6 KB
Loading

‎_modules/diffpy/utils/_deprecator.html‎

Lines changed: 294 additions & 0 deletions
Large diffs are not rendered by default.

‎_modules/diffpy/utils/diffraction_objects.html‎

Lines changed: 45 additions & 40 deletions
Large diffs are not rendered by default.

‎_modules/diffpy/utils/parsers/custom_exceptions.html‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,17 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>diffpy.utils.parsers.custom_exceptions &mdash; diffpy.utils 3.6.1 documentation</title>
8+
<title>diffpy.utils.parsers.custom_exceptions &mdash; diffpy.utils 3.7.0rc0 documentation</title>
99
<link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=03e43079" />
10-
<link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=e59714d7" />
10+
<link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=9edc463e" />
1111
<link rel="stylesheet" type="text/css" href="../../../../_static/copybutton.css?v=76b2166b" />
1212

1313

1414
<script src="../../../../_static/jquery.js?v=5d32c60e"></script>
1515
<script src="../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
16-
<script src="../../../../_static/documentation_options.js?v=43a26aad"></script>
17-
<script src="../../../../_static/doctools.js?v=9bcbadda"></script>
18-
<script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
16+
<script src="../../../../_static/documentation_options.js?v=c07905d3"></script>
17+
<script src="../../../../_static/doctools.js?v=fd6eb6e6"></script>
18+
<script src="../../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
1919
<script src="../../../../_static/clipboard.min.js?v=a7894cd8"></script>
2020
<script src="../../../../_static/copybutton.js?v=cca77546"></script>
2121
<script src="../../../../_static/js/theme.js"></script>
@@ -147,7 +147,7 @@ <h1>Source code for diffpy.utils.parsers.custom_exceptions</h1><div class="highl
147147
<hr/>
148148

149149
<div role="contentinfo">
150-
<p>&#169; Copyright 2025, The Trustees of Columbia University in the City of New York.</p>
150+
<p>&#169; Copyright 2026, The Trustees of Columbia University in the City of New York.</p>
151151
</div>
152152

153153
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

‎_modules/diffpy/utils/parsers/loaddata.html‎

Lines changed: 211 additions & 183 deletions
Large diffs are not rendered by default.

‎_modules/diffpy/utils/parsers/serialization.html‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,17 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>diffpy.utils.parsers.serialization &mdash; diffpy.utils 3.6.1 documentation</title>
8+
<title>diffpy.utils.parsers.serialization &mdash; diffpy.utils 3.7.0rc0 documentation</title>
99
<link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=03e43079" />
10-
<link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=e59714d7" />
10+
<link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=9edc463e" />
1111
<link rel="stylesheet" type="text/css" href="../../../../_static/copybutton.css?v=76b2166b" />
1212

1313

1414
<script src="../../../../_static/jquery.js?v=5d32c60e"></script>
1515
<script src="../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
16-
<script src="../../../../_static/documentation_options.js?v=43a26aad"></script>
17-
<script src="../../../../_static/doctools.js?v=9bcbadda"></script>
18-
<script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
16+
<script src="../../../../_static/documentation_options.js?v=c07905d3"></script>
17+
<script src="../../../../_static/doctools.js?v=fd6eb6e6"></script>
18+
<script src="../../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
1919
<script src="../../../../_static/clipboard.min.js?v=a7894cd8"></script>
2020
<script src="../../../../_static/copybutton.js?v=cca77546"></script>
2121
<script src="../../../../_static/js/theme.js"></script>
@@ -112,10 +112,11 @@ <h1>Source code for diffpy.utils.parsers.serialization</h1><div class="highlight
112112
<span class="n">show_path</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
113113
<span class="n">serial_file</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
114114
<span class="p">):</span>
115-
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Serialize file data into a dictionary. Can also save dictionary into a</span>
116-
<span class="sd"> serial language file. Dictionary is formatted as {filename: data}.</span>
115+
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Serialize file data into a dictionary. Can also save dictionary</span>
116+
<span class="sd"> into a serial language file. Dictionary is formatted as {filename:</span>
117+
<span class="sd"> data}.</span>
117118

118-
<span class="sd"> Requires hdata and data_table (can be generated by loadData).</span>
119+
<span class="sd"> Requires hdata and data_table (can be generated by load_data).</span>
119120

120121
<span class="sd"> Parameters</span>
121122
<span class="sd"> ----------</span>
@@ -309,7 +310,7 @@ <h1>Source code for diffpy.utils.parsers.serialization</h1><div class="highlight
309310
<hr/>
310311

311312
<div role="contentinfo">
312-
<p>&#169; Copyright 2025, The Trustees of Columbia University in the City of New York.</p>
313+
<p>&#169; Copyright 2026, The Trustees of Columbia University in the City of New York.</p>
313314
</div>
314315

315316
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

‎_modules/diffpy/utils/resampler.html‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,17 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>diffpy.utils.resampler &mdash; diffpy.utils 3.6.1 documentation</title>
8+
<title>diffpy.utils.resampler &mdash; diffpy.utils 3.7.0rc0 documentation</title>
99
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=03e43079" />
10-
<link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=e59714d7" />
10+
<link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=9edc463e" />
1111
<link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css?v=76b2166b" />
1212

1313

1414
<script src="../../../_static/jquery.js?v=5d32c60e"></script>
1515
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
16-
<script src="../../../_static/documentation_options.js?v=43a26aad"></script>
17-
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
18-
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
16+
<script src="../../../_static/documentation_options.js?v=c07905d3"></script>
17+
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
18+
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
1919
<script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>
2020
<script src="../../../_static/copybutton.js?v=cca77546"></script>
2121
<script src="../../../_static/js/theme.js"></script>
@@ -109,23 +109,23 @@ <h1>Source code for diffpy.utils.resampler</h1><div class="highlight"><pre>
109109

110110
<span class="sd"> Parameters</span>
111111
<span class="sd"> ----------</span>
112-
<span class="sd"> x: ndarray</span>
112+
<span class="sd"> x: ``ndarray``</span>
113113
<span class="sd"> The x values at which interpolation is computed.</span>
114-
<span class="sd"> xp: ndarray</span>
114+
<span class="sd"> xp: ``ndarray``</span>
115115
<span class="sd"> The array of known x values.</span>
116-
<span class="sd"> fp: ndarray</span>
116+
<span class="sd"> fp: ``ndarray``</span>
117117
<span class="sd"> The array of y values associated with xp.</span>
118118
<span class="sd"> left: float</span>
119119
<span class="sd"> If given, set fp for x &lt; xp[0] to left. Otherwise, if left is None</span>
120-
<span class="sd"> (default) or not given, set fp for x &lt; xp[0] to fp evaluated at xp[-1].</span>
120+
<span class="sd"> (default) or not given, set fp for x &lt; xp[0] to fp evaluated at xp[0].</span>
121121
<span class="sd"> right: float</span>
122122
<span class="sd"> If given, set fp for x &gt; xp[-1] to right. Otherwise, if right is None</span>
123123
<span class="sd"> (default) or not given, set fp for x &gt; xp[-1] to fp evaluated at</span>
124124
<span class="sd"> xp[-1].</span>
125125

126126
<span class="sd"> Returns</span>
127127
<span class="sd"> -------</span>
128-
<span class="sd"> ndarray or float</span>
128+
<span class="sd"> ``ndarray`` or float</span>
129129
<span class="sd"> The interpolated values at points x. Returns a single float if x is a</span>
130130
<span class="sd"> scalar, otherwise returns a numpy.ndarray.</span>
131131
<span class="sd"> &quot;&quot;&quot;</span>
@@ -162,8 +162,8 @@ <h1>Source code for diffpy.utils.resampler</h1><div class="highlight"><pre>
162162
<div class="viewcode-block" id="nsinterp">
163163
<a class="viewcode-back" href="../../../api/diffpy.utils.html#diffpy.utils.resampler.nsinterp">[docs]</a>
164164
<span class="k">def</span><span class="w"> </span><span class="nf">nsinterp</span><span class="p">(</span><span class="n">xp</span><span class="p">,</span> <span class="n">fp</span><span class="p">,</span> <span class="n">qmin</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">qmax</span><span class="o">=</span><span class="mi">25</span><span class="p">,</span> <span class="n">left</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">right</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
165-
<span class="w"> </span><span class="sd">&quot;&quot;&quot;One-dimensional Whittaker-Shannon interpolation onto the Nyquist-Shannon</span>
166-
<span class="sd"> grid.</span>
165+
<span class="w"> </span><span class="sd">&quot;&quot;&quot;One-dimensional Whittaker-Shannon interpolation onto the Nyquist-</span>
166+
<span class="sd"> Shannon grid.</span>
167167

168168
<span class="sd"> Takes a band-limited function fp and original grid xp and resamples fp on</span>
169169
<span class="sd"> the NS grid. Uses the minimum number of points N required by the Nyquist</span>
@@ -173,9 +173,9 @@ <h1>Source code for diffpy.utils.resampler</h1><div class="highlight"><pre>
173173

174174
<span class="sd"> Parameters</span>
175175
<span class="sd"> ----------</span>
176-
<span class="sd"> xp: ndarray</span>
176+
<span class="sd"> xp: ``ndarray``</span>
177177
<span class="sd"> The array of known x values.</span>
178-
<span class="sd"> fp: ndarray</span>
178+
<span class="sd"> fp: ``ndarray``</span>
179179
<span class="sd"> The array of y values associated with xp.</span>
180180
<span class="sd"> qmin: float</span>
181181
<span class="sd"> The lower band limit in the frequency domain.</span>
@@ -184,7 +184,7 @@ <h1>Source code for diffpy.utils.resampler</h1><div class="highlight"><pre>
184184

185185
<span class="sd"> Returns</span>
186186
<span class="sd"> -------</span>
187-
<span class="sd"> x: ndarray</span>
187+
<span class="sd"> x: ``ndarray``</span>
188188
<span class="sd"> The Nyquist-Shannon grid computed for the given qmin and qmax.</span>
189189
<span class="sd"> fp_at_x: ndarray</span>
190190
<span class="sd"> The interpolated values at points x. Returns a single float if x is a</span>
@@ -224,7 +224,7 @@ <h1>Source code for diffpy.utils.resampler</h1><div class="highlight"><pre>
224224

225225
<span class="sd"> Returns</span>
226226
<span class="sd"> -------</span>
227-
<span class="sd"> Returns resampled (r, s).</span>
227+
<span class="sd"> Returns resampled ``(r, s)``.</span>
228228
<span class="sd"> &quot;&quot;&quot;</span>
229229

230230
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span>
@@ -281,7 +281,7 @@ <h1>Source code for diffpy.utils.resampler</h1><div class="highlight"><pre>
281281
<hr/>
282282

283283
<div role="contentinfo">
284-
<p>&#169; Copyright 2025, The Trustees of Columbia University in the City of New York.</p>
284+
<p>&#169; Copyright 2026, The Trustees of Columbia University in the City of New York.</p>
285285
</div>
286286

287287
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

0 commit comments

Comments
 (0)