Skip to content

Commit e2bf6a8

Browse files
RealPolitiXRealPolitiX
committed
Rebuilt docs
1 parent 3c32d75 commit e2bf6a8

15 files changed

Lines changed: 87 additions & 52 deletions

‎docs/doctrees/environment.pickle‎

-100 Bytes
Binary file not shown.

‎docs/doctrees/fitter.doctree‎

3.43 KB
Binary file not shown.

‎docs/html/.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 hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: f21870fb2c373ea5a8868789c98b8678
3+
config: 0a428c04a816b70a9878b4edab353e61
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/html/I01_start.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1010

11-
<title>How to start &mdash; pesfit 0.5.0 documentation</title>
11+
<title>How to start &mdash; pesfit 0.5.2 documentation</title>
1212

1313

1414

@@ -35,7 +35,7 @@
3535
<link rel="index" title="Index"
3636
href="genindex.html"/>
3737
<link rel="search" title="Search" href="search.html"/>
38-
<link rel="top" title="pesfit 0.5.0 documentation" href="index.html"/>
38+
<link rel="top" title="pesfit 0.5.2 documentation" href="index.html"/>
3939
<link rel="next" title="Complex lineshape models (pesfit.lineshape)" href="lineshape.html"/>
4040
<link rel="prev" title="pesfit documentation" href="index.html"/>
4141

@@ -66,7 +66,7 @@
6666

6767

6868
<div class="version">
69-
0.5.0
69+
0.5.2
7070
</div>
7171

7272

