-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
234 lines (216 loc) · 11.9 KB
/
index.html
File metadata and controls
234 lines (216 loc) · 11.9 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
<!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 twissed’s documentation! — twissed 2.1.1 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<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/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Tutorial for beam analysis" href="pages/twissed_beam.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">
twissed
</a>
<div class="version">
2.1.1
</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" 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">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="pages/twissed_beam.html">Tutorial for beam analysis</a></li>
<li class="toctree-l1"><a class="reference internal" href="pages/physics.html">Useful formulas</a></li>
<li class="toctree-l1"><a class="reference internal" href="pages/stepclass.html">Step class</a></li>
<li class="toctree-l1"><a class="reference internal" href="pages/plotstepclass.html">Plotting with the Step class</a></li>
<li class="toctree-l1"><a class="reference internal" href="pages/io.html">Read and write data</a></li>
<li class="toctree-l1"><a class="reference internal" href="pages/launcher.html">Automatic launchers and runs</a></li>
<li class="toctree-l1"><a class="reference internal" href="pages/noweight.html">No weight methods</a></li>
<li class="toctree-l1"><a class="reference internal" href="pages/todo.html">Todo</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="#">twissed</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 twissed’s 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">
<section id="welcome-to-twissed-s-documentation">
<h1>Welcome to twissed’s documentation!<a class="headerlink" href="#welcome-to-twissed-s-documentation" title="Permalink to this heading">¶</a></h1>
<p><a class="reference external" href="https://pypi.python.org/pypi/fbpic"><img alt="pypi version" src="https://img.shields.io/pypi/v/fbpic.svg" /></a> <a class="reference external" href="LICENSE"><img alt="License" src="https://img.shields.io/badge/License-MIT-blue" /></a> <img alt="Release" src="https://img.shields.io/github/release-date/Twissed/twissed" /></p>
<section id="overview">
<h2>Overview<a class="headerlink" href="#overview" title="Permalink to this heading">¶</a></h2>
<p>Twissed is a Python package 🐍 that provides a large number of data
analysis tools for <strong>beam dynamics</strong> and <strong>laser wakefield
acceleration</strong> simulations.</p>
<p>Twissed is multi-OS (Windows, Linux, Mac) and can be easily installed
everywhere thanks to its low number of dependencies (numpy, pandas,
scipy, h5py). It is especially made to run on HPC clusters.</p>
<p>Twissed can read and write data from several sources</p>
<ul class="simple">
<li><p><a class="reference external" href="https://fbpic.github.io/">FBPIC</a></p></li>
<li><p><a class="reference external" href="https://smileipic.github.io/Smilei/">Smilei</a></p></li>
<li><p><a class="reference external" href="https://smileipic.github.io/Smilei/">Smilei via happi package</a></p></li>
<li><p><a class="reference external" href="https://dacm-logiciels.fr/">TraceWin</a></p></li>
<li><p><cite>Astra</cite></p></li>
</ul>
</section>
<section id="installation">
<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this heading">¶</a></h2>
<section id="requirement">
<h3>Requirement<a class="headerlink" href="#requirement" title="Permalink to this heading">¶</a></h3>
<p>Python 3.7 or greater</p>
<ul class="simple">
<li><p>Mandatory packages: numpy pandas scipy h5py.</p></li>
<li><p>Optional packages: matplotlib seaborn happi(smilei)</p></li>
</ul>
</section>
<section id="installation-1">
<span id="id1"></span><h3>Installation<a class="headerlink" href="#installation-1" title="Permalink to this heading">¶</a></h3>
<ul class="simple">
<li><p>Mac OS/Linux</p></li>
</ul>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>twissed
</pre></div>
</div>
<ul class="simple">
<li><p>Windows</p></li>
</ul>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>py<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>twissed
</pre></div>
</div>
<section id="with-the-download-of-the-project">
<h4>With the download of the project<a class="headerlink" href="#with-the-download-of-the-project" title="Permalink to this heading">¶</a></h4>
<ul class="simple">
<li><p>Mac OS/Linux</p></li>
</ul>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/Twissed/twissed.git
python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span>.
</pre></div>
</div>
<ul class="simple">
<li><p>Windows</p></li>
</ul>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/Twissed/twissed.git
py<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span>.
</pre></div>
</div>
</section>
</section>
</section>
<section id="tutorial">
<h2>Tutorial<a class="headerlink" href="#tutorial" title="Permalink to this heading">¶</a></h2>
<p>Examples Twissed use are available at
<a class="reference external" href="https://github.com/Twissed/Twissed_tutorial">https://github.com/Twissed/Twissed_tutorial</a></p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This project is under active development.</p>
</div>
</section>
</section>
<section id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this heading">¶</a></h1>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
<section id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this heading">¶</a></h2>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="pages/twissed_beam.html">Tutorial for beam analysis</a></li>
<li class="toctree-l1"><a class="reference internal" href="pages/physics.html">Useful formulas</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pages/physics.html#statistics">Statistics</a></li>
<li class="toctree-l2"><a class="reference internal" href="pages/physics.html#physics">Physics</a></li>
<li class="toctree-l2"><a class="reference internal" href="pages/physics.html#helpful">Helpful</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pages/stepclass.html">Step class</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pages/stepclass.html#metadata">Metadata</a></li>
<li class="toctree-l2"><a class="reference internal" href="pages/stepclass.html#introduction-ot-step">Introduction ot Step</a></li>
<li class="toctree-l2"><a class="reference internal" href="pages/stepclass.html#functions">Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="pages/stepclass.html#beam-functions">Beam functions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pages/plotstepclass.html">Plotting with the Step class</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pages/plotstepclass.html#hist1d-and-hist2d-functions">hist1D and hist2D functions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pages/io.html">Read and write data</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pages/io.html#twissed.read_dst"><code class="docutils literal notranslate"><span class="pre">read_dst()</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pages/launcher.html">Automatic launchers and runs</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pages/launcher.html#run-class">Run class</a></li>
<li class="toctree-l2"><a class="reference internal" href="pages/launcher.html#classic-launcher">Classic launcher</a></li>
<li class="toctree-l2"><a class="reference internal" href="pages/launcher.html#genetic-algorithm-launcher">Genetic Algorithm launcher</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pages/noweight.html">No weight methods</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pages/noweight.html#zero-order-methods">Zero order methods</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pages/todo.html">Todo</a></li>
</ul>
</div>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="pages/twissed_beam.html" class="btn btn-neutral float-right" title="Tutorial for beam analysis" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2024, Damien Minenna.</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>