Skip to content

Commit ee04455

Browse files
RemiLeheRemiLehe
committed
Update documentation
1 parent a64745a commit ee04455

63 files changed

Lines changed: 2249 additions & 193 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎_modules/fbpic/fields/smoothing.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>fbpic.fields.smoothing &mdash; FBPIC 0.26.1 documentation</title>
8+
<title>fbpic.fields.smoothing &mdash; FBPIC 0.27.0 documentation</title>
99
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=03e43079" />
1010
<link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=e59714d7" />
1111

1212

13-
<script src="../../../_static/documentation_options.js?v=eeda5ee3"></script>
13+
<script src="../../../_static/documentation_options.js?v=3b7790a3"></script>
1414
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
1515
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
1616
<script src="../../../_static/js/theme.js"></script>

‎_modules/fbpic/lpa_utils/boosted_frame.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>fbpic.lpa_utils.boosted_frame &mdash; FBPIC 0.26.1 documentation</title>
8+
<title>fbpic.lpa_utils.boosted_frame &mdash; FBPIC 0.27.0 documentation</title>
99
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=03e43079" />
1010
<link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=e59714d7" />
1111

1212

13-
<script src="../../../_static/documentation_options.js?v=eeda5ee3"></script>
13+
<script src="../../../_static/documentation_options.js?v=3b7790a3"></script>
1414
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
1515
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
1616
<script src="../../../_static/js/theme.js"></script>

‎_modules/fbpic/lpa_utils/bunch.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>fbpic.lpa_utils.bunch &mdash; FBPIC 0.26.1 documentation</title>
8+
<title>fbpic.lpa_utils.bunch &mdash; FBPIC 0.27.0 documentation</title>
99
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=03e43079" />
1010
<link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=e59714d7" />
1111

1212

13-
<script src="../../../_static/documentation_options.js?v=eeda5ee3"></script>
13+
<script src="../../../_static/documentation_options.js?v=3b7790a3"></script>
1414
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
1515
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
1616
<script src="../../../_static/js/theme.js"></script>

‎_modules/fbpic/lpa_utils/external_fields.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>fbpic.lpa_utils.external_fields &mdash; FBPIC 0.26.1 documentation</title>
8+
<title>fbpic.lpa_utils.external_fields &mdash; FBPIC 0.27.0 documentation</title>
99
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=03e43079" />
1010
<link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=e59714d7" />
1111

1212

13-
<script src="../../../_static/documentation_options.js?v=eeda5ee3"></script>
13+
<script src="../../../_static/documentation_options.js?v=3b7790a3"></script>
1414
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
1515
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
1616
<script src="../../../_static/js/theme.js"></script>
@@ -208,7 +208,7 @@ <h1>Source code for fbpic.lpa_utils.external_fields</h1><div class="highlight"><
208208
<span class="bp">self</span><span class="o">.</span><span class="n">cpu_func</span> <span class="o">=</span> <span class="n">cpu_compiler</span><span class="p">(</span> <span class="n">func</span> <span class="p">)</span>
209209
<span class="k">if</span> <span class="n">cuda_installed</span><span class="p">:</span>
210210
<span class="c1"># First create a device inline function</span>
211-
<span class="n">inline_func</span> <span class="o">=</span> <span class="n">cuda</span><span class="o">.</span><span class="n">jit</span><span class="p">(</span> <span class="n">func</span><span class="p">,</span> <span class="n">inline</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">device</span><span class="o">=</span><span class="kc">True</span> <span class="p">)</span>
211+
<span class="n">inline_func</span> <span class="o">=</span> <span class="n">cuda</span><span class="o">.</span><span class="n">jit</span><span class="p">(</span> <span class="n">func</span><span class="p">,</span> <span class="n">inline</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">device</span><span class="o">=</span><span class="kc">True</span> <span class="p">)</span>
212212
<span class="c1"># Then create a CUDA kernel and compile it the usual way</span>
213213
<span class="k">def</span><span class="w"> </span><span class="nf">external_field_kernel</span><span class="p">(</span> <span class="n">F</span><span class="p">,</span> <span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">,</span> <span class="n">z</span><span class="p">,</span> <span class="n">t</span><span class="p">,</span> <span class="n">amplitude</span><span class="p">,</span> <span class="n">length_scale</span> <span class="p">):</span>
214214
<span class="n">i</span> <span class="o">=</span> <span class="n">cuda</span><span class="o">.</span><span class="n">grid</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>

‎_modules/fbpic/lpa_utils/laser/laser.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>fbpic.lpa_utils.laser.laser &mdash; FBPIC 0.26.1 documentation</title>
8+
<title>fbpic.lpa_utils.laser.laser &mdash; FBPIC 0.27.0 documentation</title>
99
<link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=03e43079" />
1010
<link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=e59714d7" />
1111

1212

13-
<script src="../../../../_static/documentation_options.js?v=eeda5ee3"></script>
13+
<script src="../../../../_static/documentation_options.js?v=3b7790a3"></script>
1414
<script src="../../../../_static/doctools.js?v=9bcbadda"></script>
1515
<script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
1616
<script src="../../../../_static/js/theme.js"></script>
@@ -192,7 +192,7 @@ <h1>Source code for fbpic.lpa_utils.laser.laser</h1><div class="highlight"><pre>
192192
<span class="n">gamma_boost</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="s1">&#39;direct&#39;</span><span class="p">,</span>
193193
<span class="n">fw_propagating</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">update_spectral</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
194194
<span class="n">z0_antenna</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">v_antenna</span><span class="o">=</span><span class="mf">0.</span> <span class="p">):</span>
195-
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
195+
<span class="w"> </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;</span>
196196
<span class="sd"> Introduce a linearly-polarized, Gaussian laser in the simulation.</span>
197197

198198
<span class="sd"> More precisely, the electric field **near the focal plane**</span>

0 commit comments

Comments
 (0)