-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathavailable_modules.html
More file actions
326 lines (206 loc) · 11.2 KB
/
available_modules.html
File metadata and controls
326 lines (206 loc) · 11.2 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
<!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="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>5. Available Packages — Cherab 1.5.0 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/theme_overrides.css" type="text/css" />
<link rel="stylesheet" href="_static/tabs.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="6. Atomic Data" href="atomic/atomic_data.html" />
<link rel="prev" title="4. Installation and Project Structure" href="installation_and_structure.html" />
<script src="_static/js/modernizr.min.js"></script>
</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="index.html" class="icon icon-home"> Cherab
</a>
<div class="version">
1.5
</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" role="heading"><span class="caption-text">Table of Contents</span></p>
<ul class="current">
<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="governance.html">3. Project Governance</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation_and_structure.html">4. Installation and Project Structure</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">5. Available Packages</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#atomic-data-providers">5.1. Atomic Data Providers</a></li>
<li class="toctree-l2"><a class="reference internal" href="#fusion-experiment-packages">5.2. Fusion Experiment Packages</a></li>
<li class="toctree-l2"><a class="reference internal" href="#code-interface-packages">5.3. Code Interface Packages</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="atomic/atomic_data.html">6. Atomic Data</a></li>
<li class="toctree-l1"><a class="reference internal" href="plasmas/plasmas.html">7. Plasmas</a></li>
<li class="toctree-l1"><a class="reference internal" href="models/emission_models.html">8. Emission Models</a></li>
<li class="toctree-l1"><a class="reference internal" href="math/math.html">9. Function Framework</a></li>
<li class="toctree-l1"><a class="reference internal" href="tools/tools.html">10. Tools</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Demonstrations</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="demonstrations/demonstrations.html">Atomic Data</a></li>
<li class="toctree-l1"><a class="reference internal" href="demonstrations/demonstrations.html#creating-plasmas">Creating Plasmas</a></li>
<li class="toctree-l1"><a class="reference internal" href="demonstrations/demonstrations.html#surface-radiation-loads">Surface Radiation Loads</a></li>
<li class="toctree-l1"><a class="reference internal" href="demonstrations/demonstrations.html#active-spectroscopy">Active Spectroscopy</a></li>
<li class="toctree-l1"><a class="reference internal" href="demonstrations/demonstrations.html#passive-spectroscopy">Passive Spectroscopy</a></li>
<li class="toctree-l1"><a class="reference internal" href="demonstrations/demonstrations.html#bolometry">Bolometry</a></li>
<li class="toctree-l1"><a class="reference internal" href="demonstrations/demonstrations.html#geometry-matrices">Geometry Matrices</a></li>
<li class="toctree-l1"><a class="reference internal" href="demonstrations/demonstrations.html#code-examples-gallery">Code examples gallery</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Cherab</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="index.html">Docs</a> »</li>
<li><span class="section-number">5. </span>Available Packages</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/available_modules.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">
<section id="available-packages">
<h1><span class="section-number">5. </span>Available Packages<a class="headerlink" href="#available-packages" title="Permalink to this heading">¶</a></h1>
<section id="atomic-data-providers">
<h2><span class="section-number">5.1. </span>Atomic Data Providers<a class="headerlink" href="#atomic-data-providers" title="Permalink to this heading">¶</a></h2>
<table class="docutils align-default">
<colgroup>
<col style="width: 22%" />
<col style="width: 78%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Package</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><a class="reference external" href="https://github.com/cherab/openadas">cherab-openadas</a></p></td>
<td><p>Provides utility functions for downloading <a class="reference external" href="http://open.adas.ac.uk">OPEN-ADAS</a>
data and loading it into Cherab’s atomic data objects. This package is the default
atomic data provider for Cherab.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference external" href="https://github.com/cherab/adas">cherab-adas</a></p></td>
<td><p>Provides python wrappers to the <a class="reference external" href="http://www.adas.ac.uk/">ADAS</a> subscription packages and enables their
use in Cherab. Note that you will need an ADAS subscription to use this package. This package
is currently in the early development phase and not ready for general use.</p></td>
</tr>
</tbody>
</table>
</section>
<section id="fusion-experiment-packages">
<h2><span class="section-number">5.2. </span>Fusion Experiment Packages<a class="headerlink" href="#fusion-experiment-packages" title="Permalink to this heading">¶</a></h2>
<table class="docutils align-default">
<colgroup>
<col style="width: 22%" />
<col style="width: 78%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Package</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><a class="reference external" href="https://github.com/cherab/aug">cherab-aug</a></p></td>
<td><p>The Cherab configuration package for AUG.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference external" href="https://github.com/cherab/compass">cherab-compass</a></p></td>
<td><p>The Cherab configuration package for COMPASS.</p></td>
</tr>
<tr class="row-even"><td><p>cherab-iter</p></td>
<td><p>Integrates Cherab with IMAS and provides diagnostic configuration
for ITER. This package is under development but not yet publicly available.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference external" href="https://github.com/cherab/jet">cherab-jet</a></p></td>
<td><p>Experiment configuration package for JET.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference external" href="https://github.com/cherab/mastu">cherab-mastu</a></p></td>
<td><p>Experiment configuration package for MASTU.</p></td>
</tr>
</tbody>
</table>
</section>
<section id="code-interface-packages">
<h2><span class="section-number">5.3. </span>Code Interface Packages<a class="headerlink" href="#code-interface-packages" title="Permalink to this heading">¶</a></h2>
<p>These are packages that provide interfaces to other modelling codes
and workflow management tools.</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 22%" />
<col style="width: 78%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Package</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><a class="reference external" href="https://github.com/cherab/omfit">cherab-omfit</a></p></td>
<td><p>Module for providing OMFIT integration and example workflow scripts.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference external" href="https://github.com/cherab/solps">cherab-solps</a></p></td>
<td><p>Allows loading of Cherab plasma objects from saved SOLPS simulations.</p></td>
</tr>
</tbody>
</table>
</section>
</section>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="atomic/atomic_data.html" class="btn btn-neutral float-right" title="6. Atomic Data" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="installation_and_structure.html" class="btn btn-neutral" title="4. Installation and Project Structure" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2024, Cherab Team
</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>