-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
254 lines (233 loc) · 15.7 KB
/
index.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
<!DOCTYPE html>
<html class="writer-html5" lang="en">
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Welcome to the Fitspy documentation ! — Fitspy 2025.1dev documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css" />
<link rel="stylesheet" type="text/css" href="_static/plot_directive.css" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
<script src="_static/jquery.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<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/clipboard.min.js"></script>
<script src="_static/copybutton.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="Introduction" href="user_guide/intro.html" />
</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" >
<a href="#" class="icon icon-home">
Fitspy
<img src="_static/logo_black.png" class="logo" alt="Logo"/>
</a>
<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">
<p class="caption" role="heading"><span class="caption-text">User Guide</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="user_guide/intro.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/input_data.html">Input data files</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/baseline.html">Baselines and Background models</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/peak_models.html">Peak models</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/fitting.html">Fitting</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/workflow.html">Workflow</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/auto_mode.html">Auto mode</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/gui.html">GUI description</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/outputs.html">Outputs</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Release Notes</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="release_notes/release_notes.html">Release Notes</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Developers Guide</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="dev_guide/dev_notes.html">Developers Notes</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">API References</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="api/modules.html">fitspy</a></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" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">Fitspy</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="#" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Welcome to the Fitspy documentation !</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<p><a class="reference external" href="https://cea-metrocarac.github.io/fitspy/doc/index.html"><img alt="docs" src="https://img.shields.io/badge/%F0%9F%95%AE-docs-green.svg" /></a> <a class="reference external" href="https://github.com/CEA-MetroCarac/fitspy"><img alt="github" src="https://img.shields.io/badge/GitHub-GPL--3.0-informational" /></a> <a class="reference external" href="https://pypi.org/project/fitspy"><img alt="pypi" src="https://badge.fury.io/py/fitspy.svg" /></a> <a class="reference external" href="https://doi.org/10.5281/zenodo.10812333"><img alt="doi" src="https://zenodo.org/badge/DOI/10.5281/zenodo.10812333.svg" /></a> <a class="reference external" href="https://joss.theoj.org/papers/971a02868d903c0b7c0cbc3d1cd3d139"><img alt="joss" src="https://joss.theoj.org/papers/971a02868d903c0b7c0cbc3d1cd3d139/status.svg" /></a></p>
<section id="welcome-to-the-fitspy-documentation">
<h1>Welcome to the Fitspy documentation !<a class="headerlink" href="#welcome-to-the-fitspy-documentation" title="Permalink to this heading"></a></h1>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">User Guide</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="user_guide/intro.html">Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="user_guide/intro.html#what-is-fitspy">What is Fitspy</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide/intro.html#install-and-launching">Install and launching</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide/intro.html#quick-start">Quick start</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide/intro.html#how-fitspy-works">How Fitspy works</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/input_data.html">Input data files</a><ul>
<li class="toctree-l2"><a class="reference internal" href="user_guide/input_data.html#d-spectrum">1D-spectrum</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide/input_data.html#d-map-spectra">2D-map spectra</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/baseline.html">Baselines and Background models</a><ul>
<li class="toctree-l2"><a class="reference internal" href="user_guide/baseline.html#baseline-approach">Baseline approach</a><ul>
<li class="toctree-l3"><a class="reference internal" href="user_guide/baseline.html#manual-approach">Manual approach</a></li>
<li class="toctree-l3"><a class="reference internal" href="user_guide/baseline.html#semi-automatic-approach">Semi-Automatic approach</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="user_guide/baseline.html#background-model">Background model</a><ul>
<li class="toctree-l3"><a class="reference internal" href="user_guide/baseline.html#user-defined-background-models">User-defined background models</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/peak_models.html">Peak models</a><ul>
<li class="toctree-l2"><a class="reference internal" href="user_guide/peak_models.html#predefined-models">Predefined models</a><ul>
<li class="toctree-l3"><a class="reference internal" href="user_guide/peak_models.html#gaussian">Gaussian</a></li>
<li class="toctree-l3"><a class="reference internal" href="user_guide/peak_models.html#lorentzian">Lorentzian</a></li>
<li class="toctree-l3"><a class="reference internal" href="user_guide/peak_models.html#asymetric-gaussian">Asymetric Gaussian</a></li>
<li class="toctree-l3"><a class="reference internal" href="user_guide/peak_models.html#asymetric-lorentzian">Asymetric Lorentzian</a></li>
<li class="toctree-l3"><a class="reference internal" href="user_guide/peak_models.html#pseudovoigt">Pseudovoigt</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="user_guide/peak_models.html#user-defined-models">User-defined models</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/fitting.html">Fitting</a><ul>
<li class="toctree-l2"><a class="reference internal" href="user_guide/fitting.html#noise-level">Noise level</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide/fitting.html#outliers">Outliers</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide/fitting.html#fitting-parameters">Fitting parameters</a><ul>
<li class="toctree-l3"><a class="reference internal" href="user_guide/fitting.html#fitting-algorithm">Fitting algorithm</a></li>
<li class="toctree-l3"><a class="reference internal" href="user_guide/fitting.html#convergence-criterion">Convergence criterion</a></li>
<li class="toctree-l3"><a class="reference internal" href="user_guide/fitting.html#maximum-number-of-iterations">Maximum number of iterations</a></li>
<li class="toctree-l3"><a class="reference internal" href="user_guide/fitting.html#weighting">Weighting</a></li>
<li class="toctree-l3"><a class="reference internal" href="user_guide/fitting.html#multi-threading">Multi-threading</a></li>
<li class="toctree-l3"><a class="reference internal" href="user_guide/fitting.html#parameters-values-initialization">Parameters values initialization</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="user_guide/fitting.html#constraints-settings">Constraints settings</a><ul>
<li class="toctree-l3"><a class="reference internal" href="user_guide/fitting.html#models-parameters-fixing">Models parameters fixing</a></li>
<li class="toctree-l3"><a class="reference internal" href="user_guide/fitting.html#models-parameters-bounding">Models parameters bounding</a></li>
<li class="toctree-l3"><a class="reference internal" href="user_guide/fitting.html#models-parameters-coupling">Models parameters coupling</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="user_guide/fitting.html#performance">Performance</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/workflow.html">Workflow</a><ul>
<li class="toctree-l2"><a class="reference internal" href="user_guide/workflow.html#gui-mode">GUI Mode</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide/workflow.html#scripting-mode">Scripting Mode</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/auto_mode.html">Auto mode</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/gui.html">GUI description</a><ul>
<li class="toctree-l2"><a class="reference internal" href="user_guide/gui.html#files-selection">Files selection</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide/gui.html#global-actions-tkinter">Global actions (Tkinter)</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide/gui.html#overall-settings">Overall settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide/gui.html#baseline">Baseline</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide/gui.html#normalization">Normalization</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide/gui.html#fitting">Fitting</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide/gui.html#models-tkinter-gui">Models (Tkinter GUI)</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide/gui.html#models-pyside-gui">Models (PySide GUI)</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide/gui.html#main-figure">Main Figure</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide/gui.html#d-map-figures">2D-map Figures</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/outputs.html">Outputs</a><ul>
<li class="toctree-l2"><a class="reference internal" href="user_guide/outputs.html#outputs-models">Outputs models</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide/outputs.html#fit-results">Fit results</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Release Notes</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="release_notes/release_notes.html">Release Notes</a><ul>
<li class="toctree-l2"><a class="reference internal" href="release_notes/release_notes.html#version-2024-5-september-4-2024">Version 2024.5 (September 4, 2024)</a></li>
<li class="toctree-l2"><a class="reference internal" href="release_notes/release_notes.html#version-2024-4-february-27-2024">Version 2024.4 (February 27, 2024)</a></li>
<li class="toctree-l2"><a class="reference internal" href="release_notes/release_notes.html#version-2024-2-january-29-2024">Version 2024.2 (January 29, 2024)</a></li>
<li class="toctree-l2"><a class="reference internal" href="release_notes/release_notes.html#version-2024-1-january-16-2024">Version 2024.1 (January 16, 2024)</a></li>
<li class="toctree-l2"><a class="reference internal" href="release_notes/release_notes.html#version-2023-x">Version 2023.x</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Developers Guide</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="dev_guide/dev_notes.html">Developers Notes</a><ul>
<li class="toctree-l2"><a class="reference internal" href="dev_guide/dev_notes.html#issues">Issues</a></li>
<li class="toctree-l2"><a class="reference internal" href="dev_guide/dev_notes.html#visual-studio-code-setup-to-preview-rst-files">Visual Studio Code Setup to Preview .rst Files</a></li>
<li class="toctree-l2"><a class="reference internal" href="dev_guide/dev_notes.html#pull-requests">Pull Requests</a></li>
<li class="toctree-l2"><a class="reference internal" href="dev_guide/dev_notes.html#todo-list">TODO List</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">API References</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="api/modules.html">fitspy</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api/fitspy.html">fitspy package</a></li>
</ul>
</li>
</ul>
</div>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="user_guide/intro.html" class="btn btn-neutral float-right" title="Introduction" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2023-2025, The Fitspy 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>
</body>
</html>