@@ -225,7 +225,7 @@ <h2>Installation<a class="headerlink" href="#installation" title="Permalink to t
225225
<script type="text/javascript">
226226
var DOCUMENTATION_OPTIONS = {
227227
URL_ROOT:'./',
228-
VERSION:'0.5.0',
228+
VERSION:'0.5.2',
229229
COLLAPSE_INDEX:false,
230230
FILE_SUFFIX:'.html',
231231
HAS_SOURCE: true,

‎docs/html/_static/documentation_options.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
var DOCUMENTATION_OPTIONS = {
22
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
3-
VERSION: '0.5.0',
3+
VERSION: '0.5.2',
44
LANGUAGE: 'None',
55
COLLAPSE_INDEX: false,
66
BUILDER: 'html',

‎docs/html/fitter.html‎

Lines changed: 26 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1010

11-
<title>Integrated fitting workflow (pesfit.fitter) &mdash; pesfit 0.5.0 documentation</title>
11+
<title>Integrated fitting workflow (pesfit.fitter) &mdash; pesfit 0.5.2 documentation</title>
1212

1313

1414

@@ -35,7 +35,7 @@
3535
<link rel="index" title="Index"
3636
href="genindex.html"/>
3737
<link rel="search" title="Search" href="search.html"/>
38-
<link rel="top" title="pesfit 0.5.0 documentation" href="index.html"/>
38+
<link rel="top" title="pesfit 0.5.2 documentation" href="index.html"/>
3939
<link rel="next" title="Utility functions (pesfit.utils)" href="utils.html"/>
4040
<link rel="prev" title="Complex lineshape models (pesfit.lineshape)" href="lineshape.html"/>
4141

@@ -66,7 +66,7 @@
6666

6767

6868
<div class="version">
69-
0.5.0
69+
0.5.2
7070
</div>
7171

7272

@@ -182,8 +182,16 @@
182182

183183
<dl class="py method">
184184
<dt id="pesfit.fitter.ParallelPatchFitter.parallel_fit">
185-
<code class="sig-name descname">parallel_fit</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">varkeys</span><span class="o">=</span><span class="default_value">['value', 'vary']</span></em>, <em class="sig-param"><span class="n">other_initvals</span><span class="o">=</span><span class="default_value">[True]</span></em>, <em class="sig-param"><span class="n">compute_kwds</span><span class="o">=</span><span class="default_value">{}</span></em>, <em class="sig-param"><span class="n">scheduler</span><span class="o">=</span><span class="default_value">'processes'</span></em>, <em class="sig-param"><span class="n">backend</span><span class="o">=</span><span class="default_value">'dask'</span></em>, <em class="sig-param"><span class="n">ret</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwds</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pesfit.fitter.ParallelPatchFitter.parallel_fit" title="Permalink to this definition"></a></dt>
186-
<dd><p>Parallel line fitting of the data patch.</p>
185+
<code class="sig-name descname">parallel_fit</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">varkeys</span><span class="o">=</span><span class="default_value">['value', 'vary']</span></em>, <em class="sig-param"><span class="n">other_initvals</span><span class="o">=</span><span class="default_value">[True]</span></em>, <em class="sig-param"><span class="n">para_kwds</span><span class="o">=</span><span class="default_value">{}</span></em>, <em class="sig-param"><span class="n">scheduler</span><span class="o">=</span><span class="default_value">'processes'</span></em>, <em class="sig-param"><span class="n">backend</span><span class="o">=</span><span class="default_value">'multiprocessing'</span></em>, <em class="sig-param"><span class="n">ret</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwds</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pesfit.fitter.ParallelPatchFitter.parallel_fit" title="Permalink to this definition"></a></dt>
186+
<dd><p>Parallel pointwise spectrum fitting of the data patch.</p>
187+
<p><strong>Parameters</strong></p>
188+
<p>varkeys: list/tuple | [‘value’, ‘vary’]
189+
other_initvals: list/tuple | [True]
190+
para_kwds: dic | {}
191+
scheduler: str | ‘processes’
192+
backend: str | ‘multiprocessing’
193+
ret: bool | False
194+
<a href="#id1"><span class="problematic" id="id2">**</span></a>kwds: keyword arguments</p>
187195
</dd></dl>
188196

189197
<dl class="py method">
@@ -235,7 +243,7 @@
235243
</dd>
236244
<dt>ftype: str | ‘h5’</dt><dd><p>File type to load.</p>
237245
</dd>
238-
<dt><a href="#id1"><span class="problematic" id="id2">**</span></a>kwds: keywords argument</dt><dd><p>Additional arguments for <code class="docutils literal notranslate"><span class="pre">pesfit.fitter.load_file()</span></code>.</p>
246+
<dt><a href="#id3"><span class="problematic" id="id4">**</span></a>kwds: keywords argument</dt><dd><p>Additional arguments for <code class="docutils literal notranslate"><span class="pre">pesfit.fitter.load_file()</span></code>.</p>
239247
</dd>
240248
</dl>
241249
</dd></dl>
@@ -284,7 +292,7 @@
284292
</dd>
285293
<dt>pbenv: str | ‘notebook’</dt><dd><p>Progress bar environment (‘notebook’ for Jupyter notebook or ‘classic’ for command line).</p>
286294
</dd>
287-
<dt><a href="#id3"><span class="problematic" id="id4">**</span></a>kwds: keywords arguments</dt><dd><dl class="simple">
295+
<dt><a href="#id5"><span class="problematic" id="id6">**</span></a>kwds: keywords arguments</dt><dd><dl class="simple">
288296
<dt>nspec: int | <code class="docutils literal notranslate"><span class="pre">self.nspec</span></code></dt><dd><p>Number of spectra for fitting.</p>
289297
</dd>
290298
<dt>additional arguments:</dt><dd><p>See <code class="docutils literal notranslate"><span class="pre">pesfit.fitter.pointwise_fitting()</span></code>.</p>
@@ -331,7 +339,7 @@
331339
</dd>
332340
<dt>varkeys: list/tuple | [‘value’]</dt><dd><p>Keyword specified for the parameter (‘value’, ‘min’, ‘max’, ‘vary’).</p>
333341
</dd>
334-
<dt><a href="#id5"><span class="problematic" id="id6">**</span></a>kwds: keyword arguments</dt><dd><dl class="simple">
342+
<dt><a href="#id7"><span class="problematic" id="id8">**</span></a>kwds: keyword arguments</dt><dd><dl class="simple">
335343
<dt>lpnames: list/tuple | None</dt><dd><p>Collection of namestrings (or prefixes) for lineshapes.</p>
336344
</dd>
337345
<dt>parvals: list/tuple | None</dt><dd><p>Collection of values for parameters.</p>
@@ -357,7 +365,7 @@
357365
</dd>
358366
<dt>background: str | ‘None’</dt><dd><p>Background model name. All possible models see <code class="docutils literal notranslate"><span class="pre">lmfit.models</span></code>.</p>
359367
</dd>
360-
<dt><a href="#id7"><span class="problematic" id="id8">**</span></a>kwds: keyword arguments</dt><dd><p>Additional keyword arguments for <code class="docutils literal notranslate"><span class="pre">pesfit.lineshape.MultipeakModel</span></code> class.</p>
368+
<dt><a href="#id9"><span class="problematic" id="id10">**</span></a>kwds: keyword arguments</dt><dd><p>Additional keyword arguments for <code class="docutils literal notranslate"><span class="pre">pesfit.lineshape.MultipeakModel</span></code> class.</p>
361369
</dd>
362370
</dl>
363371
<p><strong>Return</strong></p>
@@ -389,7 +397,7 @@
389397
</dd>
390398
<dt>ret: bool | False</dt><dd><p>Option to return the graphical elements.</p>
391399
</dd>
392-
<dt><a href="#id9"><span class="problematic" id="id10">**</span></a>kwds: keyword arguments</dt><dd><dl class="simple">
400+
<dt><a href="#id11"><span class="problematic" id="id12">**</span></a>kwds: keyword arguments</dt><dd><dl class="simple">
393401
<dt>figsize: list/tuple | [10, 6]</dt><dd><p>Default size of the figure.</p>
394402
</dd>
395403
</dl>
@@ -411,7 +419,7 @@
411419
</dd>
412420
<dt>downsamp: int | 1</dt><dd><p>Level of downsampling of the data (1 means no downsampling).</p>
413421
</dd>
414-
<dt><a href="#id11"><span class="problematic" id="id12">**</span></a>kwds: keyword arguments</dt><dd><dl class="simple">
422+
<dt><a href="#id13"><span class="problematic" id="id14">**</span></a>kwds: keyword arguments</dt><dd><dl class="simple">
415423
<dt>figsize: list/tuple | [8, 5]</dt><dd><p>Default size of the figure.</p>
416424
</dd>
417425
</dl>
@@ -445,7 +453,7 @@
445453
<p><code class="docutils literal notranslate"><span class="pre">'result'</span></code>: returns the fitting result</p>
446454
<p><code class="docutils literal notranslate"><span class="pre">'all'</span></code>: returns the fitting result and evaluated lineshape components.</p>
447455
</dd>
448-
<dt><a href="#id13"><span class="problematic" id="id14">**</span></a>kwds: keyword arguments</dt><dd><dl class="simple">
456+
<dt><a href="#id15"><span class="problematic" id="id16">**</span></a>kwds: keyword arguments</dt><dd><dl class="simple">
449457
<dt>shifts: list/tuple/numpy array | np.arange(0.1, 1.1, 0.1)</dt><dd><p>The choices of random shifts to apply to the peak position initialization (energy in eV unit). The shifts are only operational when <code class="docutils literal notranslate"><span class="pre">jitter_init=True</span></code>.</p>
450458
</dd>
451459
<dt>other arguments</dt><dd><p>See details in <code class="docutils literal notranslate"><span class="pre">pesfit.fitter.random_varshift()</span></code>.</p>
@@ -463,7 +471,7 @@
463471

464472
<dl class="py function">
465473
<dt id="pesfit.fitter.random_varshift">
466-
<code class="sig-prename descclassname">pesfit.fitter.</code><code class="sig-name descname">random_varshift</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">fitres</span></em>, <em class="sig-param"><span class="n">model</span></em>, <em class="sig-param"><span class="n">params</span></em>, <em class="sig-param"><span class="n">shifts</span></em>, <em class="sig-param"><span class="n">yvals</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">xvals</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">parnames</span><span class="o">=</span><span class="default_value">[]</span></em>, <em class="sig-param"><span class="n">verbose</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwds</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pesfit.fitter.random_varshift" title="Permalink to this definition"></a></dt>
474+
<code class="sig-prename descclassname">pesfit.fitter.</code><code class="sig-name descname">random_varshift</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">fitres</span></em>, <em class="sig-param"><span class="n">model</span></em>, <em class="sig-param"><span class="n">params</span></em>, <em class="sig-param"><span class="n">shifts</span><span class="o">=</span><span class="default_value">[]</span></em>, <em class="sig-param"><span class="n">yvals</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">xvals</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">parnames</span><span class="o">=</span><span class="default_value">[]</span></em>, <em class="sig-param"><span class="n">verbose</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwds</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pesfit.fitter.random_varshift" title="Permalink to this definition"></a></dt>
467475
<dd><p>Recursively apply a random shift value to certain key variables to get a better fit. Execution of the function terminates when either (1) the fitting results are sufficiently good (measured by its chi-squared metric) or (2) the trials exhaust all choices of shift parameters.</p>
468476
<p><strong>Parameters</strong></p>
469477
<dl class="simple">
@@ -473,12 +481,16 @@
473481
</dd>
474482
<dt>params: instance of <code class="docutils literal notranslate"><span class="pre">lmfit.parameter.Parameters</span></code></dt><dd><p>Lineshape model parameters.</p>
475483
</dd>
484+
<dt>shifts: list/tuple/array | []</dt><dd><p>Different random shifts to apply to the initial conditions.</p>
485+
</dd>
476486
<dt>xvals, yvals: numpy array, numpy array | None, None</dt><dd><p>Horizontal and vertical axis values for the lineshape fitting.</p>
477487
</dd>
478488
<dt>parnames: list | []</dt><dd><p>List of names of the parameters to update initial conditions.</p>
479489
</dd>
480490
<dt>verbose: bool | True</dt><dd><p>Option for printout of the chi-squared value.</p>
481491
</dd>
492+
<dt><a href="#id17"><span class="problematic" id="id18">**</span></a>kwds: keyword arguments</dt><dd><p>Extra keywords passed to the <code class="docutils literal notranslate"><span class="pre">Model.fit()</span></code> method.</p>
493+
</dd>
482494
</dl>
483495
</dd></dl>
484496

@@ -543,7 +555,7 @@
543555
<script type="text/javascript">
544556
var DOCUMENTATION_OPTIONS = {
545557
URL_ROOT:'./',
546-
VERSION:'0.5.0',
558+
VERSION:'0.5.2',
547559
COLLAPSE_INDEX:false,
548560
FILE_SUFFIX:'.html',
549561
HAS_SOURCE: true,

‎docs/html/genindex.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1111

12-
<title>Index &mdash; pesfit 0.5.0 documentation</title>
12+
<title>Index &mdash; pesfit 0.5.2 documentation</title>
1313

1414

1515

@@ -36,7 +36,7 @@
3636
<link rel="index" title="Index"
3737
href="#"/>
3838
<link rel="search" title="Search" href="search.html"/>
39-
<link rel="top" title="pesfit 0.5.0 documentation" href="index.html"/>
39+
<link rel="top" title="pesfit 0.5.2 documentation" href="index.html"/>
4040

4141

4242
<script src="_static/js/modernizr.min.js"></script>
@@ -65,7 +65,7 @@
6565

6666

6767
<div class="version">
68-
0.5.0
68+
0.5.2
6969
</div>
7070

7171

@@ -504,7 +504,7 @@ <h2 id="V">V</h2>
504504
<script type="text/javascript">
505505
var DOCUMENTATION_OPTIONS = {
506506
URL_ROOT:'./',
507-
VERSION:'0.5.0',
507+
VERSION:'0.5.2',
508508
COLLAPSE_INDEX:false,
509509
FILE_SUFFIX:'.html',
510510
HAS_SOURCE: true,

‎docs/html/index.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1010

11-
<title>pesfit documentation &mdash; pesfit 0.5.0 documentation</title>
11+
<title>pesfit documentation &mdash; pesfit 0.5.2 documentation</title>
1212

1313

1414

@@ -35,7 +35,7 @@
3535
<link rel="index" title="Index"
3636
href="genindex.html"/>
3737
<link rel="search" title="Search" href="search.html"/>
38-
<link rel="top" title="pesfit 0.5.0 documentation" href="#"/>
38+
<link rel="top" title="pesfit 0.5.2 documentation" href="#"/>
3939
<link rel="next" title="How to start" href="I01_start.html"/>
4040

4141

@@ -65,7 +65,7 @@
6565

6666

6767
<div class="version">
68-
0.5.0
68+
0.5.2
6969
</div>
7070

7171

@@ -227,7 +227,7 @@ <h2>Rationale<a class="headerlink" href="#rationale" title="Permalink to this he
227227
<script type="text/javascript">
228228
var DOCUMENTATION_OPTIONS = {
229229
URL_ROOT:'./',
230-
VERSION:'0.5.0',
230+
VERSION:'0.5.2',
231231
COLLAPSE_INDEX:false,
232232
FILE_SUFFIX:'.html',
233233
HAS_SOURCE: true,

‎docs/html/lineshape.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1010

11-
<title>Complex lineshape models (pesfit.lineshape) &mdash; pesfit 0.5.0 documentation</title>
11+
<title>Complex lineshape models (pesfit.lineshape) &mdash; pesfit 0.5.2 documentation</title>
1212

1313

1414

@@ -35,7 +35,7 @@
3535
<link rel="index" title="Index"
3636
href="genindex.html"/>
3737
<link rel="search" title="Search" href="search.html"/>
38-
<link rel="top" title="pesfit 0.5.0 documentation" href="index.html"/>
38+
<link rel="top" title="pesfit 0.5.2 documentation" href="index.html"/>
3939
<link rel="next" title="Integrated fitting workflow (pesfit.fitter)" href="fitter.html"/>
4040
<link rel="prev" title="How to start" href="I01_start.html"/>
4141

@@ -66,7 +66,7 @@
6666

6767

6868
<div class="version">
69-
0.5.0
69+
0.5.2
7070
</div>
7171

7272

@@ -421,7 +421,7 @@
421421
<script type="text/javascript">
422422
var DOCUMENTATION_OPTIONS = {
423423
URL_ROOT:'./',
424-
VERSION:'0.5.0',
424+
VERSION:'0.5.2',
425425
COLLAPSE_INDEX:false,
426426
FILE_SUFFIX:'.html',
427427
HAS_SOURCE: true,

‎docs/html/objects.inv‎

0 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)