-
Notifications
You must be signed in to change notification settings - Fork 2
/
index.html
703 lines (519 loc) · 36.8 KB
/
index.html
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
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
<!DOCTYPE html>
<html lang="en" data-content_root="./" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta content="Landing page of the HyperSpy project with information on the main features and characteristics, related projects extending the functionality, latest news and possibilities to get support and learn about the project. HyperSpy is an open-source python project to ease analysis and visualization of multi-dimensional datasets" lang="en" name="description" xml:lang="en" />
<meta content="HyperSpy, python, numpy, scipy, physics, materials science, semiconductors, scientific data analysis, spectral imaging, spectrum image, hyperspectral, hyperspectrum, hyperspectral imaging, multidimensional, multidimensional data, multi-dimensional data, analysis, visualization, quantification, curve fitting, machine learning, denoising, principal component analysis, RosettaSciIO, eXSpy, pyxem, kikuchipy, LumiSpy, Atomap, holoSpy, ParticleSpy, HyperSpyUI, microscopy, electron microscopy, EELS, electron energy loss spectroscopy, EDX, EDS, energy-disperspive X-ray spectroscopy, 4D-STEM, scanning transmission electron microscopy, EBSD, energy backscatter diffraction, high-resolution electron microscopy, spectroscopy, luminescence spectroscopy, CL, cathodoluminescence, PL, photoluminescence, electron holography, off-axis electron holography, segmentation, particle analysis" name="keywords" />
<link href="_static/hyperspy_logo.ico" rel="icon" type="image/x-icon">
<title>Home — HyperSpy Website</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
</script>
<!--
this give us a css class that will be invisible only if js is disabled
-->
<noscript>
<style>
.pst-js-only { display: none !important; }
</style>
</noscript>
<!-- Loaded before other Sphinx assets -->
<link href="_static/styles/theme.css?digest=26a4bc78f4c0ddb94549" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=26a4bc78f4c0ddb94549" rel="stylesheet" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="_static/sphinx-design.min.css?v=95c83b7e" />
<link rel="stylesheet" type="text/css" href="_static/frontpage.css?v=c42569aa" />
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=aa7994dc" />
<!-- So that users can add custom icons -->
<script src="_static/scripts/fontawesome.js?digest=26a4bc78f4c0ddb94549"></script>
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549" />
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/design-tabs.js?v=f930bc37"></script>
<script async="async" src="https://www.googletagmanager.com/gtag/js?id=G-B0XD0GTW1M"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){ dataLayer.push(arguments); }
gtag('js', new Date());
gtag('config', 'G-B0XD0GTW1M');
</script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){ dataLayer.push(arguments); }
gtag('js', new Date());
gtag('config', 'G-B0XD0GTW1M');
</script>
<script>DOCUMENTATION_OPTIONS.pagename = 'index';</script>
<link rel="canonical" href="https://hyperspy.org/index.html" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="About" href="sections/about.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="" />
</head>
<body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">
<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>
<div id="pst-scroll-pixel-helper"></div>
<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>Back to top</button>
<dialog id="pst-search-dialog">
<form class="bd-search d-flex align-items-center"
action="search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
placeholder="Search the docs ..."
aria-label="Search the docs ..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form>
</dialog>
<div class="pst-async-banner-revealer d-none">
<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
</div>
<aside class="bd-header-announcement" aria-label="Announcement">
<div class="bd-header-announcement__content"><font size='+1'><b><a href='https://hyperspy.org/hyperspy-doc/v2.0/changes.html'>HyperSpy 2.0 released!</a></b></font></div>
</aside>
<header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
<div class="bd-header__inner bd-page-width">
<button class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation">
<span class="fa-solid fa-bars"></span>
</button>
<div class="col-lg-3 navbar-header-items__start">
<div class="navbar-item">
<a class="navbar-brand logo" href="#">
<img src="_static/hyperspy-banner-small-light.svg" class="logo__image only-light" alt="HyperSpy"/>
<img src="_static/hyperspy-banner-small-dark.svg" class="logo__image only-dark pst-js-only" alt="HyperSpy"/>
</a></div>
</div>
<div class="col-lg-9 navbar-header-items">
<div class="me-auto navbar-header-items__center">
<div class="navbar-item">
<nav>
<ul class="bd-navbar-elements navbar-nav">
<li class="nav-item ">
<a class="nav-link nav-internal" href="sections/about.html">
About
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="news/index.html">
News
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-external" href="https://hyperspy.org/hyperspy-doc/current">
Documentation
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-external" href="https://hyperspy.org/hyperspy-doc/current/user_guide/install.html">
Install
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-external" href="https://hyperspy.org/jupyterlite-hyperspy">
Try
</a>
</li>
</ul>
</nav></div>
</div>
<div class="navbar-header-items__end">
<div class="navbar-item">
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button></div>
<div class="navbar-item"><ul class="navbar-icon-links"
aria-label="Icon Links">
<li class="nav-item">
<a href="https://github.com/hyperspy" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i>
<span class="sr-only">GitHub</span></a>
</li>
<li class="nav-item">
<a href="https://gitter.im/hyperspy/hyperspy" title="Gitter" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fab fa-gitter fa-lg" aria-hidden="true"></i>
<span class="sr-only">Gitter</span></a>
</li>
</ul></div>
</div>
</div>
</div>
</header>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<dialog id="pst-primary-sidebar-modal"></dialog>
<div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar hide-on-wide">
<div class="sidebar-header-items sidebar-primary__section">
<div class="sidebar-header-items__center">
<div class="navbar-item">
<nav>
<ul class="bd-navbar-elements navbar-nav">
<li class="nav-item ">
<a class="nav-link nav-internal" href="sections/about.html">
About
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="news/index.html">
News
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-external" href="https://hyperspy.org/hyperspy-doc/current">
Documentation
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-external" href="https://hyperspy.org/hyperspy-doc/current/user_guide/install.html">
Install
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-external" href="https://hyperspy.org/jupyterlite-hyperspy">
Try
</a>
</li>
</ul>
</nav></div>
</div>
<div class="sidebar-header-items__end">
<div class="navbar-item">
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button></div>
<div class="navbar-item"><ul class="navbar-icon-links"
aria-label="Icon Links">
<li class="nav-item">
<a href="https://github.com/hyperspy" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i>
<span class="sr-only">GitHub</span></a>
</li>
<li class="nav-item">
<a href="https://gitter.im/hyperspy/hyperspy" title="Gitter" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fab fa-gitter fa-lg" aria-hidden="true"></i>
<span class="sr-only">Gitter</span></a>
</li>
</ul></div>
</div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
</div>
<div id="rtd-footer-container"></div>
</div>
<main id="main-content" class="bd-main" role="main">
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article d-print-none"></div>
<div id="searchbox"></div>
<article class="bd-article">
<div class="toctree-wrapper compound">
</div>
<div class="sd-container-fluid sd-sphinx-override sd-mb-4 docutils">
<div class="sd-row sd-row-cols-1 sd-row-cols-xs-1 sd-row-cols-sm-2 sd-row-cols-md-2 sd-row-cols-lg-2 docutils">
<div class="sd-col sd-d-flex-column sd-col-12 sd-col-xs-12 sd-col-sm-5 sd-col-md-5 sd-col-lg-5 sd-align-major-center docutils">
<a class="logo mainlogo only-light reference internal image-reference" href="_images/hyperspy_light_banner.svg"><img alt="HyperSpy logo" class="logo mainlogo only-light align-center" src="_images/hyperspy_light_banner.svg" style="width: 500px;" />
</a>
<a class="logo mainlogo only-dark reference internal image-reference" href="_images/hyperspy_dark_banner.svg"><img alt="HyperSpy logo" class="logo mainlogo only-dark align-center" src="_images/hyperspy_dark_banner.svg" style="width: 500px;" />
</a>
</div>
<div class="sd-col sd-d-flex-column sd-col-12 sd-col-xs-12 sd-col-sm-7 sd-col-md-7 sd-col-lg-7 docutils">
<div class="sd-text-left sd-font-weight-bold sd-fs-4 sd-width-50 docutils">
<p>Open source Python framework for exploring, visualizing and analyzing
multi-dimensional data</p>
</div>
<p><a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-primary sd-shadow-sm sd-rounded-3 reference external" href="https://hyperspy.org/hyperspy-doc/current/user_guide/index.html"><span><span class="fa fa-rocket"></span> Get Started</span></a></p>
</div>
</div>
</div>
<div class="sd-container-fluid sd-sphinx-override sd-mb-4 docutils">
<div class="sd-row sd-row-cols-2 sd-row-cols-xs-2 sd-row-cols-sm-3 sd-row-cols-md-3 sd-row-cols-lg-3 sd-g-4 sd-g-xs-4 sd-g-sm-4 sd-g-md-4 sd-g-lg-4 docutils">
<div class="sd-col sd-d-flex-row docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm docutils">
<div class="sd-card-header docutils">
<p class="sd-card-text"><svg version="1.1" width="2.0em" height="2.0em" class="sd-octicon sd-octicon-eye sd-text-info" viewBox="0 0 24 24" aria-hidden="true"><path d="M15.5 12a3.5 3.5 0 1 1-7 0 3.5 3.5 0 0 1 7 0Z"></path><path d="M12 3.5c3.432 0 6.124 1.534 8.054 3.241 1.926 1.703 3.132 3.61 3.616 4.46a1.6 1.6 0 0 1 0 1.598c-.484.85-1.69 2.757-3.616 4.461-1.929 1.706-4.622 3.24-8.054 3.24-3.432 0-6.124-1.534-8.054-3.24C2.02 15.558.814 13.65.33 12.8a1.6 1.6 0 0 1 0-1.598c.484-.85 1.69-2.757 3.616-4.462C5.875 5.034 8.568 3.5 12 3.5ZM1.633 11.945a.115.115 0 0 0-.017.055c.001.02.006.039.017.056.441.774 1.551 2.527 3.307 4.08C6.691 17.685 9.045 19 12 19c2.955 0 5.31-1.315 7.06-2.864 1.756-1.553 2.866-3.306 3.307-4.08a.111.111 0 0 0 .017-.056.111.111 0 0 0-.017-.056c-.441-.773-1.551-2.527-3.307-4.08C17.309 6.315 14.955 5 12 5 9.045 5 6.69 6.314 4.94 7.865c-1.756 1.552-2.866 3.306-3.307 4.08Z"></path></svg> Visualization</p>
</div>
<div class="sd-card-body docutils">
<p class="sd-card-text">Interactive <a class="reference external" href="https://hyperspy.org/hyperspy-doc/current/user_guide/visualisation.html#visualization-label" title="(in HyperSpy v2.2)"><span class="xref std std-ref">visualization tools</span></a>
for multi-dimensional spectra and images.</p>
</div>
</div>
</div>
<div class="sd-col sd-d-flex-row docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm docutils">
<div class="sd-card-header docutils">
<p class="sd-card-text"><svg version="1.1" width="2.0em" height="2.0em" class="sd-octicon sd-octicon-gear sd-text-info" viewBox="0 0 24 24" aria-hidden="true"><path d="M16 12a4 4 0 1 1-8 0 4 4 0 0 1 8 0Zm-1.5 0a2.5 2.5 0 1 0-5 0 2.5 2.5 0 0 0 5 0Z"></path><path d="M12 1c.266 0 .532.009.797.028.763.055 1.345.617 1.512 1.304l.352 1.45c.019.078.09.171.225.221.247.089.49.19.728.302.13.061.246.044.315.002l1.275-.776c.603-.368 1.411-.353 1.99.147.402.349.78.726 1.128 1.129.501.578.515 1.386.147 1.99l-.776 1.274c-.042.069-.058.185.002.315.112.238.213.481.303.728.048.135.142.205.22.225l1.45.352c.687.167 1.249.749 1.303 1.512.038.531.038 1.063 0 1.594-.054.763-.616 1.345-1.303 1.512l-1.45.352c-.078.019-.171.09-.221.225-.089.248-.19.491-.302.728-.061.13-.044.246-.002.315l.776 1.275c.368.603.353 1.411-.147 1.99-.349.402-.726.78-1.129 1.128-.578.501-1.386.515-1.99.147l-1.274-.776c-.069-.042-.185-.058-.314.002a8.606 8.606 0 0 1-.729.303c-.135.048-.205.142-.225.22l-.352 1.45c-.167.687-.749 1.249-1.512 1.303-.531.038-1.063.038-1.594 0-.763-.054-1.345-.616-1.512-1.303l-.352-1.45c-.019-.078-.09-.171-.225-.221a8.138 8.138 0 0 1-.728-.302c-.13-.061-.246-.044-.315-.002l-1.275.776c-.603.368-1.411.353-1.99-.147-.402-.349-.78-.726-1.128-1.129-.501-.578-.515-1.386-.147-1.99l.776-1.274c.042-.069.058-.185-.002-.314a8.606 8.606 0 0 1-.303-.729c-.048-.135-.142-.205-.22-.225l-1.45-.352c-.687-.167-1.249-.749-1.304-1.512a11.158 11.158 0 0 1 0-1.594c.055-.763.617-1.345 1.304-1.512l1.45-.352c.078-.019.171-.09.221-.225.089-.248.19-.491.302-.728.061-.13.044-.246.002-.315l-.776-1.275c-.368-.603-.353-1.411.147-1.99.349-.402.726-.78 1.129-1.128.578-.501 1.386-.515 1.99-.147l1.274.776c.069.042.185.058.315-.002.238-.112.481-.213.728-.303.135-.048.205-.142.225-.22l.352-1.45c.167-.687.749-1.249 1.512-1.304C11.466 1.01 11.732 1 12 1Zm-.69 1.525c-.055.004-.135.05-.161.161l-.353 1.45a1.832 1.832 0 0 1-1.172 1.277 7.147 7.147 0 0 0-.6.249 1.833 1.833 0 0 1-1.734-.074l-1.274-.776c-.098-.06-.186-.036-.228 0a9.774 9.774 0 0 0-.976.976c-.036.042-.06.131 0 .228l.776 1.274c.314.529.342 1.18.074 1.734a7.147 7.147 0 0 0-.249.6 1.831 1.831 0 0 1-1.278 1.173l-1.45.351c-.11.027-.156.107-.16.162a9.63 9.63 0 0 0 0 1.38c.004.055.05.135.161.161l1.45.353a1.832 1.832 0 0 1 1.277 1.172c.074.204.157.404.249.6.268.553.24 1.204-.074 1.733l-.776 1.275c-.06.098-.036.186 0 .228.301.348.628.675.976.976.042.036.131.06.228 0l1.274-.776a1.83 1.83 0 0 1 1.734-.075c.196.093.396.176.6.25a1.831 1.831 0 0 1 1.173 1.278l.351 1.45c.027.11.107.156.162.16a9.63 9.63 0 0 0 1.38 0c.055-.004.135-.05.161-.161l.353-1.45a1.834 1.834 0 0 1 1.172-1.278 6.82 6.82 0 0 0 .6-.248 1.831 1.831 0 0 1 1.733.074l1.275.776c.098.06.186.036.228 0 .348-.301.675-.628.976-.976.036-.042.06-.131 0-.228l-.776-1.275a1.834 1.834 0 0 1-.075-1.733c.093-.196.176-.396.25-.6a1.831 1.831 0 0 1 1.278-1.173l1.45-.351c.11-.027.156-.107.16-.162a9.63 9.63 0 0 0 0-1.38c-.004-.055-.05-.135-.161-.161l-1.45-.353c-.626-.152-1.08-.625-1.278-1.172a6.576 6.576 0 0 0-.248-.6 1.833 1.833 0 0 1 .074-1.734l.776-1.274c.06-.098.036-.186 0-.228a9.774 9.774 0 0 0-.976-.976c-.042-.036-.131-.06-.228 0l-1.275.776a1.831 1.831 0 0 1-1.733.074 6.88 6.88 0 0 0-.6-.249 1.835 1.835 0 0 1-1.173-1.278l-.351-1.45c-.027-.11-.107-.156-.162-.16a9.63 9.63 0 0 0-1.38 0Z"></path></svg> Analysis</p>
</div>
<div class="sd-card-body docutils">
<p class="sd-card-text">Easy access to analytical tools that exploit the multi-dimensionality
of datasets, including <a class="reference external" href="https://hyperspy.org/hyperspy-doc/current/user_guide/model/index.html#model-label" title="(in HyperSpy v2.2)"><span class="xref std std-ref">curve fitting</span></a>
and <a class="reference external" href="https://hyperspy.org/hyperspy-doc/current/user_guide/mva/index.html#ml-label" title="(in HyperSpy v2.2)"><span class="xref std std-ref">blind source separation</span></a>.</p>
</div>
</div>
</div>
<div class="sd-col sd-d-flex-row docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm docutils">
<div class="sd-card-header docutils">
<p class="sd-card-text"><svg version="1.1" width="2.0em" height="2.0em" class="sd-octicon sd-octicon-table sd-text-info" viewBox="0 0 24 24" aria-hidden="true"><path d="M2 3.75C2 2.784 2.784 2 3.75 2h16.5c.966 0 1.75.784 1.75 1.75v16.5A1.75 1.75 0 0 1 20.25 22H3.75A1.75 1.75 0 0 1 2 20.25ZM9 9v11.5h11.25a.25.25 0 0 0 .25-.25V9Zm11.5-1.5V3.75a.25.25 0 0 0-.25-.25H9v4ZM3.5 9v11.25c0 .138.112.25.25.25H7.5V9Zm4-1.5v-4H3.75a.25.25 0 0 0-.25.25V7.5Z"></path></svg> Named and Scaled Axes</p>
</div>
<div class="sd-card-body docutils">
<p class="sd-card-text"><a class="reference external" href="https://hyperspy.org/hyperspy-doc/current/user_guide/axes.html#axes-handling" title="(in HyperSpy v2.2)"><span class="xref std std-ref">Two families of axes</span></a>: <em>signal</em> and
<em>navigation</em> with powerful numpy-style indexing mechanism and support for
non-uniform axes.</p>
</div>
</div>
</div>
<div class="sd-col sd-d-flex-row docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm docutils">
<div class="sd-card-header docutils">
<p class="sd-card-text"><svg version="1.1" width="2.0em" height="2.0em" class="sd-octicon sd-octicon-zap sd-text-info" viewBox="0 0 24 24" aria-hidden="true"><path d="M15.716 1.329a1.341 1.341 0 0 1 2.109 1.55L15.147 9h4.161c1.623 0 2.372 2.016 1.143 3.075L8.102 22.721a1.148 1.148 0 0 1-1.81-1.317L8.996 15H4.674c-1.619 0-2.37-2.008-1.148-3.07l12.19-10.6Zm.452 1.595L4.51 13.061a.25.25 0 0 0 .164.439h5.45a.749.749 0 0 1 .692 1.041l-2.559 6.066 11.215-9.668a.25.25 0 0 0-.164-.439H14a.75.75 0 0 1-.687-1.05Z"></path></svg> Performance</p>
</div>
<div class="sd-card-body docutils">
<p class="sd-card-text">Built on top of <a class="reference external" href="https://numpy.org">NumPy</a>, <a class="reference external" href="https://scipy.org">SciPy</a>,
<a class="reference external" href="https://numba.pydata.org/">Numba</a>, <a class="reference external" href="https://matplotlib.org">Matplotlib</a>,
<a class="reference external" href="https://dask.org">Dask</a> and <a class="reference external" href="https://scikit-learn.org">Scikit-learn</a> for
high performance and stability.</p>
</div>
</div>
</div>
<div class="sd-col sd-d-flex-row docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm docutils">
<div class="sd-card-header docutils">
<p class="sd-card-text"><svg version="1.1" width="2.0em" height="2.0em" class="sd-octicon sd-octicon-rocket sd-text-info" viewBox="0 0 24 24" aria-hidden="true"><path d="M20.322.75h1.176a1.75 1.75 0 0 1 1.75 1.749v1.177a10.75 10.75 0 0 1-2.925 7.374l-1.228 1.304a23.699 23.699 0 0 1-1.596 1.542v5.038c0 .615-.323 1.184-.85 1.5l-4.514 2.709a.75.75 0 0 1-1.12-.488l-.963-4.572a1.305 1.305 0 0 1-.14-.129L8.04 15.96l-1.994-1.873a1.305 1.305 0 0 1-.129-.14l-4.571-.963a.75.75 0 0 1-.49-1.12l2.71-4.514c.316-.527.885-.85 1.5-.85h5.037a23.668 23.668 0 0 1 1.542-1.594l1.304-1.23A10.753 10.753 0 0 1 20.321.75Zm-6.344 4.018v-.001l-1.304 1.23a22.275 22.275 0 0 0-3.255 3.851l-2.193 3.29 1.859 1.744a.545.545 0 0 1 .034.034l1.743 1.858 3.288-2.192a22.263 22.263 0 0 0 3.854-3.257l1.228-1.303a9.251 9.251 0 0 0 2.517-6.346V2.5a.25.25 0 0 0-.25-.25h-1.177a9.252 9.252 0 0 0-6.344 2.518ZM6.5 21c-1.209 1.209-3.901 1.445-4.743 1.49a.236.236 0 0 1-.18-.067.236.236 0 0 1-.067-.18c.045-.842.281-3.534 1.49-4.743.9-.9 2.6-.9 3.5 0 .9.9.9 2.6 0 3.5Zm-.592-8.588L8.17 9.017c.23-.346.47-.685.717-1.017H5.066a.25.25 0 0 0-.214.121l-2.167 3.612ZM16 15.112c-.333.248-.672.487-1.018.718l-3.393 2.262.678 3.223 3.612-2.167a.25.25 0 0 0 .121-.214ZM17.5 8a1.5 1.5 0 1 1-3.001-.001A1.5 1.5 0 0 1 17.5 8Z"></path></svg> Ecosystem</p>
</div>
<div class="sd-card-body docutils">
<p class="sd-card-text"><a class="reference internal" href="#ecosystem-label"><span class="std std-ref">Domain-specific libraries</span></a> and modular design for
<a class="reference external" href="https://hyperspy.org/hyperspy-doc/current/dev_guide/writing_extensions.html#writing-extensions-label" title="(in HyperSpy v2.2)"><span class="xref std std-ref">easy extensibility</span></a>.</p>
</div>
</div>
</div>
<div class="sd-col sd-d-flex-row docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm docutils">
<div class="sd-card-header docutils">
<p class="sd-card-text"><svg version="1.1" width="2.0em" height="2.0em" class="sd-octicon sd-octicon-people sd-text-info" viewBox="0 0 24 24" aria-hidden="true"><path d="M3.5 8a5.5 5.5 0 1 1 8.596 4.547 9.005 9.005 0 0 1 5.9 8.18.751.751 0 0 1-1.5.045 7.5 7.5 0 0 0-14.993 0 .75.75 0 0 1-1.499-.044 9.005 9.005 0 0 1 5.9-8.181A5.496 5.496 0 0 1 3.5 8ZM9 4a4 4 0 1 0 0 8 4 4 0 0 0 0-8Zm8.29 4c-.148 0-.292.01-.434.03a.75.75 0 1 1-.212-1.484 4.53 4.53 0 0 1 3.38 8.097 6.69 6.69 0 0 1 3.956 6.107.75.75 0 0 1-1.5 0 5.193 5.193 0 0 0-3.696-4.972l-.534-.16v-1.676l.41-.209A3.03 3.03 0 0 0 17.29 8Z"></path></svg> Community Driven</p>
</div>
<div class="sd-card-body docutils">
<p class="sd-card-text"><a class="reference external" href="https://hyperspy.org/hyperspy-doc/current/dev_guide/index.html#development" title="(in HyperSpy v2.2)"><span class="xref std std-ref">Developed and maintained</span></a> by scientists
for scientists.</p>
</div>
</div>
</div>
</div>
</div>
<p class="text-center sd-font-weight-bold sd-fs-3">Latest News</p>
<ul class="postlist-style-circle postlist simple">
<li class="ablog-post"><p class="ablog-post-title"><a class="reference internal" href="news/scipy2024_talk.html">HyperSpy talk at SciPy2024</a></p></li>
<li class="ablog-post"><p class="ablog-post-title"><a class="reference internal" href="news/eBEAM2024.html">HyperSpy lecture and tutorial @ eBEAM summer school, Sept. 1-13, 2024</a></p></li>
<li class="ablog-post"><p class="ablog-post-title"><a class="reference internal" href="news/EMC2024.html">HyperSpy Workshop @ EMC2024, 25th of August 2024</a></p></li>
</ul>
<p class="text-center sd-font-weight-bold sd-fs-3" id="ecosystem-label">HyperSpy Ecosystem</p>
<div class="pst-scrollable-table-container"><table class="table">
<colgroup>
<col style="width: 25.5%" />
<col style="width: 10.6%" />
<col style="width: 63.8%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><a class="reference external image-reference" href="https://hyperspy.org/hyperspy-doc/current"><img alt="HyperSpy logo" class="only-light" src="_images/hyperspy-banner-small-light.svg" style="height: 50px;" />
</a>
<a class="reference external image-reference" href="https://hyperspy.org/hyperspy-doc/current"><img alt="HyperSpy logo" class="only-dark" src="_images/hyperspy-banner-small-dark.svg" style="height: 50px;" />
</a>
</td>
<td><p><a class="reference external" href="https://hyperspy.org/hyperspy-doc/current">HyperSpy</a></p></td>
<td><p>Generic multi-dimensional data analysis toolbox</p></td>
</tr>
<tr class="row-even"><td><a class="reference external image-reference" href="https://hyperspy.org/rosettasciio/"><img alt="RosettaSciIO logo" class="only-light" src="_images/rosettasciio-banner-light.svg" style="height: 50px;" />
</a>
<a class="reference external image-reference" href="https://hyperspy.org/rosettasciio/"><img alt="RosettaSciIO logo" class="only-dark" src="_images/rosettasciio-banner-dark.svg" style="height: 50px;" />
</a>
</td>
<td><p><a class="reference external" href="https://hyperspy.org/rosettasciio/">RosettaSciIO</a></p></td>
<td><p>Reading and writing scientific data formats</p></td>
</tr>
<tr class="row-odd"><td><a class="reference external image-reference" href="https://hyperspy.org/exspy"><img alt="eXSpy logo" class="only-light" src="_images/exspy-banner-light.svg" style="height: 50px;" />
</a>
<a class="reference external image-reference" href="https://hyperspy.org/exspy"><img alt="eXSpy logo" class="only-dark" src="_images/exspy-banner-dark.svg" style="height: 50px;" />
</a>
</td>
<td><p><a class="reference external" href="https://hyperspy.org/exspy">eXSpy</a></p></td>
<td><p>X-rays Energy Dispersive Spectroscopy (EDS) and Electron Energy Loss Spectroscopy (EELS) data analysis</p></td>
</tr>
<tr class="row-even"><td><a class="reference external image-reference" href="https://pyxem.readthedocs.io"><img alt="pyxem logo" class="sd-bg-transparent" src="_images/pyxem-banner.svg" style="height: 50px;" />
</a>
</td>
<td><p><a class="reference external" href="https://pyxem.readthedocs.io">pyxem</a></p></td>
<td><p>4D-STEM (electron diffraction data) analysis</p></td>
</tr>
<tr class="row-odd"><td><a class="reference external image-reference" href="https://kikuchipy.org"><img alt="kikuchipy logo" class="only-light" src="_images/kikuchipy-banner-light.svg" style="height: 50px;" />
</a>
<a class="reference external image-reference" href="https://kikuchipy.org"><img alt="kikuchipy logo" class="only-dark" src="_images/kikuchipy-banner-dark.svg" style="height: 50px;" />
</a>
</td>
<td><p><a class="reference external" href="https://kikuchipy.org">kikuchipy</a></p></td>
<td><p>Electron backscatter diffraction (EBSD) data analysis</p></td>
</tr>
<tr class="row-even"><td><a class="reference external image-reference" href="https://lumispy.org"><img alt="lumiSpy logo" class="only-light" src="_images/lumispy-banner-light.svg" style="height: 50px;" />
</a>
<a class="reference external image-reference" href="https://lumispy.org"><img alt="lumiSpy logo" class="only-dark" src="_images/lumispy-banner-dark.svg" style="height: 50px;" />
</a>
</td>
<td><p><a class="reference external" href="https://lumispy.org">lumiSpy</a></p></td>
<td><p>Luminescence spectroscopy data analysis (cathodoluminescence, photoluminescence, Raman, …)</p></td>
</tr>
<tr class="row-odd"><td><a class="reference external image-reference" href="https://atomap.org"><img alt="Atomap logo" class="sd-bg-transparent" src="_images/atomap-banner.png" style="height: 50px;" />
</a>
</td>
<td><p><a class="reference external" href="https://atomap.org">Atomap</a></p></td>
<td><p>Analysis of atomic resolution scanning transmission electron microscopy images</p></td>
</tr>
<tr class="row-even"><td><a class="reference external image-reference" href="https://hyperspy.org/holospy"><img alt="holoSpy logo" class="only-light" src="_images/holospy-banner-light.svg" style="height: 50px;" />
</a>
<a class="reference external image-reference" href="https://hyperspy.org/holospy"><img alt="holoSpy logo" class="only-dark" src="_images/holospy-banner-dark.svg" style="height: 50px;" />
</a>
</td>
<td><p><a class="reference external" href="https://hyperspy.org/holospy">holoSpy</a></p></td>
<td><p>Off-axis electron holography data analysis</p></td>
</tr>
<tr class="row-odd"><td><a class="reference external image-reference" href="https://epsic-dls.github.io/particlespy"><img alt="ParticleSpy logo" class="only-light" src="_images/particlespy-banner-light.svg" style="height: 50px;" />
</a>
<a class="reference external image-reference" href="https://epsic-dls.github.io/particlespy"><img alt="ParticleSpy logo" class="only-dark" src="_images/particlespy-banner-dark.svg" style="height: 50px;" />
</a>
</td>
<td><p><a class="reference external" href="https://epsic-dls.github.io/particlespy">ParticleSpy</a></p></td>
<td><p>Segmentation and analysis of nanoparticles from electron microscopy data</p></td>
</tr>
<tr class="row-even"><td><a class="reference external image-reference" href="https://pages.nist.gov/etspy"><img alt="ETSpy logo" class="only-light" src="_images/etspy-banner-light.svg" style="height: 50px;" />
</a>
<a class="reference external image-reference" href="https://pages.nist.gov/etspy"><img alt="ETSpy logo" class="only-dark" src="_images/etspy-banner-dark.svg" style="height: 50px;" />
</a>
</td>
<td><p><a class="reference external" href="https://pages.nist.gov/etspy">ETSpy</a></p></td>
<td><p>Processing, alignment, and reconstruction of electron tomography data</p></td>
</tr>
<tr class="row-odd"><td><a class="reference external image-reference" href="https://hyperspy.org/hyperspyUI"><img alt="HyperSpyUI logo" class="only-light" src="_images/hyperspyui-banner-light.svg" style="height: 50px;" />
</a>
<a class="reference external image-reference" href="https://hyperspy.org/hyperspyUI"><img alt="HyperSpyUI logo" class="only-dark" src="_images/hyperspyui-banner-dark.svg" style="height: 50px;" />
</a>
</td>
<td><p><a class="reference external" href="https://hyperspy.org/hyperspyUI">HyperSpyUI</a></p></td>
<td><p>Streamlined user interface to HyperSpy</p></td>
</tr>
</tbody>
</table>
</div>
<p class="text-center sd-font-weight-bold sd-fs-3" id="support-label">Support</p>
<div class="sd-container-fluid sd-sphinx-override sd-mb-4 docutils">
<div class="sd-row sd-row-cols-2 sd-row-cols-xs-2 sd-row-cols-sm-2 sd-row-cols-md-4 sd-row-cols-lg-4 sd-g-4 sd-g-xs-4 sd-g-sm-4 sd-g-md-4 sd-g-lg-4 docutils">
<div class="sd-col sd-d-flex-row docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm docutils">
<div class="sd-card-header docutils">
<p class="sd-card-text">User Guides</p>
</div>
<div class="sd-card-body docutils">
<p class="sd-card-text">Comprehensive documentation on how to use <a class="reference external" href="https://hyperspy.org/hyperspy-doc/current">Hyperspy</a>
and the various extensions that form the <a class="reference internal" href="#ecosystem-label"><span class="std std-ref">Ecosystem</span></a>.</p>
</div>
</div>
</div>
<div class="sd-col sd-d-flex-row docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm docutils">
<div class="sd-card-header docutils">
<p class="sd-card-text">Tutorials</p>
</div>
<div class="sd-card-body docutils">
<p class="sd-card-text">Tutorials in the form of jupyter notebooks to demonstrate typical analysis
workflows are hosted in dedicated repositories for each library, see e.g.
<a class="reference external" href="https://github.com/hyperspy/hyperspy-demos">HyperSpy demos</a>.</p>
</div>
</div>
</div>
<div class="sd-col sd-d-flex-row docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm docutils">
<div class="sd-card-header docutils">
<p class="sd-card-text">Workshops</p>
</div>
<div class="sd-card-body docutils">
<p class="sd-card-text">Attend one of the HyperSpy workshops organised regularly. Past and future
events can be found under <a class="reference internal" href="news/index.html#news-label"><span class="std std-ref">News</span></a>.</p>
</div>
</div>
</div>
<div class="sd-col sd-d-flex-row docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm docutils">
<div class="sd-card-header docutils">
<p class="sd-card-text">Chat</p>
</div>
<div class="sd-card-body docutils">
<p class="sd-card-text">Ask the HyperSpy Community on the <a class="reference external" href="https://gitter.im/hyperspy/hyperspy">Gitter chat</a>.</p>
<p class="sd-card-text"><a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-primary sd-shadow-sm sd-rounded-3 reference external" href="https://gitter.im/hyperspy/hyperspy"><span><span class="fa fa-comments"></span> Chat on Gitter</span></a></p>
</div>
</div>
</div>
</div>
</div>
<p class="text-center sd-font-weight-bold sd-fs-3">Cite</p>
<div class="sd-container-fluid sd-sphinx-override sd-mb-4 docutils">
<div class="sd-row sd-row-cols-1 sd-row-cols-xs-1 sd-row-cols-sm-1 sd-row-cols-md-1 sd-row-cols-lg-1 docutils">
<div class="sd-col sd-d-flex-column sd-col-12 sd-col-xs-12 sd-col-sm-8 sd-col-md-8 sd-col-lg-8 docutils">
<p>If you use HyperSpy and its extensions, please cite it in your publications. Our
software is made by scientists who generously donate their time and attention.
Citations help us justify the effort that goes into building and maintaining
this project. Each of our libraries obtains DOIs from <a class="reference external" href="https://zenodo.org">zenodo</a> that can be found in the respective <a class="reference internal" href="#ecosystem-label"><span class="std std-ref">documentations</span></a>. DOIs for specific
versions of HyperSpy can be found by clicking on the <a class="reference external" href="https://support.zenodo.org/help/en-gb/1-upload-deposit/97-what-is-doi-versioning">Concept DOI</a> button.</p>
</div>
<div class="sd-col sd-d-flex-column sd-col-12 sd-col-xs-12 sd-col-sm-4 sd-col-md-4 sd-col-lg-4 sd-m-auto docutils">
<p class="sd-text-center"><a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-primary sd-shadow-sm sd-rounded-3 reference external" href="https://doi.org/10.5281/zenodo.592838"><span><span class="fa fa-bookmark"></span> HyperSpy DOI: 10.5281/zenodo.592838</span></a></p>
</div>
</div>
</div>
<div class="section ablog__blog_comments">
</div>
</article>
</div>
</div>
<footer class="bd-footer-content">
</footer>
</main>
</div>
</div>
<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script defer src="_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549"></script>
<script defer src="_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549"></script>
<footer class="bd-footer">
<div class="bd-footer__inner bd-page-width">
<div class="footer-items__start">
<div class="footer-item">
<p class="copyright">
© Copyright 2024, The HyperSpy community.
<br/>
</p>
</div>
<div class="footer-item">
<p class="sphinx-version">
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
<br/>
</p>
</div>
</div>
<div class="footer-items__end">
<div class="footer-item">
<p class="theme-version">
Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.16.0.
</p></div>
</div>
</div>
</footer>
</body>
</html>