-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathwelcome.html
More file actions
311 lines (191 loc) · 11.6 KB
/
welcome.html
File metadata and controls
311 lines (191 loc) · 11.6 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
<!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>1. Welcome — 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="2. Licence" href="licence.html" />
<link rel="prev" title="Cherab’s documentation" href="index.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 current"><a class="current reference internal" href="#">1. Welcome</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#current-development-team">1.1. Current Development Team</a></li>
<li class="toctree-l2"><a class="reference internal" href="#contributors">1.2. Contributors</a></li>
<li class="toctree-l2"><a class="reference internal" href="#project-history">1.3. Project History</a></li>
<li class="toctree-l2"><a class="reference internal" href="#citations">1.4. Citations</a></li>
<li class="toctree-l2"><a class="reference internal" href="#publications">1.5. Publications</a></li>
</ul>
</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"><a class="reference internal" href="available_modules.html">5. Available Packages</a></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">1. </span>Welcome</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/welcome.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="welcome">
<h1><span class="section-number">1. </span>Welcome<a class="headerlink" href="#welcome" title="Permalink to this heading">¶</a></h1>
<p>Welcome to the Cherab project. A python library for forward modelling
diagnostics based on spectroscopic plasma emission.</p>
<p>Please note that these documentation pages are under heavy development
and might not become stable until we have finished migrating the source
code to github.</p>
<p>Contributions from the fusion community are welcome. Further details will be
posted soon on our recommended way of contributing. In the mean time,
interested collaborators should make contact with Dr Carine Giroud
(Project Leader) and Dr Matthew Carr (Core Developer) at
<a class="reference external" href="http://www.ccfe.ac.uk/index.aspx">CCFE, Oxfordshire, UK</a>.</p>
<p>The following authors have contributed to the project:</p>
<section id="current-development-team">
<h2><span class="section-number">1.1. </span>Current Development Team<a class="headerlink" href="#current-development-team" title="Permalink to this heading">¶</a></h2>
<ul class="simple">
<li><p>Matthew Carr (Core Developer)</p></li>
<li><p>Alex Meakins (Architect/Core Developer)</p></li>
<li><p>Alfonso Baciero (Model development)</p></li>
<li><p>Carine Giroud (JET Project Management)</p></li>
</ul>
</section>
<section id="contributors">
<h2><span class="section-number">1.2. </span>Contributors<a class="headerlink" href="#contributors" title="Permalink to this heading">¶</a></h2>
<ul class="simple">
<li><p>Corentin Bertrand (Code)</p></li>
<li><p>Andrea Callarelli (Code)</p></li>
<li><p>Jack Lovell (Code)</p></li>
<li><p>Nick Hawkes (Physics)</p></li>
<li><p>Ephrem Delabie (Physics)</p></li>
<li><p>Andy Meigs (Physics)</p></li>
</ul>
</section>
<section id="project-history">
<h2><span class="section-number">1.3. </span>Project History<a class="headerlink" href="#project-history" title="Permalink to this heading">¶</a></h2>
<p>Prior to the public release, large scale development was performed by the
JET project team. Due to the inclusion of private intellectual property it
was not possible to release the full development history of the code prior
to the github release. For more information on the development of the code
prior to this point, please contact the JET project.</p>
</section>
<section id="citations">
<h2><span class="section-number">1.4. </span>Citations<a class="headerlink" href="#citations" title="Permalink to this heading">¶</a></h2>
<p>Cherab does not yet have a published overview paper, one is planned in the near future.
Until then you can cite:</p>
<p>“M. Carr, A. Meakins, A. Baciero, M. Bernert, A. Callarelli, A. Field, C. Giroud, J. Harrison,
N. Hawkes, S. Henderson and B. Lipschultz, Towards integrated data analysis of divertor
diagnostics with ray-tracing. 44th EPS Conference on Plasma Physics (2017), Belfast,
Northern Ireland UK.”</p>
<p>You can also cite the code base itself:</p>
<p>“Dr Carine Giroud, Dr Alex Meakins, Dr Matthew Carr, Dr Alfonso Baciero, & Mr Corentin Bertrand.
(2018, March 23). Cherab Spectroscopy Modelling Framework (Version v0.1.0).
Zenodo. <a class="reference external" href="http://doi.org/10.5281/zenodo.1206142">http://doi.org/10.5281/zenodo.1206142</a>”</p>
</section>
<section id="publications">
<h2><span class="section-number">1.5. </span>Publications<a class="headerlink" href="#publications" title="Permalink to this heading">¶</a></h2>
<p>Noteable publications on or using the Cherab framework:</p>
<ul class="simple">
<li><p>M. Carr, A. Meakins, A. Baciero, M. Bernert, A. Callarelli, A. Field, C. Giroud,
J. Harrison, N. Hawkes, S. Henderson and B. Lipschultz,
<a class="reference external" href="http://ocs.ciemat.es/EPS2017PAP/pdf/O5.130.pdf">Towards integrated data analysis of divertor diagnostics with ray-tracing</a>.
44th EPS Conference on Plasma Physics (2017), Belfast, Northern Ireland UK.</p></li>
<li><p>M. Carr, A. Meakins, M. Bernert, P. David, C. Giroud, J. Harrison, S. Henderson, B. Lipschultz, F. Reimold,
<a class="reference external" href="https://aip.scitation.org/doi/abs/10.1063/1.5031087">Description of complex viewing geometries of fusion tomography diagnostics by ray-tracing</a>.
Rev. Sci. Instrum. 89, 083506 (2018).</p></li>
</ul>
</section>
</section>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="licence.html" class="btn btn-neutral float-right" title="2. Licence" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="index.html" class="btn btn-neutral" title="Cherab’s documentation" 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>