-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
356 lines (228 loc) · 15.4 KB
/
index.html
File metadata and controls
356 lines (228 loc) · 15.4 KB
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
356
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Home — tomotok 1.3 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="tomotok 1.3 documentation" href="#"/>
<link rel="next" title="1. Welcome" href="welcome.html"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<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"> tomotok
</a>
<div class="version">
1.3
</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" />
<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="main navigation">
<p class="caption"><span class="caption-text">Table of Contents</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="welcome.html">1. Welcome</a></li>
<li class="toctree-l1"><a class="reference internal" href="licence.html">2. Licence</a></li>
<li class="toctree-l1"><a class="reference internal" href="install.html">3. Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="inversions/inversions.html">4. Inversions</a></li>
<li class="toctree-l1"><a class="reference internal" href="auxilia/auxilia.html">5. Auxiliary functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="gui/gui.html">6. Graphical User Interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="glossary.html">7. Glossary</a></li>
</ul>
<p class="caption"><span class="caption-text">Api Doc</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="api/tomotok.core.html">1. tomotok.core package</a></li>
<li class="toctree-l1"><a class="reference internal" href="api/tomotok.gui.html">2. tomotok.gui package</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">tomotok</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="#">Docs</a> »</li>
<li>Home</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">
<div class="section" id="tomotok-s-documentation">
<h1>Tomotok’s documentation<a class="headerlink" href="#tomotok-s-documentation" title="Permalink to this headline">¶</a></h1>
<p>Welcome to the Tomotok project for tomography of tokamak plasma.</p>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Table of Contents</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="welcome.html">1. Welcome</a><ul>
<li class="toctree-l2"><a class="reference internal" href="welcome.html#contributors">1.1. Contributors</a></li>
<li class="toctree-l2"><a class="reference internal" href="welcome.html#citations">1.2. Citations</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="licence.html">2. Licence</a><ul>
<li class="toctree-l2"><a class="reference internal" href="licence.html#european-union-public-licence">2.1. EUROPEAN UNION PUBLIC LICENCE</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="install.html">3. Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="inversions/inversions.html">4. Inversions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="inversions/mfr.html">4.1. Minimum Fisher Regularization</a></li>
<li class="toctree-l2"><a class="reference internal" href="inversions/lame.html">4.2. Linear Algebraic Methods</a></li>
<li class="toctree-l2"><a class="reference internal" href="inversions/bob.html">4.3. BiOrthogonal Basis Decomposition</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="auxilia/auxilia.html">5. Auxiliary functions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="auxilia/geometry.html">5.1. Geometry</a></li>
<li class="toctree-l2"><a class="reference internal" href="auxilia/io.html">5.2. Database access (IO)</a></li>
<li class="toctree-l2"><a class="reference internal" href="auxilia/derivative.html">5.3. Derivative matrix</a></li>
<li class="toctree-l2"><a class="reference internal" href="auxilia/phantoms.html">5.4. Phantoms</a></li>
<li class="toctree-l2"><a class="reference internal" href="auxilia/tools.html">5.5. Tools</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="gui/gui.html">6. Graphical User Interface</a><ul>
<li class="toctree-l2"><a class="reference internal" href="gui/apps.html">6.1. Applications</a></li>
<li class="toctree-l2"><a class="reference internal" href="gui/tomo.html">6.2. Tomography widgets</a></li>
<li class="toctree-l2"><a class="reference internal" href="gui/common.html">6.3. Common GUI widgets</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="glossary.html">7. Glossary</a><ul>
<li class="toctree-l2"><a class="reference internal" href="glossary.html#terminology">7.1. Terminology</a></li>
<li class="toctree-l2"><a class="reference internal" href="glossary.html#shortcuts">7.2. Shortcuts</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Api Doc</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="api/tomotok.core.html">1. tomotok.core package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api/tomotok.core.html#subpackages">1.1. Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/tomotok.core.geometry.html">1.1.1. tomotok.core.geometry package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="api/tomotok.core.geometry.html#submodules">1.1.1.1. Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="api/tomotok.core.geometry.html#module-tomotok.core.geometry.analytical">1.1.1.2. tomotok.core.geometry.analytical module</a></li>
<li class="toctree-l4"><a class="reference internal" href="api/tomotok.core.geometry.html#module-tomotok.core.geometry.generators">1.1.1.3. tomotok.core.geometry.generators module</a></li>
<li class="toctree-l4"><a class="reference internal" href="api/tomotok.core.geometry.html#module-tomotok.core.geometry.grids">1.1.1.4. tomotok.core.geometry.grids module</a></li>
<li class="toctree-l4"><a class="reference internal" href="api/tomotok.core.geometry.html#module-tomotok.core.geometry.handler">1.1.1.5. tomotok.core.geometry.handler module</a></li>
<li class="toctree-l4"><a class="reference internal" href="api/tomotok.core.geometry.html#module-tomotok.core.geometry.io">1.1.1.6. tomotok.core.geometry.io module</a></li>
<li class="toctree-l4"><a class="reference internal" href="api/tomotok.core.geometry.html#module-tomotok.core.geometry.los">1.1.1.7. tomotok.core.geometry.los module</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="api/tomotok.core.inversions.html">1.1.2. tomotok.core.inversions package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="api/tomotok.core.inversions.html#submodules">1.1.2.1. Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="api/tomotok.core.inversions.html#module-tomotok.core.inversions.bob">1.1.2.2. tomotok.core.inversions.bob module</a></li>
<li class="toctree-l4"><a class="reference internal" href="api/tomotok.core.inversions.html#module-tomotok.core.inversions.fixed">1.1.2.3. tomotok.core.inversions.fixed module</a></li>
<li class="toctree-l4"><a class="reference internal" href="api/tomotok.core.inversions.html#module-tomotok.core.inversions.lame">1.1.2.4. tomotok.core.inversions.lame module</a></li>
<li class="toctree-l4"><a class="reference internal" href="api/tomotok.core.inversions.html#module-tomotok.core.inversions.mfr">1.1.2.5. tomotok.core.inversions.mfr module</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="api/tomotok.core.io.html">1.1.3. tomotok.core.io package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="api/tomotok.core.io.html#submodules">1.1.3.1. Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="api/tomotok.core.io.html#module-tomotok.core.io.diag">1.1.3.2. tomotok.core.io.diag module</a></li>
<li class="toctree-l4"><a class="reference internal" href="api/tomotok.core.io.html#module-tomotok.core.io.support">1.1.3.3. tomotok.core.io.support module</a></li>
<li class="toctree-l4"><a class="reference internal" href="api/tomotok.core.io.html#module-tomotok.core.io.tokamaks">1.1.3.4. tomotok.core.io.tokamaks module</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="api/tomotok.core.tools.html">1.1.4. tomotok.core.tools package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="api/tomotok.core.tools.html#submodules">1.1.4.1. Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="api/tomotok.core.tools.html#module-tomotok.core.tools.checkers">1.1.4.2. tomotok.core.tools.checkers module</a><ul>
<li class="toctree-l5"><a class="reference internal" href="api/tomotok.core.tools.html#examples">1.1.4.2.1. Examples</a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="api/tomotok.core.tools.html#module-tomotok.core.tools.data">1.1.4.3. tomotok.core.tools.data module</a></li>
<li class="toctree-l4"><a class="reference internal" href="api/tomotok.core.tools.html#tomotok-core-tools-gifmaker-module">1.1.4.4. tomotok.core.tools.gifmaker module</a></li>
<li class="toctree-l4"><a class="reference internal" href="api/tomotok.core.tools.html#module-tomotok.core.tools.hdf">1.1.4.5. tomotok.core.tools.hdf module</a></li>
<li class="toctree-l4"><a class="reference internal" href="api/tomotok.core.tools.html#module-tomotok.core.tools.postproc">1.1.4.6. tomotok.core.tools.postproc module</a></li>
<li class="toctree-l4"><a class="reference internal" href="api/tomotok.core.tools.html#module-tomotok.core.tools.projection">1.1.4.7. tomotok.core.tools.projection module</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/tomotok.core.html#submodules">1.2. Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/tomotok.core.html#module-tomotok.core.derivative">1.3. tomotok.core.derivative module</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/tomotok.core.html#module-tomotok.core.phantoms">1.4. tomotok.core.phantoms module</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api/tomotok.gui.html">2. tomotok.gui package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api/tomotok.gui.html#submodules">2.1. Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/tomotok.gui.html#module-tomotok.gui.apps">2.2. tomotok.gui.apps module</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/tomotok.gui.html#module-tomotok.gui.menus">2.3. tomotok.gui.menus module</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/tomotok.gui.html#module-tomotok.gui.merfer">2.4. tomotok.gui.merfer module</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/tomotok.gui.html#module-tomotok.gui.profiler">2.5. tomotok.gui.profiler module</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/tomotok.gui.html#module-tomotok.gui.roi">2.6. tomotok.gui.roi module</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/tomotok.gui.html#module-tomotok.gui.widgets">2.7. tomotok.gui.widgets module</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/tomotok.gui.html#module-tomotok.gui.widgets_tomo">2.8. tomotok.gui.widgets_tomo module</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="indices-and-tables">
<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
<li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
</ul>
</div>
</div>
</div>
<div class="articleComments">
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="welcome.html" class="btn btn-neutral float-right" title="1. Welcome" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2021, Institute of Plasma Physics of CAS.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'1.3',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</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="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>