-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathinstall.html
More file actions
461 lines (409 loc) · 23.5 KB
/
install.html
File metadata and controls
461 lines (409 loc) · 23.5 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
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
<!DOCTYPE html>
<!-- data-theme below is forced to be "light" but should be changed if we use pydata-theme-sphinx in the future -->
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" data-content_root="./" data-theme="light"> <![endif]-->
<!--[if gt IE 8]><!-->
<html class="no-js" lang="en" data-content_root="./" data-theme="light">
<!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta property="og:title" content="1. Installing spkit" />
<meta property="og:type" content="website" />
<meta property="og:url" content="https://spkit.github.io/install.html" />
<meta property="og:site_name" content="spkit" />
<meta property="og:description" content="There are different ways to install spkit: Install the latest release. This most updated and stable way to install spkit. Spkit is built for cross-plateform support installing with pip should work ..." />
<meta property="og:image" content="https://github.com/spkit/spkit.github.io/blob/master/assets/logo/logo.png" />
<meta property="og:image:alt" content="spkit" />
<meta name="description" content="There are different ways to install spkit: Install the latest release. This most updated and stable way to install spkit. Spkit is built for cross-plateform support installing with pip should work ..." />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>1. Installing spkit — spkit 0.0.9.7 documentation</title>
<link rel="canonical" href="http://spkit.github.io/stable/install.html" />
<link rel="shortcut icon" href="_static/favicon.ico" />
<link rel="stylesheet" href="_static/css/vendor/bootstrap.min.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/copybutton.css" type="text/css" />
<link rel="stylesheet" href="_static/plot_directive.css" type="text/css" />
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Vibur" type="text/css" />
<link rel="stylesheet" href="_static/jupyterlite_sphinx.css" type="text/css" />
<link rel="stylesheet" href="_static/sg_gallery.css" type="text/css" />
<link rel="stylesheet" href="_static/sg_gallery-binder.css" type="text/css" />
<link rel="stylesheet" href="_static/sg_gallery-dataframe.css" type="text/css" />
<link rel="stylesheet" href="_static/sg_gallery-rendered-html.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<script id="documentation_options" data-url_root="./"
src="_static/documentation_options.js"></script>
<script src="_static/js/vendor/jquery-3.6.3.slim.min.js"></script>
<script src="_static/js/details-permalink.js"></script>
<link rel="stylesheet" href="_static/css/vendor/nature_spkit.css" type="text/css" />
</head>
<body>
<!-- ('About us', pathto('about'), ''), -->
<div id="logo-banner">
<div class="logo">
<!-- <a href="%23.html"><img src="_static/spkit_logo.png" alt="spkit logo" border="0" /></a> -->
<!-- <a href="#"><img src="_static/spkit_logo.png" alt="spkit logo" border="0" /></a> -->
<a href="index.html"><img src="_static/spkit_logo.png" alt="spkit logo" border="0" /></a>
</div>
<div class="tags">
<ul>
<li>◈ Easy to use toolkit for signal processing and analysis</li>
<li>◈ More of biomedical signal analysis with visualization</li>
<li>◈ Includes basic machine learning models with visualization</li>
<!-- <li>◈ Open source</li> -->
</ul>
</div>
<div class="banner">
<h2>Signal Processing Toolkit</h2>
<h4><i>Simple and easy to use for signal analysis and predictive analysis</i></h4>
</div>
</div>
<nav id="navbar" class="spk-docs-navbar navbar navbar-expand-md navbar-light bg-light py-0">
<div class="container-fluid spk-docs-container px-0">
<a class="navbar-brand py-0" href="index.html">
<img
class="spk-brand-img"
src="_static/spkit_small_icon_v.png"
alt="logo"/>
</a>
<button
id="spk-navbar-toggler"
class="navbar-toggler"
type="button"
data-toggle="collapse"
data-target="#navbarSupportedContent"
aria-controls="navbarSupportedContent"
aria-expanded="false"
aria-label="Toggle navigation"
>
<span class="navbar-toggler-icon"></span>
</button>
<div class="spk-navbar-collapse collapse navbar-collapse" id="navbarSupportedContent">
<ul class="navbar-nav mr-auto">
<li class="nav-item">
<a class="spk-nav-link nav-link" href="index.html">Home</a>
</li>
<!-- <li class="nav-item">
<a class="spk-nav-link nav-link" href="#">Install</a>
</li> -->
<li class="nav-item">
<a class="spk-nav-link nav-link" href="user_guide.html">User Guide</a>
</li>
<li class="nav-item">
<a class="spk-nav-link nav-link" href="modules/classes.html">API</a>
</li>
<li class="nav-item">
<a class="spk-nav-link nav-link" href="auto_examples/index.html">Examples</a>
</li>
<li class="nav-item">
<a class="spk-nav-link nav-link" href="tutorials/index.html">Tutorials</a>
</li>
<li class="nav-item">
<a class="spk-nav-link nav-link" target="_blank" rel="noopener noreferrer" href="https://github.com/Nikeshbajaj/spkit/discussions?discussions_q=">Discussion Forum</a>
</li>
<li class="nav-item">
<a class="spk-nav-link nav-link" href="about.html">About Us</a>
</li>
<li class="nav-item">
<a class="spk-nav-link nav-link nav-more-item-mobile-items" href="getting_started.html" >Getting Started</a>
</li>
<li class="nav-item">
<a class="spk-nav-link nav-link nav-more-item-mobile-items" href="whats_new/v0.0.9.7.html" >What's new</a>
</li>
<li class="nav-item">
<a class="spk-nav-link nav-link nav-more-item-mobile-items" href="https://github.com/nikeshbajaj/spkit" target="_blank">GitHub</a>
</li>
<li class="nav-item">
<a class="spk-nav-link nav-link nav-more-item-mobile-items" href="https://spkit.github.io/dev/index.html" target="_blank" rel="noopener noreferrer">Development</a>
</li>
<li class="nav-item">
<a class="spk-nav-link nav-link nav-more-item-mobile-items" href="https://github.com/Nikeshbajaj/spkit/discussions?discussions_q=" target="_blank">Get Involved</a>
</li>
<li class="nav-item">
<a class="spk-nav-link nav-link nav-more-item-mobile-items" href="https://spkit.github.io/dev/versions.html" >Other Versions and Download</a>
</li>
<li class="nav-item dropdown nav-more-item-dropdown">
<a class="spk-nav-link nav-link dropdown-toggle" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">More</a>
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
<a class="spk-nav-dropdown-item dropdown-item" href="getting_started.html" >Getting Started</a>
<a class="spk-nav-dropdown-item dropdown-item" href="whats_new/v0.0.9.7.html" >What's new</a>
<a class="spk-nav-dropdown-item dropdown-item" href="https://github.com/nikeshbajaj/spkit" target="_blank">GitHub</a>
<a class="spk-nav-dropdown-item dropdown-item" href="https://spkit.github.io/dev/index.html" target="_blank" rel="noopener noreferrer">Development</a>
<a class="spk-nav-dropdown-item dropdown-item" href="https://github.com/Nikeshbajaj/spkit/discussions?discussions_q=" target="_blank">Get Involved</a>
<a class="spk-nav-dropdown-item dropdown-item" href="https://spkit.github.io/dev/versions.html" >Other Versions and Download</a>
</div>
</li>
</ul>
<div id="searchbox" role="search">
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input class="spk-search-text-input" type="text" name="q" aria-labelledby="searchlabel" />
<input class="spk-search-text-btn" type="submit" value="Go" />
</form>
</div>
</div>
<a class ="nav-more-item-dropdown">
<font size="4em" style="margin: 5px 5px 0px 5px;color:rgb(0, 0, 0)">V</font>
</a>
<div class="nav-item dropdown nav-more-item-dropdown-vs">
<a class="sp-nav-link nav-link dropdown-toggle" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
<font color="black">0.0.9.7 (latest)</font>
</a>
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
<a class="sp-nav-dropdown-item dropdown-item" href="index.html" >0.0.9.7 (latest)</a>
<a class="sp-nav-dropdown-item dropdown-item" href="V/0.0.9.6/index.html" >0.0.9.6</a>
<a class="sp-nav-dropdown-item dropdown-item" href="V/0.0.9.5/index.html" >0.0.9.5</a>
<a class="sp-nav-dropdown-item dropdown-item" href="V/0.0.9.4/index.html" >0.0.9.4</a>
<a class="sp-nav-dropdown-item dropdown-item" href="V/0.0.9.3/index.html" >0.0.9.3</a>
<a class="sp-nav-dropdown-item dropdown-item" href="V/0.0.9.2/index.html" >0.0.9.2</a>
<a class="sp-nav-dropdown-item dropdown-item" href="V/0.0.9.1/index.html" >0.0.9.1</a>
<a class="sp-nav-dropdown-item dropdown-item" href="https://github.com/Nikeshbajaj/spkit/releases" >More</a>
</div>
</div>
</div>
</div>
</nav>
<div class="d-flex" id="spk-doc-wrapper" class="border-right">
<input type="checkbox" name="spk-toggle-checkbox" id="spk-toggle-checkbox">
<label id="spk-sidemenu-toggle" class="spk-btn-toggle-toc btn spk-btn-primary" for="spk-toggle-checkbox">Toggle
Menu</label>
<div id="spk-sidebar-top-logoimg">
<a href="index.html">
<img class="spk-brand-img-side" src="_static/spkit_logo.png" alt="spkit logo" border="0" />
</a>
</div>
<div id="spk-sidebar-wrapper" class="border-right">
<div class="spk-sidebar-top-content">
<div class="alert alert-warning p-1 mb-2" role="alert">
<p class="text-center mb-0">
Please <a class="font-weight-bold" href="about.html#citing">
<string>cite us</string>
</a> if you use the software.
</p>
</div>
<div class="btn-group w-100 mb-2" role="group" aria-label="rellinks">
<a href="modules/data_simulation.html" role="button" class="btn spk-btn-rellink py-1"
spk-rellink-tooltip="8.2. Simulation">Prev</a><a href=" user_guide.html" role="button" class="btn spk-btn-rellink py-1"
spk-rellink-tooltip="User Guide">Up</a>
<a href="auto_examples/index.html" role="button" class="btn spk-btn-rellink py-1"
spk-rellink-tooltip="Examples">Next</a>
</div>
<hr>
</div>
<div class=" spk-sidebar-toc-wrapper">
<!-- <div class="btn-group w-100 mb-2" role="group" aria-label="rellinks">
<a href="modules/data_simulation.html" role="button" class="btn spk-btn-rellink py-1"
spk-rellink-tooltip="8.2. Simulation">Prev</a><a href=" user_guide.html" role="button" class="btn spk-btn-rellink py-1"
spk-rellink-tooltip="User Guide">Up</a>
<a href="auto_examples/index.html" role="button" class="btn spk-btn-rellink py-1"
spk-rellink-tooltip="Examples">Next</a>
</div>
<hr> -->
<div class="spk-sidebar-toc">
<ul>
<li><a class="reference internal" href="#">1. Installing spkit</a><ul>
<li><a class="reference internal" href="#installing-the-latest-release">1.1. Installing the latest release</a></li>
<li><a class="reference internal" href="#troubleshooting">1.2. Troubleshooting</a></li>
<li><a class="reference internal" href="#optional">1.3. <strong>Optional</strong></a></li>
</ul>
</li>
</ul>
</div>
</div>
<br>
<br>
<br>
<br>
<br>
</div>
<div id="spk-page-content-wrapper">
<div class="spk-page-content container-fluid body px-md-3" role="main">
<section id="installing-spkit">
<span id="installation-instructions"></span><h1><span class="section-number">1. </span>Installing spkit<a class="headerlink" href="#installing-spkit" title="Link to this heading">¶</a></h1>
<p>There are different ways to install spkit:</p>
<blockquote>
<div><ul class="simple">
<li><p><a class="reference internal" href="#install-official-release"><span class="std std-ref">Install the latest release</span></a>. This most
updated and stable way to install spkit. Spkit is built for cross-plateform support
installing with <code class="docutils literal notranslate"><span class="pre">pip</span></code> should work for all the platforms and envrionments.</p></li>
<li><p>Installing instructions ara standard as for most of python libraries.</p></li>
</ul>
</div></blockquote>
<section id="installing-the-latest-release">
<span id="install-official-release"></span><h2><span class="section-number">1.1. </span>Installing the latest release<a class="headerlink" href="#installing-the-latest-release" title="Link to this heading">¶</a></h2>
<div class="install">
<strong>Operating System</strong>
<input type="radio" name="os" id="quickstart-win" checked>
<label for="quickstart-win">Windows</label>
<input type="radio" name="os" id="quickstart-mac">
<label for="quickstart-mac">macOS</label>
<input type="radio" name="os" id="quickstart-lin">
<label for="quickstart-lin">Linux</label><br />
<strong>Packager</strong>
<input type="radio" name="packager" id="quickstart-pip" checked>
<label for="quickstart-pip">pip</label>
</span><div>
<span class="spk-expandable" data-packager="pip" data-os="windows">Install the 64bit version of Python 3, for instance from <a href="https://www.python.org/">https://www.python.org</a>.</span
><span class="spk-expandable" data-packager="pip" data-os="mac">Install Python 3 using <a href="https://brew.sh/">homebrew</a> (<code>brew install python</code>) or by manually installing the package from <a href="https://www.python.org">https://www.python.org</a>.</span
><span class="spk-expandable" data-packager="pip" data-os="linux">Install python3 and python3-pip using the package manager of the Linux Distribution.</span
><span class="spk-expandable" data-packager="conda"
>Install conda using the <a href="https://docs.conda.io/projects/conda/en/latest/user-guide/install/">Anaconda or miniconda</a>
installers or the <a href="https://github.com/conda-forge/miniforge#miniforge">miniforge</a> installers
(no administrator permission required for any of those).</span>
</div><p>Then run:</p>
<div class="highlight">
<pre class="spk-expandable" data-packager="pip" data-os="linux" data-venv="no"
><span>pip3 install -U spkit</span></pre>
<pre class="spk-expandable" data-packager="pip" data-os="windows" data-venv="no"
><span>pip install -U spkit</span></pre>
<pre class="spk-expandable" data-packager="pip" data-os="mac" data-venv="no"
><span>pip install -U spkit</span></pre>
<pre class="spk-expandable" data-packager="pip" data-os="linux" data-venv=""
><span>python3 -m venv spkit-venv</span>
<span>source spkit-venv/bin/activate</span>
<span>pip3 install -U spkit</span></pre>
<pre class="spk-expandable" data-packager="pip" data-os="windows" data-venv=""
><span>python -m venv spkit-venv</span>
<span>spkit-venv\Scripts\activate</span>
<span>pip install -U spkit</span></pre>
<pre class="spk-expandable" data-packager="pip" data-os="mac" data-venv=""
><span>python -m venv spkit-venv</span>
<span>source spkit-venv/bin/activate</span>
<span>pip install -U spkit</span></pre>
<pre class="spk-expandable" data-packager="conda"
><span>conda create -n spkit-env -c conda-forge spkit</span>
<span>conda activate spkit-env</span></pre>
</div><p>In order to check your installation you can use</p>
<div class="highlight">
<pre class="spk-expandable" data-packager="pip" data-os="linux" data-venv="no"
><span>python3 -m pip show spkit # to see which version and where spkit is installed</span>
<span>python3 -m pip freeze # to see all packages installed in the active virtualenv</span>
<span>python3 -c "import spkit; spkit.__version__"</span></pre>
<pre class="spk-expandable" data-packager="pip" data-os="windows" data-venv="no"
><span>python -m pip show spkit # to see which version and where spkit is installed</span>
<span>python -m pip freeze # to see all packages installed in the active virtualenv</span>
<span>python -c "import spkit; spkit.__version__"</span></pre>
<pre class="spk-expandable" data-packager="pip" data-os="mac" data-venv="no"
><span>python -m pip show spkit # to see which version and where spkit is installed</span>
<span>python -m pip freeze # to see all packages installed in the active virtualenv</span>
<span>python -c "import spkit; spkit.__version__"</span></pre>
<pre class="spk-expandable" data-packager="pip" data-venv=""
><span>python -m pip show spkit # to see which version and where spkit is installed</span>
<span>python -m pip freeze # to see all packages installed in the active virtualenv</span>
<span>python -c "import spkit; spkit.__version__"</span></pre>
<pre class="spk-expandable" data-packager="conda"
><span>conda list spkit # to see which spkit version is installed</span>
<span>conda list # to see all packages installed in the active conda environment</span>
<span>python -c "import spkit; spkit.__version__"</span></pre>
</div><p>Installing with <strong>conda</strong> or <strong>conda-forge</strong> is in pipeline. Once that is comleted, the instructions
will be shared here.</p>
</section>
<section id="troubleshooting">
<h2><span class="section-number">1.2. </span>Troubleshooting<a class="headerlink" href="#troubleshooting" title="Link to this heading">¶</a></h2>
<p>In some cases, installing spkit might show the conflicts in dependencies. For this reason,
one of the requirement is <code class="docutils literal notranslate"><span class="pre">scikit-learn</span></code>. Installing <code class="docutils literal notranslate"><span class="pre">scikit-learn</span></code> prior to spkit resolves
may of the possible conflicts.</p>
<p>In case, you are not using <code class="docutils literal notranslate"><span class="pre">scikit-learn</span></code>, install following required libraries that will set-up
the prerequites</p>
<ul class="simple">
<li><p>numpy>1.8</p></li>
<li><p>pandas</p></li>
<li><p>scipy</p></li>
<li><p>scikit-learn</p></li>
<li><p>python-picard</p></li>
<li><p>matplotlib</p></li>
<li><p>PyWavelets</p></li>
<li><p>pylfsr</p></li>
<li><p>h5py</p></li>
<li><p>seaborn</p></li>
<li><p>joblib</p></li>
<li><p>phyaat</p></li>
</ul>
<p>Use numpy<2.0.0, some functions are not compatible with numpy>=2.0</p>
</section>
<section id="optional">
<h2><span class="section-number">1.3. </span><strong>Optional</strong><a class="headerlink" href="#optional" title="Link to this heading">¶</a></h2>
<p>There are a very few functions that require other libraries they are not included in requirements.
Here is a list of additional libraries for all the functions.</p>
<ul class="simple">
<li><p>pyedflib for <a class="reference internal" href="modules/generated/spkit.io.read_bdf.html#spkit.io.read_bdf" title="spkit.io.read_bdf"><code class="xref py py-func docutils literal notranslate"><span class="pre">spkit.io.read_bdf</span></code></a></p></li>
<li><p>cvxpy for <a class="reference internal" href="modules/generated/spkit.regularised_period_estimation.html#spkit.regularised_period_estimation" title="spkit.regularised_period_estimation"><code class="xref py py-func docutils literal notranslate"><span class="pre">spkit.regularised_period_estimation</span></code></a> only if argument <code class="docutils literal notranslate"><span class="pre">cvxsol=True</span></code></p></li>
</ul>
</section>
</section>
</div>
<div class="container">
<footer class="spk-content-footer">
© 2019 - 2024, spkit developers (BSD License).
<!-- -->
<!-- <a href="_sources/install.rst.txt" rel="nofollow">Show this page source</a> -->
<!-- -->
</footer>
</div>
<div class="container-fluid py-3">
<hr>
<div class="container spk-landing-container">
<a class="spk-footer-funding-link" href="about.html">
<div class="text-center">
<p class="mt-2">
Spkit developed in collabration with other projects:
</p>
<a href="https://PhyAAt.github.io" target="_blank"><img class="spk-footer-funding-logo" src="_static/phyaat_logo.png" title="PhyAAt"></a>
<a href="https://PyLFSR.github.io" target="_blank"><img class="spk-footer-funding-logo" src="_static/pylfsr_logo.png" title="PyLFSR" ></a>
<a href="https://MLEndDatasets.github.io" target="_blank"><img class="spk-footer-funding-logo" src="_static/mlend_logo.png" title="MLEnd-Datasets" ></a>
<a href='https://clustrmaps.com/site/1b9h1' title='Visit tracker'><img src='//clustrmaps.com/map_v2.png?cl=46b0cb&w=a&t=n&d=eQr8xSBiKVuSq6m0psK-Ey9TZ7rLzjRX-MpatyfFGQI&co=ffffff&ct=000000' width="30"/></a>
</div>
</a>
<!-- <div style="width:3px;">
<a href="https://clustrmaps.com/site/1b9h1" title="Visit tracker"><img src="//www.clustrmaps.com/map_v2.png?d=eQr8xSBiKVuSq6m0psK-Ey9TZ7rLzjRX-MpatyfFGQI&cl=ffffff" /></a>
</div> -->
</div>
</div>
</div>
</div>
<script src="_static/js/vendor/bootstrap.min.js"></script>
<script>
window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date;
ga('create', 'UA-59299155-3', 'auto');
ga('set', 'anonymizeIp', true);
ga('send', 'pageview');
</script>
<script async src='https://www.google-analytics.com/analytics.js'></script>
<!--
<script defer data-domain="scikit-learn.org" src="https://views.scientific-python.org/js/script.js">
</script>
-->
<script src="_static/clipboard.min.js"></script>
<script src="_static/copybutton.js"></script>
<script>
$(document).ready(function() {
/* Add a [>>>] button on the top-right corner of code samples to hide
* the >>> and ... prompts and the output and thus make the code
* copyable. */
var div = $('.highlight-python .highlight,' +
'.highlight-python3 .highlight,' +
'.highlight-pycon .highlight,' +
'.highlight-default .highlight')
var pre = div.find('pre');
// get the styles from the current theme
pre.parent().parent().css('position', 'relative');
// create and add the button to all the code blocks that contain >>>
div.each(function(index) {
var jthis = $(this);
// tracebacks (.gt) contain bare text elements that need to be
// wrapped in a span to work with .nextUntil() (see later)
jthis.find('pre:has(.gt)').contents().filter(function() {
return ((this.nodeType == 3) && (this.data.trim().length > 0));
}).wrap('<span>');
});
/*** Add permalink buttons next to glossary terms ***/
$('dl.glossary > dt[id]').append(function() {
return ('<a class="headerlink" href="#' +
this.getAttribute('id') +
'" title="Permalink to this term">¶</a>');
});
});
</script>
<script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-chtml.js"></script>
</body>
</html>