-
Notifications
You must be signed in to change notification settings - Fork 29
/
index.rst
57 lines (41 loc) · 1.17 KB
/
index.rst
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
.. _api:
=============
API reference
=============
**Release**: |version|
**Date**: |today|
This reference manual describes the public functions, modules, and objects in kikuchipy.
Many of the descriptions include brief examples. For learning how to use kikuchipy, see
the :doc:`/examples/index` or :doc:`/tutorials/index`.
.. caution::
kikuchipy is in continuous development, meaning that some breaking changes and
changes to this reference are likely with each release.
kikuchipy's import structure is designed to feel familiar to HyperSpy users. It is
recommended to import functionality from the below list of functions and modules like
this:
.. autolink-skip::
.. code-block:: python
>>> import kikuchipy as kp
>>> s = kp.data.nickel_ebsd_small()
>>> s
<EBSD, title: patterns Scan 1, dimensions: (3, 3|60, 60)>
.. currentmodule:: kikuchipy
.. rubric:: Functions
.. autosummary::
:toctree: generated
load
set_log_level
.. rubric:: Modules
.. autosummary::
:toctree: generated
:template: custom-module-template.rst
data
detectors
draw
filters
imaging
indexing
io
pattern
signals
simulations